Lightsail / Client / get_key_pairs

get_key_pairs#

Lightsail.Client.get_key_pairs(**kwargs)#

Returns information about all key pairs in the user’s account.

See also: AWS API Documentation

Request Syntax

response = client.get_key_pairs(
    pageToken='string',
    includeDefaultKeyPair=True|False
)
Parameters:

  • pageToken (string) –

    The token to advance to the next page of results from your request.

    To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • includeDefaultKeyPair (boolean) – A Boolean value that indicates whether to include the default key pair in the response of your request.

Return type:

dict

Returns:

Response Syntax

{
    'keyPairs': [
        {
            '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'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

  • (dict) –

    • keyPairs (list) –

      An array of key-value pairs containing information about the key pairs.

      • (dict) –

        Describes an SSH key pair.

        • name (string) –

          The friendly name of the SSH key pair.

        • arn (string) –

          The Amazon Resource Name (ARN) of the key pair ( 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 ( 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.

    • nextPageToken (string) –

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.

Exceptions