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

**************************
DescribeScheduledInstances
**************************



.. py:class:: EC2.Paginator.DescribeScheduledInstances

  ::

    
    paginator = client.get_paginator('describe_scheduled_instances')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          ScheduledInstanceIds=[
              'string',
          ],
          SlotStartTimeRange={
              'EarliestTime': datetime(2015, 1, 1),
              'LatestTime': datetime(2015, 1, 1)
          },
          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 Filters: list
    :param Filters: 

      The filters.

       

      
      * ``availability-zone`` - The Availability Zone (for example, ``us-west-2a``).
       
      * ``instance-type`` - The instance type (for example, ``c4.large``).
       
      * ``platform`` - The platform ( ``Linux/UNIX`` or ``Windows``).
      

      

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

      The Scheduled Instance IDs.

      

    
      - *(string) --* 

      
  
    :type SlotStartTimeRange: dict
    :param SlotStartTimeRange: 

      The time period for the first schedule to start.

      

    
      - **EarliestTime** *(datetime) --* 

        The earliest date and time, in UTC, for the Scheduled Instance to start.

        

      
      - **LatestTime** *(datetime) --* 

        The latest date and time, in UTC, for the Scheduled Instance to start.

        

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

      
      ::

        {
            'ScheduledInstanceSet': [
                {
                    'AvailabilityZone': 'string',
                    'CreateDate': datetime(2015, 1, 1),
                    'HourlyPrice': 'string',
                    'InstanceCount': 123,
                    'InstanceType': 'string',
                    'NetworkPlatform': 'string',
                    'NextSlotStartTime': datetime(2015, 1, 1),
                    'Platform': 'string',
                    'PreviousSlotEndTime': datetime(2015, 1, 1),
                    'Recurrence': {
                        'Frequency': 'string',
                        'Interval': 123,
                        'OccurrenceDaySet': [
                            123,
                        ],
                        'OccurrenceRelativeToEnd': True|False,
                        'OccurrenceUnit': 'string'
                    },
                    'ScheduledInstanceId': 'string',
                    'SlotDurationInHours': 123,
                    'TermEndDate': datetime(2015, 1, 1),
                    'TermStartDate': datetime(2015, 1, 1),
                    'TotalScheduledInstanceHours': 123
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the output of DescribeScheduledInstances.

        
        

        - **ScheduledInstanceSet** *(list) --* 

          Information about the Scheduled Instances.

          
          

          - *(dict) --* 

            Describes a Scheduled Instance.

            
            

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

              The Availability Zone.

              
            

            - **CreateDate** *(datetime) --* 

              The date when the Scheduled Instance was purchased.

              
            

            - **HourlyPrice** *(string) --* 

              The hourly price for a single instance.

              
            

            - **InstanceCount** *(integer) --* 

              The number of instances.

              
            

            - **InstanceType** *(string) --* 

              The instance type.

              
            

            - **NetworkPlatform** *(string) --* 

              The network platform.

              
            

            - **NextSlotStartTime** *(datetime) --* 

              The time for the next schedule to start.

              
            

            - **Platform** *(string) --* 

              The platform ( ``Linux/UNIX`` or ``Windows``).

              
            

            - **PreviousSlotEndTime** *(datetime) --* 

              The time that the previous schedule ended or will end.

              
            

            - **Recurrence** *(dict) --* 

              The schedule recurrence.

              
              

              - **Frequency** *(string) --* 

                The frequency ( ``Daily``, ``Weekly``, or ``Monthly``).

                
              

              - **Interval** *(integer) --* 

                The interval quantity. The interval unit depends on the value of ``frequency``. For example, every 2 weeks or every 2 months.

                
              

              - **OccurrenceDaySet** *(list) --* 

                The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

                
                

                - *(integer) --* 
            
              

              - **OccurrenceRelativeToEnd** *(boolean) --* 

                Indicates whether the occurrence is relative to the end of the specified week or month.

                
              

              - **OccurrenceUnit** *(string) --* 

                The unit for ``occurrenceDaySet`` ( ``DayOfWeek`` or ``DayOfMonth``).

                
          
            

            - **ScheduledInstanceId** *(string) --* 

              The Scheduled Instance ID.

              
            

            - **SlotDurationInHours** *(integer) --* 

              The number of hours in the schedule.

              
            

            - **TermEndDate** *(datetime) --* 

              The end date for the Scheduled Instance.

              
            

            - **TermStartDate** *(datetime) --* 

              The start date for the Scheduled Instance.

              
            

            - **TotalScheduledInstanceHours** *(integer) --* 

              The total number of hours for a single instance for the entire term.

              
        
      
    