Skip to content

batch_get_asset_property_value

batch_get_asset_property_value(
    entries: BatchGetAssetPropertyValueEntries,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional[NextToken] = None,
) -> BatchGetAssetPropertyValueResponse

Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

Parameters:

  • entries (BatchGetAssetPropertyValueEntries) –

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

  • next_token (Optional[NextToken], default: None ) –

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

Raises:

  • InternalFailureException –

    IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ServiceUnavailableException –

    The requested service is unavailable.

  • ThrottlingException –

    Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py
def batch_get_asset_property_value(
    self,
    entries: "capo_iotsitewise.types.batch_get_asset_property_value_entries.BatchGetAssetPropertyValueEntries",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
) -> "capo_iotsitewise.types.batch_get_asset_property_value_response.BatchGetAssetPropertyValueResponse":
    """<p>Gets the current value for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying current values</a> in the <i>IoT SiteWise User Guide</i>.</p>

    Args:
        entries: <p>The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.</p>
        next_token: <p>The token to be used for the next set of paginated results.</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.service_unavailable_exception.ServiceUnavailableException: <p>The requested service is unavailable.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.batch_get_asset_property_value_request.BatchGetAssetPropertyValueRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.batch_get_asset_property_value_response.BatchGetAssetPropertyValueResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.batch_get_asset_property_value

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.batch_get_asset_property_value.batch_get_asset_property_value(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetAssetPropertyValue")
    )
    input_: capo_iotsitewise.types.batch_get_asset_property_value_request.BatchGetAssetPropertyValueRequest = {
        "entries": entries
    }
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output