:doc:`IoTSiteWise <../../iotsitewise>` / Client / batch_get_asset_property_value

******************************
batch_get_asset_property_value
******************************



.. py:method:: IoTSiteWise.Client.batch_get_asset_property_value(**kwargs)

  

  Gets the current value for one or more asset properties. For more information, see `Querying current values <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values>`__ in the *IoT SiteWise User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValue>`_  


  **Request Syntax**
  ::

    response = client.batch_get_asset_property_value(
        entries=[
            {
                'entryId': 'string',
                'assetId': 'string',
                'propertyId': 'string',
                'propertyAlias': 'string'
            },
        ],
        nextToken='string'
    )
    
  :type entries: list
  :param entries: **[REQUIRED]** 

    The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.

    

  
    - *(dict) --* 

      Contains information for an asset property value entry that is associated with the `BatchGetAssetPropertyValue <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html>`__ API.

       

      To identify an asset property, you must specify one of the following:

       

      
      * The ``assetId`` and ``propertyId`` of an asset property.
       
      * A ``propertyAlias``, which is a data stream alias (for example, ``/company/windfarm/3/turbine/7/temperature``). To define an asset property's alias, see `UpdateAssetProperty <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html>`__.
      

      

    
      - **entryId** *(string) --* **[REQUIRED]** 

        The ID of the entry.

        

      
      - **assetId** *(string) --* 

        The ID of the asset in which the asset property was created.

        

      
      - **propertyId** *(string) --* 

        The ID of the asset property, in UUID format.

        

      
      - **propertyAlias** *(string) --* 

        The alias that identifies the property, such as an OPC-UA server data stream path (for example, ``/company/windfarm/3/turbine/7/temperature``). For more information, see `Mapping industrial data streams to asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html>`__ in the *IoT SiteWise User Guide*.

        

      
    

  :type nextToken: string
  :param nextToken: 

    The token to be used for the next set of paginated results.

    

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

    
    ::

      {
          'errorEntries': [
              {
                  'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
                  'errorMessage': 'string',
                  'entryId': 'string'
              },
          ],
          'successEntries': [
              {
                  'entryId': 'string',
                  'assetPropertyValue': {
                      'value': {
                          'stringValue': 'string',
                          'integerValue': 123,
                          'doubleValue': 123.0,
                          'booleanValue': True|False,
                          'nullValue': {
                              'valueType': 'D'|'B'|'S'|'I'|'U'
                          }
                      },
                      'timestamp': {
                          'timeInSeconds': 123,
                          'offsetInNanos': 123
                      },
                      'quality': 'GOOD'|'BAD'|'UNCERTAIN'
                  }
              },
          ],
          'skippedEntries': [
              {
                  'entryId': 'string',
                  'completionStatus': 'SUCCESS'|'ERROR',
                  'errorInfo': {
                      'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
                      'errorTimestamp': datetime(2015, 1, 1)
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **errorEntries** *(list) --* 

        A list of the errors (if any) associated with the batch request. Each error entry contains the ``entryId`` of the entry that failed.

        
        

        - *(dict) --* 

          Contains error information for an asset property value entry that is associated with the `BatchGetAssetPropertyValue <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html>`__ API.

          
          

          - **errorCode** *(string) --* 

            The error code.

            
          

          - **errorMessage** *(string) --* 

            The associated error message.

            
          

          - **entryId** *(string) --* 

            The ID of the entry.

            
      
    
      

      - **successEntries** *(list) --* 

        A list of entries that were processed successfully by this batch request. Each success entry contains the ``entryId`` of the entry that succeeded and the latest query result.

        
        

        - *(dict) --* 

          Contains success information for an entry that is associated with the `BatchGetAssetPropertyValue <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html>`__ API.

          
          

          - **entryId** *(string) --* 

            The ID of the entry.

            
          

          - **assetPropertyValue** *(dict) --* 

            Contains asset property value information.

            
            

            - **value** *(dict) --* 

              The value of the asset property (see ``Variant``).

              
              

              - **stringValue** *(string) --* 

                Asset property data of type string (sequence of characters). The allowed pattern: "^$|[^\u0000-\u001F\u007F]+". The max length is 1024.

                
              

              - **integerValue** *(integer) --* 

                Asset property data of type integer (whole number).

                
              

              - **doubleValue** *(float) --* 

                Asset property data of type double (floating point number). The min value is -10^10. The max value is 10^10. Double.NaN is allowed.

                
              

              - **booleanValue** *(boolean) --* 

                Asset property data of type Boolean (true or false).

                
              

              - **nullValue** *(dict) --* 

                The type of null asset property data with BAD and UNCERTAIN qualities.

                
                

                - **valueType** *(string) --* 

                  The type of null asset property data.

                  
            
          
            

            - **timestamp** *(dict) --* 

              The timestamp of the asset property value.

              
              

              - **timeInSeconds** *(integer) --* 

                The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by ``offsetInNanos``.

                
              

              - **offsetInNanos** *(integer) --* 

                The nanosecond offset from ``timeInSeconds``.

                
          
            

            - **quality** *(string) --* 

              The quality of the asset property value.

              
        
      
    
      

      - **skippedEntries** *(list) --* 

        A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the ``entryId`` of the entry that skipped.

        
        

        - *(dict) --* 

          Contains information for an entry that has been processed by the previous `BatchGetAssetPropertyValue <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html>`__ request.

          
          

          - **entryId** *(string) --* 

            The ID of the entry.

            
          

          - **completionStatus** *(string) --* 

            The completion status of each entry that is associated with the `BatchGetAssetPropertyValue <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html>`__ request.

            
          

          - **errorInfo** *(dict) --* 

            The error information, such as the error code and the timestamp.

            
            

            - **errorCode** *(string) --* 

              The error code.

              
            

            - **errorTimestamp** *(datetime) --* 

              The date the error occurred, in Unix epoch time.

              
        
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results, or null if there are no additional results.

        
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ServiceUnavailableException`

  