@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
101 lines (100 loc) • 4.58 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { RejectCertificateTransferRequest } from "../models/models_2";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link RejectCertificateTransferCommand}.
*/
export interface RejectCertificateTransferCommandInput extends RejectCertificateTransferRequest {
}
/**
* @public
*
* The output of {@link RejectCertificateTransferCommand}.
*/
export interface RejectCertificateTransferCommandOutput extends __MetadataBearer {
}
declare const RejectCertificateTransferCommand_base: {
new (input: RejectCertificateTransferCommandInput): import("@smithy/smithy-client").CommandImpl<RejectCertificateTransferCommandInput, RejectCertificateTransferCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: RejectCertificateTransferCommandInput): import("@smithy/smithy-client").CommandImpl<RejectCertificateTransferCommandInput, RejectCertificateTransferCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Rejects a pending certificate transfer. After IoT rejects a certificate transfer,
* the certificate status changes from <b>PENDING_TRANSFER</b> to
* <b>INACTIVE</b>.</p>
* <p>To check for pending certificate transfers, call <a>ListCertificates</a>
* to enumerate your certificates.</p>
* <p>This operation can only be called by the transfer destination. After it is called,
* the certificate will be returned to the source's account in the INACTIVE state.</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">RejectCertificateTransfer</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, RejectCertificateTransferCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, RejectCertificateTransferCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // RejectCertificateTransferRequest
* certificateId: "STRING_VALUE", // required
* rejectReason: "STRING_VALUE",
* };
* const command = new RejectCertificateTransferCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param RejectCertificateTransferCommandInput - {@link RejectCertificateTransferCommandInput}
* @returns {@link RejectCertificateTransferCommandOutput}
* @see {@link RejectCertificateTransferCommandInput} for command's `input` shape.
* @see {@link RejectCertificateTransferCommandOutput} 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 TransferAlreadyCompletedException} (client fault)
* <p>You can't revert the certificate transfer because the transfer is already
* complete.</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 RejectCertificateTransferCommand extends RejectCertificateTransferCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: RejectCertificateTransferRequest;
output: {};
};
sdk: {
input: RejectCertificateTransferCommandInput;
output: RejectCertificateTransferCommandOutput;
};
};
}