Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetPolicy

Retrieves information about the specified policy.

Request Syntax


{
   "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.

policyId

Specifies the ID of the policy you want information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9-]*

Required: Yes

policyStoreId

Specifies the ID of the policy store that contains the policy that you want information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9-]*

Required: Yes

Response Syntax


{
   "actions": [ 
      { 
         "actionId": "string",
         "actionType": "string"
      }
   ],
   "createdDate": "string",
   "definition": { ... },
   "effect": "string",
   "lastUpdatedDate": "string",
   "policyId": "string",
   "policyStoreId": "string",
   "policyType": "string",
   "principal": { 
      "entityId": "string",
      "entityType": "string"
   },
   "resource": { 
      "entityId": "string",
      "entityType": "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.

createdDate

The date and time that the policy was originally created.

Type: Timestamp

definition

The definition of the requested policy.

Type: PolicyDefinitionDetail object

Note: This object is a Union. Only one member of this object can be specified or returned.

lastUpdatedDate

The date and time that the policy was last updated.

Type: Timestamp

policyId

The unique ID of the policy that you want information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9-]*

policyStoreId

The ID of the policy store that contains the policy that you want information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9-]*

policyType

The type of the policy.

Type: String

Valid Values: STATIC | TEMPLATE_LINKED

actions

The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

Type: Array of ActionIdentifier objects

effect

The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

Type: String

Valid Values: Permit | Forbid

principal

The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

Type: EntityIdentifier object

resource

The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

Type: EntityIdentifier object

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

ResourceNotFoundException

The request failed because it references a resource that doesn't exist.

HTTP Status Code: 400

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 an if...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 policy contained in the specified policy store. In this example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific principal and resource used by this policy.

Sample Request


POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.GetPolicy
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>

{
   "policyId": "SPEXAMPLEabcdefg111111",
   "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

{
    "actions": [
        {
            "actionId": "SharePhoto",
            "actionType": "PhotoFlash::Action"
        }
    ],
    "createdDate":"2023-05-16T20:33:01.730817Z",
    "definition": {
        "static": {
            "description": "Grant everyone of janeFriends UserGroup permission to share photos in the vacationFolder Album",
            "statement": "permit(principal in PhotoFlash::UserGroup::\"janeFriends\", action in PhotoFlash::Action::\"SharePhoto\", resource in PhotoFlash::Album::\"vacationFolder\");"
        }
    },
    "effect": "Permit",
    "lastUpdatedDate":"2023-05-16T20:33:01.730817Z",
    "policyId":"SPEXAMPLEabcdefg111111",
    "policyStoreId":"PSEXAMPLEabcdefg111111",
    "policyType":"STATIC",
    "principal": {
        "entityId": "PhotoFlash::UserGroup",
        "entityType": "janeFriends"
    },
    "resource": {
        "entityId": "vacationFolder",
        "entityType": "PhotoFlash::Album"
    }
}