Lightsail / Client / create_key_pair

create_key_pair#

Lightsail.Client.create_key_pair(**kwargs)#

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

Note

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.

Request Syntax

response = client.create_key_pair(
    keyPairName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

keyPairName (string) –
[REQUIRED]

The name for your new key pair.
tags (list) –
The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it’s created.
- (dict) –
  
  Describes a tag key and optional value assigned to an Amazon Lightsail resource.
  
  For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
  - key (string) –
    
    The key of the tag.
    
    Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - value (string) –
    
    The value of the tag.
    
    Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

Return type:

dict

Returns:

Response Syntax

{
    'keyPair': {
        'name': 'string',
        'arn': 'string',
        'supportCode': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'fingerprint': 'string'
    },
    'publicKeyBase64': 'string',
    'privateKeyBase64': 'string',
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- keyPair (dict) –
  
  An array of key-value pairs containing information about the new key pair you just created.
  - name (string) –
    
    The friendly name of the SSH key pair.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
  - supportCode (string) –
    
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - createdAt (datetime) –
    
    The timestamp when the key pair was created (e.g., 1479816991.349).
  - location (dict) –
    
    The region name and Availability Zone where the key pair was created.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) –
      
      The Amazon Web Services Region name.
  - resourceType (string) –
    
    The resource type (usually KeyPair).
  - tags (list) –
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    - (dict) –
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      - key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) –
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - fingerprint (string) –
    
    The RSA fingerprint of the key pair.
- publicKeyBase64 (string) –
  
  A base64-encoded public key of the ssh-rsa type.
- privateKeyBase64 (string) –
  
  A base64-encoded RSA private key.
- operation (dict) –
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - id (string) –
    
    The ID of the operation.
  - resourceName (string) –
    
    The resource name.
  - resourceType (string) –
    
    The resource type.
  - createdAt (datetime) –
    
    The timestamp when the operation was initialized (e.g., 1479816991.349).
  - location (dict) –
    
    The Amazon Web Services Region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) –
      
      The Amazon Web Services Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Ohio-1).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.AccountSetupInProgressException
Lightsail.Client.exceptions.UnauthenticatedException