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

********************
DescribeVolumeStatus
********************



.. py:class:: EC2.Paginator.DescribeVolumeStatus

  ::

    
    paginator = client.get_paginator('describe_volume_status')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The IDs of the volumes.

       

      Default: Describes all your volumes.

      

    
      - *(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 Filters: list
    :param Filters: 

      The filters.

       

      
      * ``action.code`` - The action code for the event (for example, ``enable-volume-io``).
       
      * ``action.description`` - A description of the action.
       
      * ``action.event-id`` - The event ID associated with the action.
       
      * ``availability-zone`` - The Availability Zone of the instance.
       
      * ``event.description`` - A description of the event.
       
      * ``event.event-id`` - The event ID.
       
      * ``event.event-type`` - The event type (for ``io-enabled``: ``passed`` | ``failed``; for ``io-performance``: ``io-performance:degraded`` | ``io-performance:severely-degraded`` | ``io-performance:stalled``).
       
      * ``event.not-after`` - The latest end time for the event.
       
      * ``event.not-before`` - The earliest start time for the event.
       
      * ``volume-status.details-name`` - The cause for ``volume-status.status`` ( ``io-enabled`` | ``io-performance``).
       
      * ``volume-status.details-status`` - The status of ``volume-status.details-name`` (for ``io-enabled``: ``passed`` | ``failed``; for ``io-performance``: ``normal`` | ``degraded`` | ``severely-degraded`` | ``stalled``).
       
      * ``volume-status.status`` - The status of the volume ( ``ok`` | ``impaired`` | ``warning`` | ``insufficient-data``).
      

      

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

      
      ::

        {
            'VolumeStatuses': [
                {
                    'Actions': [
                        {
                            'Code': 'string',
                            'Description': 'string',
                            'EventId': 'string',
                            'EventType': 'string'
                        },
                    ],
                    'AvailabilityZone': 'string',
                    'OutpostArn': 'string',
                    'Events': [
                        {
                            'Description': 'string',
                            'EventId': 'string',
                            'EventType': 'string',
                            'NotAfter': datetime(2015, 1, 1),
                            'NotBefore': datetime(2015, 1, 1),
                            'InstanceId': 'string'
                        },
                    ],
                    'VolumeId': 'string',
                    'VolumeStatus': {
                        'Details': [
                            {
                                'Name': 'io-enabled'|'io-performance'|'initialization-state',
                                'Status': 'string'
                            },
                        ],
                        'Status': 'ok'|'impaired'|'insufficient-data'|'warning'
                    },
                    'AttachmentStatuses': [
                        {
                            'IoPerformance': 'string',
                            'InstanceId': 'string'
                        },
                    ],
                    'InitializationStatusDetails': {
                        'InitializationType': 'default'|'provisioned-rate'|'volume-copy',
                        'Progress': 123,
                        'EstimatedTimeToCompleteInSeconds': 123
                    },
                    'AvailabilityZoneId': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **VolumeStatuses** *(list) --* 

          Information about the status of the volumes.

          
          

          - *(dict) --* 

            Describes the volume status.

            
            

            - **Actions** *(list) --* 

              The details of the operation.

              
              

              - *(dict) --* 

                Describes a volume status operation code.

                
                

                - **Code** *(string) --* 

                  The code identifying the operation, for example, ``enable-volume-io``.

                  
                

                - **Description** *(string) --* 

                  A description of the operation.

                  
                

                - **EventId** *(string) --* 

                  The ID of the event associated with this operation.

                  
                

                - **EventType** *(string) --* 

                  The event type associated with this operation.

                  
            
          
            

            - **AvailabilityZone** *(string) --* 

              The Availability Zone of the volume.

              
            

            - **OutpostArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Outpost.

              
            

            - **Events** *(list) --* 

              A list of events associated with the volume.

              
              

              - *(dict) --* 

                Describes a volume status event.

                
                

                - **Description** *(string) --* 

                  A description of the event.

                  
                

                - **EventId** *(string) --* 

                  The ID of this event.

                  
                

                - **EventType** *(string) --* 

                  The type of this event.

                  
                

                - **NotAfter** *(datetime) --* 

                  The latest end time of the event.

                  
                

                - **NotBefore** *(datetime) --* 

                  The earliest start time of the event.

                  
                

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

                  The ID of the instance associated with the event.

                  
            
          
            

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

              The volume ID.

              
            

            - **VolumeStatus** *(dict) --* 

              The volume status.

              
              

              - **Details** *(list) --* 

                The details of the volume status.

                
                

                - *(dict) --* 

                  Describes a volume status.

                  
                  

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

                    The name of the volume status.

                     

                    
                    * ``io-enabled`` - Indicates the volume I/O status. For more information, see `Amazon EBS volume status checks <https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-checks.html>`__.
                     
                    * ``io-performance`` - Indicates the volume performance status. For more information, see `Amazon EBS volume status checks <https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-checks.html>`__.
                     
                    * ``initialization-state`` - Indicates the status of the volume initialization process. For more information, see `Initialize Amazon EBS volumes <https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html>`__.
                    

                    
                  

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

                    The intended status of the volume status.

                    
              
            
              

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

                The status of the volume.

                
          
            

            - **AttachmentStatuses** *(list) --* 

              Information about the instances to which the volume is attached.

              
              

              - *(dict) --* 

                Information about the instances to which the volume is attached.

                
                

                - **IoPerformance** *(string) --* 

                  The maximum IOPS supported by the attached instance.

                  
                

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

                  The ID of the attached instance.

                  
            
          
            

            - **InitializationStatusDetails** *(dict) --* 

              Information about the volume initialization. It can take up to 5 minutes for the volume initialization information to be updated.

               

              Only available for volumes created from snapshots. Not available for empty volumes created without a snapshot.

               

              For more information, see `Initialize Amazon EBS volumes <https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html>`__.

              
              

              - **InitializationType** *(string) --* 

                The method used for volume initialization. Possible values include:

                 

                
                * ``default`` - Volume initialized using the default volume initialization rate or fast snapshot restore.
                 
                * ``provisioned-rate`` - Volume initialized using an Amazon EBS Provisioned Rate for Volume Initialization.
                 
                * ``volume-copy`` - Volume copy initialized at the rate for volume copies.
                

                
              

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

                The current volume initialization progress as a percentage (0-100). Returns ``100`` when volume initialization has completed.

                
              

              - **EstimatedTimeToCompleteInSeconds** *(integer) --* 

                The estimated remaining time, in seconds, for volume initialization to complete. Returns ``0`` when volume initialization has completed.

                 

                Only available for volumes created with Amazon EBS Provisioned Rate for Volume Initialization.

                
          
            

            - **AvailabilityZoneId** *(string) --* 

              The ID of the Availability Zone.

              
        
      
    