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

*****************************
ListRestoreAccessBackupVaults
*****************************



.. py:class:: Backup.Paginator.ListRestoreAccessBackupVaults

  ::

    
    paginator = client.get_paginator('list_restore_access_backup_vaults')

  
  

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

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

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


    **Request Syntax**
    ::

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

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

      

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

      
      ::

        {
            'RestoreAccessBackupVaults': [
                {
                    'RestoreAccessBackupVaultArn': 'string',
                    'CreationDate': datetime(2015, 1, 1),
                    'ApprovalDate': datetime(2015, 1, 1),
                    'VaultState': 'CREATING'|'AVAILABLE'|'FAILED',
                    'LatestRevokeRequest': {
                        'MpaSessionArn': 'string',
                        'Status': 'PENDING'|'FAILED',
                        'StatusMessage': 'string',
                        'InitiationDate': datetime(2015, 1, 1),
                        'ExpiryDate': datetime(2015, 1, 1)
                    }
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **RestoreAccessBackupVaults** *(list) --* 

          A list of restore access backup vaults associated with the specified backup vault.

          
          

          - *(dict) --* 

            Contains information about a restore access backup vault.

            
            

            - **RestoreAccessBackupVaultArn** *(string) --* 

              The ARN of the restore access backup vault.

              
            

            - **CreationDate** *(datetime) --* 

              The date and time when the restore access backup vault was created.

              
            

            - **ApprovalDate** *(datetime) --* 

              The date and time when the restore access backup vault was approved.

              
            

            - **VaultState** *(string) --* 

              The current state of the restore access backup vault.

              
            

            - **LatestRevokeRequest** *(dict) --* 

              Information about the latest request to revoke access to this backup vault.

              
              

              - **MpaSessionArn** *(string) --* 

                The ARN of the MPA session associated with this revoke request.

                
              

              - **Status** *(string) --* 

                The current status of the revoke request.

                
              

              - **StatusMessage** *(string) --* 

                A message describing the current status of the revoke request.

                
              

              - **InitiationDate** *(datetime) --* 

                The date and time when the revoke request was initiated.

                
              

              - **ExpiryDate** *(datetime) --* 

                The date and time when the revoke request will expire.

                
          
        
      
    