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

****************************
DescribeVolumesModifications
****************************



.. py:class:: EC2.Paginator.DescribeVolumesModifications

  ::

    
    paginator = client.get_paginator('describe_volumes_modifications')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          VolumeIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 VolumeIds: list
    :param VolumeIds: 

      The IDs of the volumes.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      The filters.

       

      
      * ``modification-state`` - The current modification state (modifying | optimizing | completed | failed).
       
      * ``original-iops`` - The original IOPS rate of the volume.
       
      * ``original-size`` - The original size of the volume, in GiB.
       
      * ``original-volume-type`` - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
       
      * ``originalMultiAttachEnabled`` - Indicates whether Multi-Attach support was enabled (true | false).
       
      * ``start-time`` - The modification start time.
       
      * ``target-iops`` - The target IOPS rate of the volume.
       
      * ``target-size`` - The target size of the volume, in GiB.
       
      * ``target-volume-type`` - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
       
      * ``targetMultiAttachEnabled`` - Indicates whether Multi-Attach support is to be enabled (true | false).
       
      * ``volume-id`` - The ID of the volume.
      

      

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

      
      ::

        {
            'VolumesModifications': [
                {
                    'VolumeId': 'string',
                    'ModificationState': 'modifying'|'optimizing'|'completed'|'failed',
                    'StatusMessage': 'string',
                    'TargetSize': 123,
                    'TargetIops': 123,
                    'TargetVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                    'TargetThroughput': 123,
                    'TargetMultiAttachEnabled': True|False,
                    'OriginalSize': 123,
                    'OriginalIops': 123,
                    'OriginalVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                    'OriginalThroughput': 123,
                    'OriginalMultiAttachEnabled': True|False,
                    'Progress': 123,
                    'StartTime': datetime(2015, 1, 1),
                    'EndTime': datetime(2015, 1, 1)
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **VolumesModifications** *(list) --* 

          Information about the volume modifications.

          
          

          - *(dict) --* 

            Describes the modification status of an EBS volume.

            
            

            - **VolumeId** *(string) --* 

              The ID of the volume.

              
            

            - **ModificationState** *(string) --* 

              The current modification state.

              
            

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

              A status message about the modification progress or failure.

              
            

            - **TargetSize** *(integer) --* 

              The target size of the volume, in GiB.

              
            

            - **TargetIops** *(integer) --* 

              The target IOPS rate of the volume.

              
            

            - **TargetVolumeType** *(string) --* 

              The target EBS volume type of the volume.

              
            

            - **TargetThroughput** *(integer) --* 

              The target throughput of the volume, in MiB/s.

              
            

            - **TargetMultiAttachEnabled** *(boolean) --* 

              The target setting for Amazon EBS Multi-Attach.

              
            

            - **OriginalSize** *(integer) --* 

              The original size of the volume, in GiB.

              
            

            - **OriginalIops** *(integer) --* 

              The original IOPS rate of the volume.

              
            

            - **OriginalVolumeType** *(string) --* 

              The original EBS volume type of the volume.

              
            

            - **OriginalThroughput** *(integer) --* 

              The original throughput of the volume, in MiB/s.

              
            

            - **OriginalMultiAttachEnabled** *(boolean) --* 

              The original setting for Amazon EBS Multi-Attach.

              
            

            - **Progress** *(integer) --* 

              The modification progress, from 0 to 100 percent complete.

              
            

            - **StartTime** *(datetime) --* 

              The modification start time.

              
            

            - **EndTime** *(datetime) --* 

              The modification completion or failure time.

              
        
      
    