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 |
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' {}
- 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.
DescribeKeyPairs' | |
|
Instances
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
DescribeKeyPairsResponse' | |
|
Instances
newDescribeKeyPairsResponse Source #
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.