Skip to content

GetPolicyOutput

Source code in docs_src/capo_verifiedpermissions/types/get_policy_output.py
class GetPolicyOutput(TypedDict, closed=True):
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId"
    """<p>The ID of the policy store that contains the policy that you want information about.</p>"""
    policy_id: "capo_verifiedpermissions.types.policy_id.PolicyId"
    """<p>The unique ID of the policy that you want information about.</p>"""
    policy_type: "capo_verifiedpermissions.types.policy_type.PolicyType"
    """<p>The type of the policy.</p>"""
    principal: NotRequired[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ]
    """<p>The principal specified in the policy's scope. This element isn't included in the response when <code>Principal</code> isn't present in the policy content.</p>"""
    resource: NotRequired[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ]
    """<p>The resource specified in the policy's scope. This element isn't included in the response when <code>Resource</code> isn't present in the policy content.</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_detail.PolicyDefinitionDetail"
    )
    """<p>The definition of the requested policy.</p>"""
    created_date: "capo_verifiedpermissions.types.timestamp_format.TimestampFormat"
    """<p>The date and time that the policy was originally created.</p>"""
    last_updated_date: "capo_verifiedpermissions.types.timestamp_format.TimestampFormat"
    """<p>The date and time that the policy was last 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 that the policy was originally created.

definition instance-attribute

The definition of the requested policy.

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 that the policy was last 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 unique ID of the policy that you want information about.

policy_store_id instance-attribute

policy_store_id: PolicyStoreId

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

policy_type instance-attribute

policy_type: PolicyType

The type of the policy.

principal instance-attribute

principal: NotRequired[EntityIdentifier]

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.

resource instance-attribute

resource: NotRequired[EntityIdentifier]

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.