Skip to content

BatchIsAuthorizedInput

Source code in docs_src/capo_verifiedpermissions/types/batch_is_authorized_input.py
class BatchIsAuthorizedInput(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 the authorization decisions 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>"""
    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>"""
    requests: "capo_verifiedpermissions.types.batch_is_authorized_input_list.BatchIsAuthorizedInputList"
    """<p>An array of up to 30 requests that you want Verified Permissions to evaluate.</p>"""

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 the authorization decisions 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.

requests instance-attribute

An array of up to 30 requests that you want Verified Permissions to evaluate.