Skip to content

PolicyItem

Source code in docs_src/capo_verifiedpermissions/types/policy_item.py
class PolicyItem(TypedDict, closed=True):
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId"
    """<p>The identifier of the policy store where the policy you want information about is stored.</p>"""
    policy_id: "capo_verifiedpermissions.types.policy_id.PolicyId"
    """<p>The identifier of the policy you want information about.</p>"""
    policy_type: "capo_verifiedpermissions.types.policy_type.PolicyType"
    """<p>The type of the policy. This is one of the following values:</p> <ul> <li> <p> <code>STATIC</code> </p> </li> <li> <p> <code>TEMPLATE_LINKED</code> </p> </li> </ul>"""
    principal: NotRequired[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ]
    """<p>The principal associated with the policy.</p>"""
    resource: NotRequired[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ]
    """<p>The resource associated with the policy.</p>"""
    actions: NotRequired[
        "capo_verifiedpermissions.types.action_identifier_list.ActionIdentifierList"
    ]
    """<p>The action that a policy permits or forbids. For example, <code>{"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}</code>.</p>"""
    definition: (
        "capo_verifiedpermissions.types.policy_definition_item.PolicyDefinitionItem"
    )
    """<p>The policy definition of an item in the list of policies returned.</p>"""
    created_date: "capo_verifiedpermissions.types.timestamp_format.TimestampFormat"
    """<p>The date and time the policy was created.</p>"""
    last_updated_date: "capo_verifiedpermissions.types.timestamp_format.TimestampFormat"
    """<p>The date and time the policy was most recently updated.</p>"""
    effect: NotRequired["capo_verifiedpermissions.types.policy_effect.PolicyEffect"]
    """<p>The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.</p>"""
    name: NotRequired["capo_verifiedpermissions.types.policy_name.PolicyName"]
    """<p>The name of the policy, if one was assigned when the policy was created or last updated.</p>"""

actions instance-attribute

actions: NotRequired[ActionIdentifierList]

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

created_date instance-attribute

created_date: TimestampFormat

The date and time the policy was created.

definition instance-attribute

The policy definition of an item in the list of policies returned.

effect instance-attribute

effect: NotRequired[PolicyEffect]

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

last_updated_date instance-attribute

last_updated_date: TimestampFormat

The date and time the policy was most recently updated.

name instance-attribute

name: NotRequired[PolicyName]

The name of the policy, if one was assigned when the policy was created or last updated.

policy_id instance-attribute

policy_id: PolicyId

The identifier of the policy you want information about.

policy_store_id instance-attribute

policy_store_id: PolicyStoreId

The identifier of the policy store where the policy you want information about is stored.

policy_type instance-attribute

policy_type: PolicyType

The type of the policy. This is one of the following values:

  • STATIC

  • TEMPLATE_LINKED

principal instance-attribute

principal: NotRequired[EntityIdentifier]

The principal associated with the policy.

resource instance-attribute

resource: NotRequired[EntityIdentifier]

The resource associated with the policy.