batch_is_authorized ¶

def batch_is_authorized(
    self,
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId",
    requests: "capo_verifiedpermissions.types.batch_is_authorized_input_list.BatchIsAuthorizedInputList",
    *,
    config_overrides: Optional[VerifiedPermissionsClientConfig] = None,
    entities: Optional[
        "capo_verifiedpermissions.types.entities_definition.EntitiesDefinition"
    ] = None,
) -> "capo_verifiedpermissions.types.batch_is_authorized_output.BatchIsAuthorizedOutput":
    """<p>Makes a series of decisions about multiple authorization requests for one principal or resource. Each request contains the equivalent content of an <code>IsAuthorized</code> request: principal, action, resource, and context. Either the <code>principal</code> or the <code>resource</code> parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests where <code>bob</code> views <code>photo1</code> and <code>alice</code> views <code>photo2</code>. Authorization of <code>bob</code> to view <code>photo1</code> and <code>photo2</code>, or <code>bob</code> and <code>alice</code> to view <code>photo1</code>, are valid batches. </p> <p>The request is evaluated against all policies in the specified policy store that match the entities that you declare. The result of the decisions is a series of <code>Allow</code> or <code>Deny</code> responses, along with the IDs of the policies that produced each decision.</p> <p>The <code>entities</code> of a <code>BatchIsAuthorized</code> API request can contain up to 100 principals and up to 100 resources. The <code>requests</code> of a <code>BatchIsAuthorized</code> API request can contain up to 30 requests.</p> <note> <p>The <code>BatchIsAuthorized</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>verifiedpermissions:IsAuthorized</code> in their IAM policies.</p> </note>

    Args:
        policy_store_id: <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: <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: <p>An array of up to 30 requests that you want Verified Permissions to evaluate.</p>

    Raises:
        capo_verifiedpermissions.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_verifiedpermissions.errors.internal_server_exception.InternalServerException: <p>The request failed because of an internal error. Try your request again later</p>
        capo_verifiedpermissions.errors.throttling_exception.ThrottlingException: <p>The request failed because it exceeded a throttling quota.</p>
        capo_verifiedpermissions.errors.validation_exception.ValidationException: <p>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.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>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 <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>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 <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>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.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>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.</p> </li> </ul>
        capo_verifiedpermissions.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request failed because it references a resource that doesn't exist.</p>
        capo_verifiedpermissions.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Batch - Example 1
        The following example requests two authorization decisions for two principals                     of type Usernamed Alice and Annalisa.

        >>> client.batch_is_authorized(requests=[{'principal': {'entityType': 'PhotoFlash::User', 'entityId': 'Alice'}, 'action': {'actionType': 'PhotoFlash::Action', 'actionId': 'ViewPhoto'}, 'resource': {'entityType': 'PhotoFlash::Photo', 'entityId': 'VacationPhoto94.jpg'}}, {'principal': {'entityType': 'PhotoFlash::User', 'entityId': 'Annalisa'}, 'action': {'actionType': 'PhotoFlash::Action', 'actionId': 'DeletePhoto'}, 'resource': {'entityType': 'PhotoFlash::Photo', 'entityId': 'VacationPhoto94.jpg'}}], entities={'entityList': [{'identifier': {'entityType': 'PhotoFlash::User', 'entityId': 'Alice'}, 'attributes': {'Account': {'entityIdentifier': {'entityType': 'PhotoFlash::Account', 'entityId': '1234'}}, 'Email': {'string': ''}}, 'parents': []}, {'identifier': {'entityType': 'PhotoFlash::User', 'entityId': 'Annalisa'}, 'attributes': {'Account': {'entityIdentifier': {'entityType': 'PhotoFlash::Account', 'entityId': '5678'}}, 'Email': {'string': ''}}, 'parents': []}, {'identifier': {'entityType': 'PhotoFlash::Photo', 'entityId': 'VacationPhoto94.jpg'}, 'attributes': {'IsPrivate': {'boolean': False}, 'Name': {'string': ''}}, 'parents': [{'entityType': 'PhotoFlash::Account', 'entityId': '1234'}]}, {'identifier': {'entityType': 'PhotoFlash::Account', 'entityId': '1234'}, 'attributes': {'Name': {'string': ''}}, 'parents': []}]}, policy_store_id='C7v5xMplfFH3i3e4Jrzb1a')
    """

    def _handler(
        req: "OperationRequest[capo_verifiedpermissions.types.batch_is_authorized_input.BatchIsAuthorizedInput]",
    ) -> OperationResponse[
        "capo_verifiedpermissions.types.batch_is_authorized_output.BatchIsAuthorizedOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.batch_is_authorized

        output, http_response = (
            capo_verifiedpermissions._operations.verified_permissions.batch_is_authorized.batch_is_authorized(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_verifiedpermissions.types.batch_is_authorized_input.BatchIsAuthorizedInput",
    ) -> dict[str, Any]:
        import capo_verifiedpermissions.types.batch_is_authorized_input

        return capo_verifiedpermissions.types.batch_is_authorized_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_verifiedpermissions.types.batch_is_authorized_output.BatchIsAuthorizedOutput",
    ) -> dict[str, Any]:
        import capo_verifiedpermissions.types.batch_is_authorized_output

        return capo_verifiedpermissions.types.batch_is_authorized_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "BatchIsAuthorized",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_verifiedpermissions.types.batch_is_authorized_input.BatchIsAuthorizedInput = {
        "policy_store_id": policy_store_id,
        "requests": requests,
    }
    if entities is not None:
        input_["entities"] = entities

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output