:doc:`EC2 <../../ec2>` / Paginator / DescribeReplaceRootVolumeTasks

******************************
DescribeReplaceRootVolumeTasks
******************************



.. py:class:: EC2.Paginator.DescribeReplaceRootVolumeTasks

  ::

    
    paginator = client.get_paginator('describe_replace_root_volume_tasks')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_replace_root_volume_tasks`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ReplaceRootVolumeTaskIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          DryRun=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ReplaceRootVolumeTaskIds: list
    :param ReplaceRootVolumeTaskIds: 

      The ID of the root volume replacement task to view.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      Filter to use:

       

      
      * ``instance-id`` - The ID of the instance for which the root volume replacement task was created.
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

         

        If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

         

        For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

        

      
        - **Name** *(string) --* 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

          

        
          - *(string) --* 

          
      
      
  
    :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``.

      

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

      
      ::

        {
            'ReplaceRootVolumeTasks': [
                {
                    'ReplaceRootVolumeTaskId': 'string',
                    'InstanceId': 'string',
                    'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached',
                    'StartTime': 'string',
                    'CompleteTime': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'ImageId': 'string',
                    'SnapshotId': 'string',
                    'DeleteReplacedRootVolume': True|False
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ReplaceRootVolumeTasks** *(list) --* 

          Information about the root volume replacement task.

          
          

          - *(dict) --* 

            Information about a root volume replacement task.

            
            

            - **ReplaceRootVolumeTaskId** *(string) --* 

              The ID of the root volume replacement task.

              
            

            - **InstanceId** *(string) --* 

              The ID of the instance for which the root volume replacement task was created.

              
            

            - **TaskState** *(string) --* 

              The state of the task. The task can be in one of the following states:

               

              
              * ``pending`` - the replacement volume is being created.
               
              * ``in-progress`` - the original volume is being detached and the replacement volume is being attached.
               
              * ``succeeded`` - the replacement volume has been successfully attached to the instance and the instance is available.
               
              * ``failing`` - the replacement task is in the process of failing.
               
              * ``failed`` - the replacement task has failed but the original root volume is still attached.
               
              * ``failing-detached`` - the replacement task is in the process of failing. The instance might have no root volume attached.
               
              * ``failed-detached`` - the replacement task has failed and the instance has no root volume attached.
              

              
            

            - **StartTime** *(string) --* 

              The time the task was started.

              
            

            - **CompleteTime** *(string) --* 

              The time the task completed.

              
            

            - **Tags** *(list) --* 

              The tags assigned to the task.

              
              

              - *(dict) --* 

                Describes a tag.

                
                

                - **Key** *(string) --* 

                  The key of the tag.

                   

                  Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                  
                

                - **Value** *(string) --* 

                  The value of the tag.

                   

                  Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                  
            
          
            

            - **ImageId** *(string) --* 

              The ID of the AMI used to create the replacement root volume.

              
            

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

              The ID of the snapshot used to create the replacement root volume.

              
            

            - **DeleteReplacedRootVolume** *(boolean) --* 

              Indicates whether the original root volume is to be deleted after the root volume replacement task completes.

              
        
      
    