Skip to content
AWS for Query.Farm

aws.lightsail.get_key_pair

Example SQL Queries

SELECT * FROM
aws.lightsail.get_key_pair
WHERE
"key_pair_name" = 'VALUE';

Description

Returns information about a specific key pair.

Table Definition

Column NameColumn Data Type
key_pair_name Required Input Column

The name of the key pair for which you are requesting information.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
key_pair

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

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR,
    "support_code" VARCHAR,
    "created_at" TIMESTAMP_S,
    "location" STRUCT(
        "availability_zone" VARCHAR,
        "region_name" VARCHAR
    ),
    "resource_type" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "fingerprint" VARCHAR
)
Show child fields
key_pair.arn

The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

key_pair.created_at

The timestamp when the key pair was created (1479816991.349).

key_pair.fingerprint

The RSA fingerprint of the key pair.

key_pair.location

The region name and Availability Zone where the key pair was created.

Show child fields
key_pair.location.availability_zone

The Availability Zone. Follows the format us-east-2a (case-sensitive).

key_pair.location.region_name

The Amazon Web Services Region name.

key_pair.name

The friendly name of the SSH key pair.

key_pair.resource_type

The resource type (usually KeyPair).

key_pair.support_code

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.

key_pair.tags[]
Show child fields
key_pair.tags[].key

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@

key_pair.tags[].value

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@