AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
The delete key pair
operation supports tag-based access control via resource
tags applied to the resource identified by key pair name
. For more information,
see the Amazon
Lightsail Developer Guide.
For .NET Core this operation is only available in asynchronous form. Please refer to DeleteKeyPairAsync.
Namespace: Amazon.Lightsail
Assembly: AWSSDK.Lightsail.dll
Version: 3.x.y.z
public virtual DeleteKeyPairResponse DeleteKeyPair( DeleteKeyPairRequest request )
Container for the necessary parameters to execute the DeleteKeyPair service method.
Exception | Condition |
---|---|
AccessDeniedException | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
AccountSetupInProgressException | Lightsail throws this exception when an account is still in the setup in progress state. |
InvalidInputException | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources. |
NotFoundException | Lightsail throws this exception when it cannot find a resource. |
OperationFailureException | Lightsail throws this exception when an operation fails to execute. |
ServiceException | A general service exception. |
UnauthenticatedException | Lightsail throws this exception when the user has not been authenticated. |
.NET Framework:
Supported in: 4.5 and newer, 3.5