- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetServiceEndpointCommand
Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTWirelessClient, GetServiceEndpointCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetServiceEndpointCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetServiceEndpointRequest
ServiceType: "CUPS" || "LNS",
};
const command = new GetServiceEndpointCommand(input);
const response = await client.send(command);
// { // GetServiceEndpointResponse
// ServiceType: "CUPS" || "LNS",
// ServiceEndpoint: "STRING_VALUE",
// ServerTrust: "STRING_VALUE",
// };
GetServiceEndpointCommand Input
See GetServiceEndpointCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ServiceType | WirelessGatewayServiceType | undefined | The service type for which to get endpoint information about. Can be |
GetServiceEndpointCommand Output
See GetServiceEndpointCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ServerTrust | string | undefined | The Root CA of the server trust certificate. |
ServiceEndpoint | string | undefined | The service endpoint value. |
ServiceType | WirelessGatewayServiceType | undefined | The endpoint's service type. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | User does not have permission to perform this action. |
| InternalServerException | server | An unexpected error occurred while processing a request. |
| ThrottlingException | client | The request was denied because it exceeded the allowed API request rate. |
| ValidationException | client | The input did not meet the specified constraints. |
| IoTWirelessServiceException | Base exception class for all service exceptions from IoTWireless service. |