list_security_policies `async` ¶

list_security_policies(
    type: SecurityPolicyType,
    *,
    config_overrides: Optional[AsyncOpenSearchServerlessClientConfig] = None,
    resource: Optional[ResourceFilter] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListSecurityPoliciesResponse

Returns information about configured OpenSearch Serverless security policies.

Parameters:

type (SecurityPolicyType) –

The type of policy.
resource (Optional[ResourceFilter], default: None ) –

Resource filters (can be collection or indexes) that policies can apply to.
next_token (Optional[str], default: None ) –

If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.
max_results (Optional[int], default: None ) –

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

Raises:

InternalServerException –

Thrown when an error internal to the service occurs while processing a request.
ValidationException –

Thrown when the HTTP request contains invalid input or is missing required input.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_opensearchserverless/_services/async_open_search_serverless.py

async def list_security_policies(
    self,
    type: "capo_opensearchserverless.types.security_policy_type.SecurityPolicyType",
    *,
    config_overrides: Optional[AsyncOpenSearchServerlessClientConfig] = None,
    resource: Optional[
        "capo_opensearchserverless.types.resource_filter.ResourceFilter"
    ] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_opensearchserverless.types.list_security_policies_response.ListSecurityPoliciesResponse":
    """<p>Returns information about configured OpenSearch Serverless security policies.</p>

    Args:
        type: <p>The type of policy.</p>
        resource: <p>Resource filters (can be collection or indexes) that policies can apply to. </p>
        next_token: <p>If your initial <code>ListSecurityPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityPolicies</code> operations, which returns results in the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>

    Raises:
        capo_opensearchserverless.errors.internal_server_exception.InternalServerException: <p>Thrown when an error internal to the service occurs while processing a request.</p>
        capo_opensearchserverless.errors.validation_exception.ValidationException: <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
        capo_opensearchserverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearchserverless.types.list_security_policies_request.ListSecurityPoliciesRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearchserverless.types.list_security_policies_response.ListSecurityPoliciesResponse"
    ]:
        import capo_opensearchserverless._operations.open_search_serverless.list_security_policies

        (
            output,
            http_response,
        ) = await capo_opensearchserverless._operations.open_search_serverless.list_security_policies.async_list_security_policies(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSecurityPolicies")
    )
    input_: capo_opensearchserverless.types.list_security_policies_request.ListSecurityPoliciesRequest = {
        "type": type
    }
    if resource is not None:
        input_["resource"] = resource
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_security_policies async ¶

list_security_policies `async` ¶