:doc:`IoTFleetWise <../../iotfleetwise>` / Paginator / GetVehicleStatus

****************
GetVehicleStatus
****************



.. py:class:: IoTFleetWise.Paginator.GetVehicleStatus

  ::

    
    paginator = client.get_paginator('get_vehicle_status')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTFleetWise.Client.get_vehicle_status`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/GetVehicleStatus>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          vehicleName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type vehicleName: string
    :param vehicleName: **[REQUIRED]** 

      The ID of the vehicle to retrieve information about.

      

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

      
      ::

        {
            'campaigns': [
                {
                    'campaignName': 'string',
                    'vehicleName': 'string',
                    'status': 'CREATED'|'READY'|'HEALTHY'|'SUSPENDED'|'DELETING'|'READY_FOR_CHECKIN'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **campaigns** *(list) --* 

          Lists information about the state of the vehicle with deployed campaigns.

          
          

          - *(dict) --* 

            Information about a campaign associated with a vehicle.

            
            

            - **campaignName** *(string) --* 

              The name of a campaign.

              
            

            - **vehicleName** *(string) --* 

              The unique ID of the vehicle.

              
            

            - **status** *(string) --* 

              The status of a campaign, which can be one of the following:

               

              
              * ``CREATED`` - The campaign exists but is not yet approved.
               
              * ``READY`` - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet.
               
              * ``HEALTHY`` - The campaign is deployed to the vehicle.
               
              * ``SUSPENDED`` - The campaign is suspended and data collection is paused.
               
              * ``DELETING`` - The campaign is being removed from the vehicle.
               
              * ``READY_FOR_CHECKIN`` - The campaign is approved and waiting for vehicle check-in before deployment.
              

              
        
      
        

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

          A token to resume pagination.

          
    