list_rules ¶

def list_rules(
    self,
    resource_type: "capo_rbin.types.resource_type.ResourceType",
    *,
    config_overrides: Optional[rbinClientConfig] = None,
    max_results: Optional["capo_rbin.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_rbin.types.next_token.NextToken"] = None,
    resource_tags: Optional["capo_rbin.types.resource_tags.ResourceTags"] = None,
    lock_state: Optional["capo_rbin.types.lock_state.LockState"] = None,
    exclude_resource_tags: Optional[
        "capo_rbin.types.exclude_resource_tags.ExcludeResourceTags"
    ] = None,
) -> "capo_rbin.types.list_rules_response.ListRulesResponse":
    """<p>Lists the Recycle Bin retention rules in the Region.</p>

    Args:
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</p>
        resource_type: <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p> <ul> <li> <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p> </li> <li> <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p> </li> <li> <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p> </li> </ul>
        resource_tags: <p>[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.</p>
        lock_state: <p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>
        exclude_resource_tags: <p>[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</p>

    Raises:
        capo_rbin.errors.internal_server_exception.InternalServerException: <p>The service could not respond to the request due to an internal problem.</p>
        capo_rbin.errors.validation_exception.ValidationException: <p>One or more of the parameters in the request is not valid.</p>
        capo_rbin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rbin.types.list_rules_request.ListRulesRequest]",
    ) -> OperationResponse["capo_rbin.types.list_rules_response.ListRulesResponse"]:
        import capo_rbin._operations.amazon_recycle_bin.list_rules

        output, http_response = (
            capo_rbin._operations.amazon_recycle_bin.list_rules.list_rules(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRules")
    )
    input_: capo_rbin.types.list_rules_request.ListRulesRequest = {
        "resource_type": resource_type
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if resource_tags is not None:
        input_["resource_tags"] = resource_tags
    if lock_state is not None:
        input_["lock_state"] = lock_state
    if exclude_resource_tags is not None:
        input_["exclude_resource_tags"] = exclude_resource_tags

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