Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeKeyPairs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

Synopsis

data DescribeKeyPairs = DescribeKeyPairs' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- includePublicKey :: Maybe Bool
- keyNames :: Maybe [Text]
- keyPairIds :: Maybe [Text]
}
newDescribeKeyPairs :: DescribeKeyPairs
describeKeyPairs_dryRun :: Lens' DescribeKeyPairs (Maybe Bool)
describeKeyPairs_filters :: Lens' DescribeKeyPairs (Maybe [Filter])
describeKeyPairs_includePublicKey :: Lens' DescribeKeyPairs (Maybe Bool)
describeKeyPairs_keyNames :: Lens' DescribeKeyPairs (Maybe [Text])
describeKeyPairs_keyPairIds :: Lens' DescribeKeyPairs (Maybe [Text])
data DescribeKeyPairsResponse = DescribeKeyPairsResponse' {
- keyPairs :: Maybe [KeyPairInfo]
- httpStatus :: Int
}
newDescribeKeyPairsResponse :: Int -> DescribeKeyPairsResponse
describeKeyPairsResponse_keyPairs :: Lens' DescribeKeyPairsResponse (Maybe [KeyPairInfo])
describeKeyPairsResponse_httpStatus :: Lens' DescribeKeyPairsResponse Int

Creating a Request

data DescribeKeyPairs Source #

See: newDescribeKeyPairs smart constructor.

Constructors

DescribeKeyPairs'

Fields

dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters :: Maybe [Filter]
The filters.
- key-pair-id - The ID of the key pair.
- fingerprint - The fingerprint of the key pair.
- key-name - The name of the key pair.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
includePublicKey :: Maybe Bool
If true, the public key material is included in the response.
Default: false
keyNames :: Maybe [Text]
The key pair names.
Default: Describes all of your key pairs.
keyPairIds :: Maybe [Text]
The IDs of the key pairs.

Instances

Instances details

ToHeaders DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods toHeaders :: DescribeKeyPairs -> [Header] #
ToPath DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods toPath :: DescribeKeyPairs -> ByteString #
ToQuery DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods toQuery :: DescribeKeyPairs -> QueryString #
AWSRequest DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Associated Types type AWSResponse DescribeKeyPairs # Methods request :: (Service -> Service) -> DescribeKeyPairs -> Request DescribeKeyPairs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeKeyPairs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeKeyPairs))) #
Generic DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Associated Types type Rep DescribeKeyPairs :: Type -> Type # Methods from :: DescribeKeyPairs -> Rep DescribeKeyPairs x # to :: Rep DescribeKeyPairs x -> DescribeKeyPairs #
Read DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods readsPrec :: Int -> ReadS DescribeKeyPairs # readList :: ReadS [DescribeKeyPairs] # readPrec :: ReadPrec DescribeKeyPairs # readListPrec :: ReadPrec [DescribeKeyPairs] #
Show DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods showsPrec :: Int -> DescribeKeyPairs -> ShowS # show :: DescribeKeyPairs -> String # showList :: [DescribeKeyPairs] -> ShowS #
NFData DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods rnf :: DescribeKeyPairs -> () #
Eq DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods (==) :: DescribeKeyPairs -> DescribeKeyPairs -> Bool # (/=) :: DescribeKeyPairs -> DescribeKeyPairs -> Bool #
Hashable DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods hashWithSalt :: Int -> DescribeKeyPairs -> Int # hash :: DescribeKeyPairs -> Int #
type AWSResponse DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs type AWSResponse DescribeKeyPairs = DescribeKeyPairsResponse
type Rep DescribeKeyPairs Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs type Rep DescribeKeyPairs = D1 ('MetaData "DescribeKeyPairs" "Amazonka.EC2.DescribeKeyPairs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeKeyPairs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "includePublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "keyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "keyPairIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeKeyPairs :: DescribeKeyPairs Source #

Create a value of DescribeKeyPairs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeKeyPairs', describeKeyPairs_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:filters:DescribeKeyPairs', describeKeyPairs_filters - The filters.

key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

$sel:includePublicKey:DescribeKeyPairs', describeKeyPairs_includePublicKey - If true, the public key material is included in the response.

Default: false

$sel:keyNames:DescribeKeyPairs', describeKeyPairs_keyNames - The key pair names.

Default: Describes all of your key pairs.

$sel:keyPairIds:DescribeKeyPairs', describeKeyPairs_keyPairIds - The IDs of the key pairs.

Request Lenses

describeKeyPairs_dryRun :: Lens' DescribeKeyPairs (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describeKeyPairs_filters :: Lens' DescribeKeyPairs (Maybe [Filter]) Source #

The filters.

key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

describeKeyPairs_includePublicKey :: Lens' DescribeKeyPairs (Maybe Bool) Source #

If true, the public key material is included in the response.

Default: false

describeKeyPairs_keyNames :: Lens' DescribeKeyPairs (Maybe [Text]) Source #

The key pair names.

Default: Describes all of your key pairs.

describeKeyPairs_keyPairIds :: Lens' DescribeKeyPairs (Maybe [Text]) Source #

The IDs of the key pairs.

Destructuring the Response

data DescribeKeyPairsResponse Source #

See: newDescribeKeyPairsResponse smart constructor.

Constructors

DescribeKeyPairsResponse'
Fields keyPairs :: Maybe [KeyPairInfo] Information about the key pairs. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeKeyPairsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Associated Types type Rep DescribeKeyPairsResponse :: Type -> Type # Methods from :: DescribeKeyPairsResponse -> Rep DescribeKeyPairsResponse x # to :: Rep DescribeKeyPairsResponse x -> DescribeKeyPairsResponse #
Read DescribeKeyPairsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods readsPrec :: Int -> ReadS DescribeKeyPairsResponse # readList :: ReadS [DescribeKeyPairsResponse] # readPrec :: ReadPrec DescribeKeyPairsResponse # readListPrec :: ReadPrec [DescribeKeyPairsResponse] #
Show DescribeKeyPairsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods showsPrec :: Int -> DescribeKeyPairsResponse -> ShowS # show :: DescribeKeyPairsResponse -> String # showList :: [DescribeKeyPairsResponse] -> ShowS #
NFData DescribeKeyPairsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods rnf :: DescribeKeyPairsResponse -> () #
Eq DescribeKeyPairsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs Methods (==) :: DescribeKeyPairsResponse -> DescribeKeyPairsResponse -> Bool # (/=) :: DescribeKeyPairsResponse -> DescribeKeyPairsResponse -> Bool #
type Rep DescribeKeyPairsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeKeyPairs type Rep DescribeKeyPairsResponse = D1 ('MetaData "DescribeKeyPairsResponse" "Amazonka.EC2.DescribeKeyPairs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeKeyPairsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPairs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyPairInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeKeyPairsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeKeyPairsResponse'`
-> DescribeKeyPairsResponse

Create a value of DescribeKeyPairsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPairs:DescribeKeyPairsResponse', describeKeyPairsResponse_keyPairs - Information about the key pairs.

$sel:httpStatus:DescribeKeyPairsResponse', describeKeyPairsResponse_httpStatus - The response's http status code.

Response Lenses

describeKeyPairsResponse_keyPairs :: Lens' DescribeKeyPairsResponse (Maybe [KeyPairInfo]) Source #

Information about the key pairs.

describeKeyPairsResponse_httpStatus :: Lens' DescribeKeyPairsResponse Int Source #

The response's http status code.