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

*************************
ListIndexedRecoveryPoints
*************************



.. py:class:: Backup.Paginator.ListIndexedRecoveryPoints

  ::

    
    paginator = client.get_paginator('list_indexed_recovery_points')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SourceResourceArn='string',
          CreatedBefore=datetime(2015, 1, 1),
          CreatedAfter=datetime(2015, 1, 1),
          ResourceType='string',
          IndexStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SourceResourceArn: string
    :param SourceResourceArn: 

      A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

      

    
    :type CreatedBefore: datetime
    :param CreatedBefore: 

      Returns only indexed recovery points that were created before the specified date.

      

    
    :type CreatedAfter: datetime
    :param CreatedAfter: 

      Returns only indexed recovery points that were created after the specified date.

      

    
    :type ResourceType: string
    :param ResourceType: 

      Returns a list of indexed recovery points for the specified resource type(s).

       

      Accepted values include:

       

      
      * ``EBS`` for Amazon Elastic Block Store
       
      * ``S3`` for Amazon Simple Storage Service (Amazon S3)
      

      

    
    :type IndexStatus: string
    :param IndexStatus: 

      Include this parameter to filter the returned list by the indicated statuses.

       

      Accepted values: ``PENDING`` | ``ACTIVE`` | ``FAILED`` | ``DELETING``

       

      A recovery point with an index that has the status of ``ACTIVE`` can be included in a search.

      

    
    :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**

      
      ::

        {
            'IndexedRecoveryPoints': [
                {
                    'RecoveryPointArn': 'string',
                    'SourceResourceArn': 'string',
                    'IamRoleArn': 'string',
                    'BackupCreationDate': datetime(2015, 1, 1),
                    'ResourceType': 'string',
                    'IndexCreationDate': datetime(2015, 1, 1),
                    'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING',
                    'IndexStatusMessage': 'string',
                    'BackupVaultArn': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **IndexedRecoveryPoints** *(list) --* 

          This is a list of recovery points that have an associated index, belonging to the specified account.

          
          

          - *(dict) --* 

            This is a recovery point that has an associated backup index.

             

            Only recovery points with a backup index can be included in a search.

            
            

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

              An ARN that uniquely identifies a recovery point; for example, ``arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45``

              
            

            - **SourceResourceArn** *(string) --* 

              A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

              
            

            - **IamRoleArn** *(string) --* 

              This specifies the IAM role ARN used for this operation.

               

              For example, arn:aws:iam::123456789012:role/S3Access

              
            

            - **BackupCreationDate** *(datetime) --* 

              The date and time that a backup was created, in Unix format and Coordinated Universal Time (UTC). The value of ``CreationDate`` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

              
            

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

              The resource type of the indexed recovery point.

               

              
              * ``EBS`` for Amazon Elastic Block Store
               
              * ``S3`` for Amazon Simple Storage Service (Amazon S3)
              

              
            

            - **IndexCreationDate** *(datetime) --* 

              The date and time that a backup index was created, in Unix format and Coordinated Universal Time (UTC). The value of ``CreationDate`` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

              
            

            - **IndexStatus** *(string) --* 

              This is the current status for the backup index associated with the specified recovery point.

               

              Statuses are: ``PENDING`` | ``ACTIVE`` | ``FAILED`` | ``DELETING``

               

              A recovery point with an index that has the status of ``ACTIVE`` can be included in a search.

              
            

            - **IndexStatusMessage** *(string) --* 

              A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.

              
            

            - **BackupVaultArn** *(string) --* 

              An ARN that uniquely identifies the backup vault where the recovery point index is stored.

               

              For example, ``arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault``.

              
        
      
    