Skip to content

list_destinations

list_destinations(
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListDestinationsResponse

Lists the destinations registered to your AWS account.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return in this operation.

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

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def list_destinations(
    self,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    max_results: Optional["capo_iot_wireless.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_iot_wireless.types.next_token.NextToken"] = None,
) -> "capo_iot_wireless.types.list_destinations_response.ListDestinationsResponse":
    """<p>Lists the destinations registered to your AWS account.</p>

    Args:
        max_results: <p>The maximum number of results to return in this operation.</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>

    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.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_destinations_request.ListDestinationsRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.list_destinations_response.ListDestinationsResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.list_destinations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDestinations")
    )
    input_: capo_iot_wireless.types.list_destinations_request.ListDestinationsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    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