:doc:`Backup <../../backup>` / Paginator / ListRecoveryPointsByLegalHold

*****************************
ListRecoveryPointsByLegalHold
*****************************



.. py:class:: Backup.Paginator.ListRecoveryPointsByLegalHold

  ::

    
    paginator = client.get_paginator('list_recovery_points_by_legal_hold')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Backup.Client.list_recovery_points_by_legal_hold`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHold>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          LegalHoldId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type LegalHoldId: string
    :param LegalHoldId: **[REQUIRED]** 

      The ID of the legal hold.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'RecoveryPoints': [
                {
                    'RecoveryPointArn': 'string',
                    'ResourceArn': 'string',
                    'ResourceType': 'string',
                    'BackupVaultName': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **RecoveryPoints** *(list) --* 

          The recovery points.

          
          

          - *(dict) --* 

            This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

            
            

            - **RecoveryPointArn** *(string) --* 

              The Amazon Resource Name (ARN) of the parent (composite) recovery point.

              
            

            - **ResourceArn** *(string) --* 

              The Amazon Resource Name (ARN) that uniquely identifies a saved resource.

              
            

            - **ResourceType** *(string) --* 

              The Amazon Web Services resource type that is saved as a recovery point.

              
            

            - **BackupVaultName** *(string) --* 

              The name of the backup vault (the logical container in which backups are stored).

              
        
      
    