Skip to content

IsAuthorizedInput

Source code in docs_src/capo_verifiedpermissions/types/is_authorized_input.py
class IsAuthorizedInput(TypedDict, closed=True):
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId"
    """<p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>"""
    principal: NotRequired[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ]
    """<p>Specifies the principal for which the authorization decision is to be made.</p>"""
    action: NotRequired[
        "capo_verifiedpermissions.types.action_identifier.ActionIdentifier"
    ]
    """<p>Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?</p>"""
    resource: NotRequired[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ]
    """<p>Specifies the resource for which the authorization decision is to be made.</p>"""
    context: NotRequired[
        "capo_verifiedpermissions.types.context_definition.ContextDefinition"
    ]
    """<p>Specifies additional context that can be used to make more granular authorization decisions.</p>"""
    entities: NotRequired[
        "capo_verifiedpermissions.types.entities_definition.EntitiesDefinition"
    ]
    """<p>(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.</p> <note> <p>You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.</p> </note>"""

action instance-attribute

action: NotRequired[ActionIdentifier]

Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

context instance-attribute

context: NotRequired[ContextDefinition]

Specifies additional context that can be used to make more granular authorization decisions.

entities instance-attribute

entities: NotRequired[EntitiesDefinition]

(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.

policy_store_id instance-attribute

policy_store_id: PolicyStoreId

Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

  • ID: PSEXAMPLEabcdefg111111

  • Alias name: policy-store-alias/example-policy-store

To view aliases, use ListPolicyStoreAliases.

principal instance-attribute

principal: NotRequired[EntityIdentifier]

Specifies the principal for which the authorization decision is to be made.

resource instance-attribute

resource: NotRequired[EntityIdentifier]

Specifies the resource for which the authorization decision is to be made.