list_policies async ¶

async def list_policies(
    self,
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId",
    *,
    config_overrides: Optional[AsyncVerifiedPermissionsClientConfig] = None,
    next_token: Optional[
        "capo_verifiedpermissions.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_verifiedpermissions.types.max_results.MaxResults"
    ] = None,
    filter: Optional[
        "capo_verifiedpermissions.types.policy_filter.PolicyFilter"
    ] = None,
) -> "capo_verifiedpermissions.types.list_policies_output.ListPoliciesOutput":
    """<p>Returns a paginated list of all policies stored in the specified policy store.</p>

    Args:
        policy_store_id: <p>Specifies the ID of the policy store you want to list policies from.</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>
        next_token: <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
        max_results: <p>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> <p>If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.</p>
        filter: <p>Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.</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:
        ListPolicies - Example 1
        The following example lists all policies in the policy store.

        >>> await client.list_policies(policy_store_id='C7v5xMplfFH3i3e4Jrzb1a')
        ListPolicies - Example 2
        The following example lists all policies for a specified principal.

        >>> await client.list_policies(policy_store_id='C7v5xMplfFH3i3e4Jrzb1a', filter={'principal': {'identifier': {'entityType': 'User', 'entityId': 'alice'}}})
        ListPolicies - Example 3
        The following example uses the Filter parameter to list only the template-linked policies in the specified policy store.

        >>> await client.list_policies(policy_store_id='C7v5xMplfFH3i3e4Jrzb1a', filter={'policyType': 'TEMPLATE_LINKED'})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_verifiedpermissions.types.list_policies_input.ListPoliciesInput]",
    ) -> AsyncOperationResponse[
        "capo_verifiedpermissions.types.list_policies_output.ListPoliciesOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.list_policies

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

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

        return capo_verifiedpermissions.types.list_policies_input.redact_sensitive(
            input_
        )

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

        return capo_verifiedpermissions.types.list_policies_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListPolicies", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_verifiedpermissions.types.list_policies_input.ListPoliciesInput = {
        "policy_store_id": policy_store_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter

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