CreatePolicyStoreAlias
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
Request Syntax
{
"aliasName": "string",
"policyStoreId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- aliasName
-
Specifies the name of the policy store alias to create. The name must be unique within your AWS account and AWS Region.
Note
The alias name must always be prefixed with
policy-store-alias/.Type: String
Length Constraints: Minimum length of 0. Maximum length of 150.
Pattern:
[a-zA-Z0-9-/_]*Required: Yes
- policyStoreId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-/_]*Required: Yes
Response Syntax
{
"aliasArn": "string",
"aliasName": "string",
"createdAt": "string",
"policyStoreId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- aliasArn
-
The Amazon Resource Name (ARN) of the policy store alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2500.
Pattern:
arn:[^:]*:[^:]*:[^:]*:[^:]*:.* - aliasName
-
The name of the policy store alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 150.
Pattern:
[a-zA-Z0-9-/_]* - createdAt
-
The date and time the policy store alias was created.
Type: Timestamp
- policyStoreId
-
The ID of the policy store associated with the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-/_]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 400
- ConflictException
-
The request failed because another request to modify a resource occurred at the same time.
- resources
-
The list of resources referenced with this failed request.
HTTP Status Code: 400
- InternalServerException
-
The request failed because of an internal error. Try your request again later
HTTP Status Code: 500
- ResourceNotFoundException
-
The request failed because it references a resource that doesn't exist.
- resourceId
-
The unique ID of the resource referenced in the failed request.
- resourceType
-
The resource type of the resource referenced in the failed request.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The request failed because it would cause a service quota to be exceeded.
- quotaCode
-
The quota code recognized by the AWS Service Quotas service.
- resourceId
-
The unique ID of the resource referenced in the failed request.
- resourceType
-
The resource type of the resource referenced in the failed request.
- serviceCode
-
The code for the AWS service that owns the quota.
HTTP Status Code: 400
- ThrottlingException
-
The request failed because it exceeded a throttling quota.
- quotaCode
-
The quota code recognized by the AWS Service Quotas service.
- serviceCode
-
The code for the AWS service that owns the quota.
HTTP Status Code: 400
- ValidationException
-
The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.
The possible reasons include the following:
-
UnrecognizedEntityType
The policy includes an entity type that isn't found in the schema.
-
UnrecognizedActionId
The policy includes an action id that isn't found in the schema.
-
InvalidActionApplication
The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
-
UnexpectedType
The policy included an operand that isn't a valid type for the specified operation.
-
IncompatibleTypes
The types of elements included in a
set, or the types of expressions used in anif...then...elseclause aren't compatible in this context. -
MissingAttribute
The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator
in the Cedar Policy Language Guide. -
UnsafeOptionalAttributeAccess
The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator
in the Cedar Policy Language Guide. -
ImpossiblePolicy
Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.
-
WrongNumberArguments
The policy references an extension type with the wrong number of arguments.
-
FunctionArgumentValidationError
Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.
- fieldList
-
The list of fields that aren't valid.
HTTP Status Code: 400
-
Examples
Example
The following example creates a new policy store alias with the name
example-policy-store.
Sample Request
POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.CreatePolicyStoreAlias
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"aliasName": "policy-store-alias/example-policy-store",
"policyStoreId": "PSEXAMPLEabcdefg111111"
}Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
vary: origin
vary: access-control-request-method
vary: access-control-request-headers
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"aliasName": "policy-store-alias/example-policy-store",
"policyStoreId": "PSEXAMPLEabcdefg111111",
"aliasArn": "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store",
"createdAt": "2024-01-15T12:30:00.000000+00:00"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
