- 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.
GetPartnerAccountCommand
Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTWirelessClient, GetPartnerAccountCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetPartnerAccountCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetPartnerAccountRequest
PartnerAccountId: "STRING_VALUE", // required
PartnerType: "Sidewalk", // required
};
const command = new GetPartnerAccountCommand(input);
const response = await client.send(command);
// { // GetPartnerAccountResponse
// Sidewalk: { // SidewalkAccountInfoWithFingerprint
// AmazonId: "STRING_VALUE",
// Fingerprint: "STRING_VALUE",
// Arn: "STRING_VALUE",
// },
// AccountLinked: true || false,
// };
GetPartnerAccountCommand Input
See GetPartnerAccountCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
PartnerAccountIdRequired | string | undefined | The partner account ID to disassociate from the AWS account. |
PartnerTypeRequired | PartnerType | undefined | The partner type. |
GetPartnerAccountCommand Output
See GetPartnerAccountCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
AccountLinked | boolean | undefined | Whether the partner account is linked to the AWS account. |
Sidewalk | SidewalkAccountInfoWithFingerprint | undefined | The Sidewalk account credentials. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| 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. |