list_queued_messages ¶

def list_queued_messages(
    self,
    id: "capo_iot_wireless.types.wireless_device_id.WirelessDeviceId",
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    next_token: Optional["capo_iot_wireless.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iot_wireless.types.max_results.MaxResults"] = None,
    wireless_device_type: Optional[
        "capo_iot_wireless.types.wireless_device_type.WirelessDeviceType"
    ] = None,
) -> "capo_iot_wireless.types.list_queued_messages_response.ListQueuedMessagesResponse":
    """<p>List queued messages in the downlink queue.</p>

    Args:
        id: <p>The ID of a given wireless device which the downlink message packets are being sent.</p>
        next_token: <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
        max_results: <p>The maximum number of results to return in this operation.</p>
        wireless_device_type: <p>The wireless device type, whic can be either Sidewalk or LoRaWAN.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.list_queued_messages_request.ListQueuedMessagesRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.list_queued_messages_response.ListQueuedMessagesResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.list_queued_messages

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.list_queued_messages.list_queued_messages(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListQueuedMessages")
    )
    input_: capo_iot_wireless.types.list_queued_messages_request.ListQueuedMessagesRequest = {
        "id": id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if wireless_device_type is not None:
        input_["wireless_device_type"] = wireless_device_type

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