@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
102 lines (101 loc) • 4.41 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { ListThingPrincipalsV2Request, ListThingPrincipalsV2Response } from "../models/models_2";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link ListThingPrincipalsV2Command}.
*/
export interface ListThingPrincipalsV2CommandInput extends ListThingPrincipalsV2Request {
}
/**
* @public
*
* The output of {@link ListThingPrincipalsV2Command}.
*/
export interface ListThingPrincipalsV2CommandOutput extends ListThingPrincipalsV2Response, __MetadataBearer {
}
declare const ListThingPrincipalsV2Command_base: {
new (input: ListThingPrincipalsV2CommandInput): import("@smithy/smithy-client").CommandImpl<ListThingPrincipalsV2CommandInput, ListThingPrincipalsV2CommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: ListThingPrincipalsV2CommandInput): import("@smithy/smithy-client").CommandImpl<ListThingPrincipalsV2CommandInput, ListThingPrincipalsV2CommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Lists the principals associated with the specified thing. A principal can be an X.509
* certificate or an Amazon Cognito ID.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingPrincipals</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, ListThingPrincipalsV2Command } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, ListThingPrincipalsV2Command } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // ListThingPrincipalsV2Request
* nextToken: "STRING_VALUE",
* maxResults: Number("int"),
* thingName: "STRING_VALUE", // required
* thingPrincipalType: "EXCLUSIVE_THING" || "NON_EXCLUSIVE_THING",
* };
* const command = new ListThingPrincipalsV2Command(input);
* const response = await client.send(command);
* // { // ListThingPrincipalsV2Response
* // thingPrincipalObjects: [ // ThingPrincipalObjects
* // { // ThingPrincipalObject
* // principal: "STRING_VALUE", // required
* // thingPrincipalType: "EXCLUSIVE_THING" || "NON_EXCLUSIVE_THING",
* // },
* // ],
* // nextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param ListThingPrincipalsV2CommandInput - {@link ListThingPrincipalsV2CommandInput}
* @returns {@link ListThingPrincipalsV2CommandOutput}
* @see {@link ListThingPrincipalsV2CommandInput} for command's `input` shape.
* @see {@link ListThingPrincipalsV2CommandOutput} for command's `response` shape.
* @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
*
* @throws {@link InternalFailureException} (server fault)
* <p>An unexpected error has occurred.</p>
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is not valid.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource does not exist.</p>
*
* @throws {@link ServiceUnavailableException} (server fault)
* <p>The service is temporarily unavailable.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The rate exceeds the limit.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>You are not authorized to perform this operation.</p>
*
* @throws {@link IoTServiceException}
* <p>Base exception class for all service exceptions from IoT service.</p>
*
*
* @public
*/
export declare class ListThingPrincipalsV2Command extends ListThingPrincipalsV2Command_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: ListThingPrincipalsV2Request;
output: ListThingPrincipalsV2Response;
};
sdk: {
input: ListThingPrincipalsV2CommandInput;
output: ListThingPrincipalsV2CommandOutput;
};
};
}