list_legal_holds ¶

list_legal_holds(
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    next_token: Optional[string] = None,
    max_results: Optional[MaxResults] = None,
) -> ListLegalHoldsOutput

This action returns metadata about active and previous legal holds.

Parameters:

next_token (Optional[string], default: None ) –

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
max_results (Optional[MaxResults], default: None ) –

The maximum number of resource list items to be returned.

Raises:

InvalidParameterValueException –

Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException –

The request failed due to a temporary failure of the server.
UnknownServiceError –

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

Source code in docs_src/capo_backup/_services/backup.py

def list_legal_holds(
    self,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    next_token: Optional["capo_backup.types.string.string"] = None,
    max_results: Optional["capo_backup.types.max_results.MaxResults"] = None,
) -> "capo_backup.types.list_legal_holds_output.ListLegalHoldsOutput":
    """<p>This action returns metadata about active and previous legal holds.</p>

    Args:
        next_token: <p>The next item following a partial list of returned resources. For example, if a request is made to return <code>MaxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
        max_results: <p>The maximum number of resource list items to be returned.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.list_legal_holds_input.ListLegalHoldsInput]",
    ) -> OperationResponse[
        "capo_backup.types.list_legal_holds_output.ListLegalHoldsOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_legal_holds

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.list_legal_holds.list_legal_holds(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLegalHolds")
    )
    input_: capo_backup.types.list_legal_holds_input.ListLegalHoldsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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