AWS SDK Version 3 for .NET
API Reference

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.

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateKeyPairAsync.

Namespace: Amazon.Lightsail
Assembly: AWSSDK.Lightsail.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateKeyPairResponse CreateKeyPair(
         CreateKeyPairRequest request
)

Parameters

request
Type: Amazon.Lightsail.Model.CreateKeyPairRequest

Container for the necessary parameters to execute the CreateKeyPair service method.

Return Value


The response from the CreateKeyPair service method, as returned by Lightsail.

Exceptions

ExceptionCondition
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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also