list_backup_vaults ¶

def list_backup_vaults(
    self,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    by_vault_type: Optional["capo_backup.types.vault_type.VaultType"] = None,
    by_shared: Optional["capo_backup.types.boolean2.Boolean2"] = None,
    next_token: Optional["capo_backup.types.string.string"] = None,
    max_results: Optional["capo_backup.types.max_results.MaxResults"] = None,
) -> "capo_backup.types.list_backup_vaults_output.ListBackupVaultsOutput":
    """<p>Returns a list of recovery point storage containers along with information about them.</p>

    Args:
        by_vault_type: <p>This parameter will sort the list of vaults by vault type.</p>
        by_shared: <p>This parameter will sort the list of vaults by shared vaults.</p>
        next_token: <p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <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 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.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</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_backup_vaults_input.ListBackupVaultsInput]",
    ) -> OperationResponse[
        "capo_backup.types.list_backup_vaults_output.ListBackupVaultsOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_backup_vaults

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBackupVaults")
    )
    input_: capo_backup.types.list_backup_vaults_input.ListBackupVaultsInput = {}
    if by_vault_type is not None:
        input_["by_vault_type"] = by_vault_type
    if by_shared is not None:
        input_["by_shared"] = by_shared
    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