BatchGetPolicy
Retrieves information about a group (batch) of policies.
Note
The BatchGetPolicy
operation doesn't have its own IAM
permission. To authorize this operation for AWS principals, include the permission
verifiedpermissions:GetPolicy
in their IAM policies.
Request Syntax
{
"requests": [
{
"policyId": "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.
- requests
-
An array of up to 100 policies you want information about.
Type: Array of BatchGetPolicyInputItem objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
Response Syntax
{
"errors": [
{
"code": "string",
"message": "string",
"policyId": "string",
"policyStoreId": "string"
}
],
"results": [
{
"createdDate": "string",
"definition": { ... },
"lastUpdatedDate": "string",
"policyId": "string",
"policyStoreId": "string",
"policyType": "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.
- errors
-
Information about the policies from the request that resulted in an error. These results are returned in the order they were requested.
Type: Array of BatchGetPolicyErrorItem objects
- results
-
Information about the policies listed in the request that were successfully returned. These results are returned in the order they were requested.
Type: Array of BatchGetPolicyOutputItem objects
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
- InternalServerException
-
The request failed because of an internal error. Try your request again later
HTTP Status Code: 500
- ThrottlingException
-
The request failed because it exceeded a throttling 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...else
clause 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.
HTTP Status Code: 400
-
Examples
Example
The following example retrieves information about the specified policies contained in the specified policy stores. .
Sample Request
POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.BatchGetPolicy
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
{
"requests": [
{
"policyId": "SPEXAMPLEabcdefg111111",
"policyStoreId": "PSEXAMPLEabcdefg111111"
},
{
"policyId": "SPEXAMPLEabcdefg222222",
"policyStoreId": "PSEXAMPLEabcdefg111111"
},
{
"policyId": "SPEXAMPLEabcdefg333333",
"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
{
"results": [
{
"policyStoreId": "PSEXAMPLEabcdefg111111",
"policyId": "SPEXAMPLEabcdefg111111",
"policyType": "STATIC",
"definition": {
"static": {
"description": "Users can manage account resources in any account they own.",
"statement": "permit (principal, action in PhotoFlash::Action::\"ManageAccount\",resource) when { resource in principal.Account };"
}
},
"createdDate": "2024-10-18T18:53:39.258153Z",
"lastUpdatedDate": "2024-10-18T18:53:39.258153Z"
},
{
"policyStoreId": "PSEXAMPLEabcdefg111111",
"policyId": "SPEXAMPLEabcdefg222222",
"policyType": "STATIC",
"definition": {
"static": {
"description": "User alice can't delete any photos.",
"statement": "forbid (principal == PhotoFlash::User::\"alice\", action in [PhotoFlash::Action::\"DeletePhoto\"], resource);"
}
},
"createdDate": "2024-10-18T18:57:03.305027Z",
"lastUpdatedDate": "2024-10-18T18:57:03.305027Z"
},
{
"policyStoreId": "PSEXAMPLEabcdefg111111",
"policyId": "SPEXAMPLEabcdefg333333",
"policyType": "STATIC",
"definition": {
"static": {
"description": "User alice can view and delete photos.",
"statement": "permit (principal == PhotoFlash::User::\"alice\", action in [PhotoFlash::Action::\"DeletePhoto\", PhotoFlash::Action::\"ViewPhoto\"], resource);"
}
},
"createdDate": "2024-10-18T18:57:48.005343Z",
"lastUpdatedDate": "2024-10-18T18:57:48.005343Z"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: