GetServiceProfileCommand

Gets information about a service profile.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTWirelessClient, GetServiceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetServiceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetServiceProfileRequest
  Id: "STRING_VALUE", // required
};
const command = new GetServiceProfileCommand(input);
const response = await client.send(command);
// { // GetServiceProfileResponse
//   Arn: "STRING_VALUE",
//   Name: "STRING_VALUE",
//   Id: "STRING_VALUE",
//   LoRaWAN: { // LoRaWANGetServiceProfileInfo
//     UlRate: Number("int"),
//     UlBucketSize: Number("int"),
//     UlRatePolicy: "STRING_VALUE",
//     DlRate: Number("int"),
//     DlBucketSize: Number("int"),
//     DlRatePolicy: "STRING_VALUE",
//     AddGwMetadata: true || false,
//     DevStatusReqFreq: Number("int"),
//     ReportDevStatusBattery: true || false,
//     ReportDevStatusMargin: true || false,
//     DrMin: Number("int"),
//     DrMax: Number("int"),
//     ChannelMask: "STRING_VALUE",
//     PrAllowed: true || false,
//     HrAllowed: true || false,
//     RaAllowed: true || false,
//     NwkGeoLoc: true || false,
//     TargetPer: Number("int"),
//     MinGwDiversity: Number("int"),
//   },
// };

GetServiceProfileCommand Input

See GetServiceProfileCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The ID of the resource to get.

GetServiceProfileCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The Amazon Resource Name of the resource.

Id
string | undefined

The ID of the service profile.

LoRaWAN
LoRaWANGetServiceProfileInfo | undefined

Information about the service profile.

Name
string | undefined

The name of the resource.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have permission to perform this action.

InternalServerException
server

An unexpected error occurred while processing a request.

ResourceNotFoundException
client

Resource does not exist.

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.