Skip to content

list_restore_access_backup_vaults

list_restore_access_backup_vaults(
    backup_vault_name: BackupVaultName,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    next_token: Optional[string] = None,
    max_results: Optional[MaxResults] = None,
) -> ListRestoreAccessBackupVaultsOutput

Returns a list of restore access backup vaults associated with a specified backup vault.

Parameters:

  • backup_vault_name (BackupVaultName) –

    The name of the backup vault for which to list associated restore access backup vaults.

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

    The pagination token from a previous request to retrieve the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of items to return in the response.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def list_restore_access_backup_vaults(
    self,
    backup_vault_name: "capo_backup.types.backup_vault_name.BackupVaultName",
    *,
    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_restore_access_backup_vaults_output.ListRestoreAccessBackupVaultsOutput":
    """<p>Returns a list of restore access backup vaults associated with a specified backup vault.</p>

    Args:
        backup_vault_name: <p>The name of the backup vault for which to list associated restore access backup vaults.</p>
        next_token: <p>The pagination token from a previous request to retrieve the next set of results.</p>
        max_results: <p>The maximum number of items to return in the response.</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_restore_access_backup_vaults_input.ListRestoreAccessBackupVaultsInput]",
    ) -> OperationResponse[
        "capo_backup.types.list_restore_access_backup_vaults_output.ListRestoreAccessBackupVaultsOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_restore_access_backup_vaults

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRestoreAccessBackupVaults")
    )
    input_: capo_backup.types.list_restore_access_backup_vaults_input.ListRestoreAccessBackupVaultsInput = {
        "backup_vault_name": backup_vault_name
    }
    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