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

******************************
describe_volumes_modifications
******************************



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

  

  Describes the most recent volume modification request for the specified EBS volumes.

   

  For more information, see `Monitor the progress of volume modifications <https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html>`__ in the *Amazon EBS User Guide*.

  

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


  **Request Syntax**
  ::

    response = client.describe_volumes_modifications(
        DryRun=True|False,
        VolumeIds=[
            'string',
        ],
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :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 NextToken: string
  :param NextToken: 

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see `Pagination <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination>`__.

    

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

    
    ::

      {
          'NextToken': 'string',
          '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) --* 
      

      - **NextToken** *(string) --* 

        The token to include in another request to get the next page of items. This value is ``null`` when there are no more items to return.

        
      

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

            
      
    
  