batch_get_policy async ¶

async def batch_get_policy(
    self,
    requests: "capo_verifiedpermissions.types.batch_get_policy_input_list.BatchGetPolicyInputList",
    *,
    config_overrides: Optional[AsyncVerifiedPermissionsClientConfig] = None,
) -> "capo_verifiedpermissions.types.batch_get_policy_output.BatchGetPolicyOutput":
    """<p>Retrieves information about a group (batch) of policies.</p> <note> <p>The <code>BatchGetPolicy</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>verifiedpermissions:GetPolicy</code> in their IAM policies.</p> </note>

    Args:
        requests: <p>An array of up to 100 policies you want information about.</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.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To retrieve details about a policy
        The following example retrieves information about the specified policy contained in the specified policy store. In this example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific principal and resource used by this policy.

        >>> await client.batch_get_policy(requests=[{'policyId': 'PWv5M6d5HePx3gVVLKY1nK', 'policyStoreId': 'ERZeDpRc34dkYZeb6FZRVC'}, {'policyId': 'LzFn6KgLWvv4Mbegus35jn', 'policyStoreId': 'ERZeDpRc34dkYZeb6FZRVC'}, {'policyId': '77gLjer8H5o3mvrnMGrSL5', 'policyStoreId': 'ERZeDpRc34dkYZeb6FZRVC'}])
        To retrieve policies by name
        The following example retrieves information about policies using their names instead of their IDs.

        >>> await client.batch_get_policy(requests=[{'policyId': 'name/example-policy', 'policyStoreId': 'ERZeDpRc34dkYZeb6FZRVC'}, {'policyId': 'name/example-policy-2', 'policyStoreId': 'ERZeDpRc34dkYZeb6FZRVC'}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_verifiedpermissions.types.batch_get_policy_input.BatchGetPolicyInput]",
    ) -> AsyncOperationResponse[
        "capo_verifiedpermissions.types.batch_get_policy_output.BatchGetPolicyOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.batch_get_policy

        (
            output,
            http_response,
        ) = await capo_verifiedpermissions._operations.verified_permissions.batch_get_policy.async_batch_get_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

        return (
            capo_verifiedpermissions.types.batch_get_policy_output.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("BatchGetPolicy", redact_output=_redact_output),
    )
    input_: capo_verifiedpermissions.types.batch_get_policy_input.BatchGetPolicyInput = {
        "requests": requests
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output