@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
90 lines (89 loc) • 3.98 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { ListCertificatesRequest, ListCertificatesResponse } from "../models/models_1";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link ListCertificatesCommand}.
*/
export interface ListCertificatesCommandInput extends ListCertificatesRequest {
}
/**
* @public
*
* The output of {@link ListCertificatesCommand}.
*/
export interface ListCertificatesCommandOutput extends ListCertificatesResponse, __MetadataBearer {
}
declare const ListCertificatesCommand_base: {
new (input: ListCertificatesCommandInput): import("@smithy/smithy-client").CommandImpl<ListCertificatesCommandInput, ListCertificatesCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (...[input]: [] | [ListCertificatesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListCertificatesCommandInput, ListCertificatesCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Lists the certificates registered in your Amazon Web Services account.</p>
* <p>The results are paginated with a default page size of 25. You can use the returned
* marker to retrieve additional results.</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">ListCertificates</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, ListCertificatesCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, ListCertificatesCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // ListCertificatesRequest
* pageSize: Number("int"),
* marker: "STRING_VALUE",
* ascendingOrder: true || false,
* };
* const command = new ListCertificatesCommand(input);
* const response = await client.send(command);
* // { // ListCertificatesResponse
* // certificates: [ // Certificates
* // { // Certificate
* // certificateArn: "STRING_VALUE",
* // certificateId: "STRING_VALUE",
* // status: "ACTIVE" || "INACTIVE" || "REVOKED" || "PENDING_TRANSFER" || "REGISTER_INACTIVE" || "PENDING_ACTIVATION",
* // certificateMode: "DEFAULT" || "SNI_ONLY",
* // creationDate: new Date("TIMESTAMP"),
* // },
* // ],
* // nextMarker: "STRING_VALUE",
* // };
*
* ```
*
* @param ListCertificatesCommandInput - {@link ListCertificatesCommandInput}
* @returns {@link ListCertificatesCommandOutput}
* @see {@link ListCertificatesCommandInput} for command's `input` shape.
* @see {@link ListCertificatesCommandOutput} 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 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 ListCertificatesCommand extends ListCertificatesCommand_base {
}