list_recovery_points_by_backup_vault ¶

def list_recovery_points_by_backup_vault(
    self,
    backup_vault_name: "capo_backup.types.backup_vault_name.BackupVaultName",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    backup_vault_account_id: Optional[
        "capo_backup.types.account_id.AccountId"
    ] = None,
    next_token: Optional["capo_backup.types.string.string"] = None,
    max_results: Optional["capo_backup.types.max_results.MaxResults"] = None,
    by_resource_arn: Optional["capo_backup.types.arn.ARN"] = None,
    by_resource_type: Optional[
        "capo_backup.types.resource_type.ResourceType"
    ] = None,
    by_backup_plan_id: Optional["capo_backup.types.string.string"] = None,
    by_created_before: Optional["capo_backup.types.timestamp.timestamp"] = None,
    by_created_after: Optional["capo_backup.types.timestamp.timestamp"] = None,
    by_parent_recovery_point_arn: Optional["capo_backup.types.arn.ARN"] = None,
) -> "capo_backup.types.list_recovery_points_by_backup_vault_output.ListRecoveryPointsByBackupVaultOutput":
    """<p>Returns detailed information about the recovery points stored in a backup vault.</p>

    Args:
        backup_vault_name: <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p> <note> <p>Backup vault name might not be available when a supported service creates the backup.</p> </note>
        backup_vault_account_id: <p>This parameter will sort the list of recovery points by account ID.</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>
        by_resource_arn: <p>Returns only recovery points that match the specified resource Amazon Resource Name (ARN).</p>
        by_resource_type: <p>Returns only recovery points that match the specified resource type(s):</p> <ul> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>CloudFormation</code> for CloudFormation</p> </li> <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>EKS</code> for Amazon Elastic Kubernetes Service</p> </li> <li> <p> <code>FSx</code> for Amazon FSx</p> </li> <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Redshift</code> for Amazon Redshift</p> </li> <li> <p> <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p> </li> <li> <p> <code>SAP HANA on Amazon EC2</code> for SAP HANA databases on Amazon Elastic Compute Cloud instances</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> <li> <p> <code>Timestream</code> for Amazon Timestream</p> </li> <li> <p> <code>VirtualMachine</code> for VMware virtual machines</p> </li> </ul>
        by_backup_plan_id: <p>Returns only recovery points that match the specified backup plan ID.</p>
        by_created_before: <p>Returns only recovery points that were created before the specified timestamp.</p>
        by_created_after: <p>Returns only recovery points that were created after the specified timestamp.</p>
        by_parent_recovery_point_arn: <p>This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).</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_recovery_points_by_backup_vault_input.ListRecoveryPointsByBackupVaultInput]",
    ) -> OperationResponse[
        "capo_backup.types.list_recovery_points_by_backup_vault_output.ListRecoveryPointsByBackupVaultOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_recovery_points_by_backup_vault

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecoveryPointsByBackupVault")
    )
    input_: capo_backup.types.list_recovery_points_by_backup_vault_input.ListRecoveryPointsByBackupVaultInput = {
        "backup_vault_name": backup_vault_name
    }
    if backup_vault_account_id is not None:
        input_["backup_vault_account_id"] = backup_vault_account_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if by_resource_arn is not None:
        input_["by_resource_arn"] = by_resource_arn
    if by_resource_type is not None:
        input_["by_resource_type"] = by_resource_type
    if by_backup_plan_id is not None:
        input_["by_backup_plan_id"] = by_backup_plan_id
    if by_created_before is not None:
        input_["by_created_before"] = by_created_before
    if by_created_after is not None:
        input_["by_created_after"] = by_created_after
    if by_parent_recovery_point_arn is not None:
        input_["by_parent_recovery_point_arn"] = by_parent_recovery_point_arn

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