:doc:`EC2 <../../ec2>` / Client / restore_snapshot_tier

*********************
restore_snapshot_tier
*********************



.. py:method:: EC2.Client.restore_snapshot_tier(**kwargs)

  

  Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

   

  For more information see `Restore an archived snapshot <https://docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#restore-archived-snapshot>`__ and `modify the restore period or restore type for a temporarily restored snapshot <https://docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#modify-temp-restore-period>`__ in the *Amazon EBS User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/RestoreSnapshotTier>`_  


  **Request Syntax**
  ::

    response = client.restore_snapshot_tier(
        SnapshotId='string',
        TemporaryRestoreDays=123,
        PermanentRestore=True|False,
        DryRun=True|False
    )
    
  :type SnapshotId: string
  :param SnapshotId: **[REQUIRED]** 

    The ID of the snapshot to restore.

    

  
  :type TemporaryRestoreDays: integer
  :param TemporaryRestoreDays: 

    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

     

    To temporarily restore an archived snapshot, specify the number of days and omit the **PermanentRestore** parameter or set it to ``false``.

    

  
  :type PermanentRestore: boolean
  :param PermanentRestore: 

    Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify ``true`` and omit the **RestoreSnapshotTierRequest$TemporaryRestoreDays** parameter.

    

  
  :type DryRun: boolean
  :param DryRun: 

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

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

    
    ::

      {
          'SnapshotId': 'string',
          'RestoreStartTime': datetime(2015, 1, 1),
          'RestoreDuration': 123,
          'IsPermanentRestore': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SnapshotId** *(string) --* 

        The ID of the snapshot.

        
      

      - **RestoreStartTime** *(datetime) --* 

        The date and time when the snapshot restore process started.

        
      

      - **RestoreDuration** *(integer) --* 

        For temporary restores only. The number of days for which the archived snapshot is temporarily restored.

        
      

      - **IsPermanentRestore** *(boolean) --* 

        Indicates whether the snapshot is permanently restored. ``true`` indicates a permanent restore. ``false`` indicates a temporary restore.

        
  