api_op_DeleteKeyPair.go raw
1 // Code generated by smithy-go-codegen DO NOT EDIT.
2
3 package lightsail
4
5 import (
6 "context"
7 "fmt"
8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9 "github.com/aws/aws-sdk-go-v2/service/lightsail/types"
10 "github.com/aws/smithy-go/middleware"
11 smithyhttp "github.com/aws/smithy-go/transport/http"
12 )
13
14 // Deletes the specified key pair by removing the public key from Amazon Lightsail.
15 //
16 // You can delete key pairs that were created using the [ImportKeyPair] and [CreateKeyPair] actions, as well as
17 // the Lightsail default key pair. A new default key pair will not be created
18 // unless you launch an instance without specifying a custom key pair, or you call
19 // the [DownloadDefaultKeyPair]API.
20 //
21 // The delete key pair operation supports tag-based access control via resource
22 // tags applied to the resource identified by key pair name . For more information,
23 // see the [Amazon Lightsail Developer Guide].
24 //
25 // [ImportKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html
26 // [CreateKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html
27 // [DownloadDefaultKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html
28 // [Amazon Lightsail Developer Guide]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags
29 func (c *Client) DeleteKeyPair(ctx context.Context, params *DeleteKeyPairInput, optFns ...func(*Options)) (*DeleteKeyPairOutput, error) {
30 if params == nil {
31 params = &DeleteKeyPairInput{}
32 }
33
34 result, metadata, err := c.invokeOperation(ctx, "DeleteKeyPair", params, optFns, c.addOperationDeleteKeyPairMiddlewares)
35 if err != nil {
36 return nil, err
37 }
38
39 out := result.(*DeleteKeyPairOutput)
40 out.ResultMetadata = metadata
41 return out, nil
42 }
43
44 type DeleteKeyPairInput struct {
45
46 // The name of the key pair to delete.
47 //
48 // This member is required.
49 KeyPairName *string
50
51 // The RSA fingerprint of the Lightsail default key pair to delete.
52 //
53 // The expectedFingerprint parameter is required only when specifying to delete a
54 // Lightsail default key pair.
55 ExpectedFingerprint *string
56
57 noSmithyDocumentSerde
58 }
59
60 type DeleteKeyPairOutput struct {
61
62 // An array of objects that describe the result of the action, such as the status
63 // of the request, the timestamp of the request, and the resources affected by the
64 // request.
65 Operation *types.Operation
66
67 // Metadata pertaining to the operation's result.
68 ResultMetadata middleware.Metadata
69
70 noSmithyDocumentSerde
71 }
72
73 func (c *Client) addOperationDeleteKeyPairMiddlewares(stack *middleware.Stack, options Options) (err error) {
74 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
75 return err
76 }
77 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteKeyPair{}, middleware.After)
78 if err != nil {
79 return err
80 }
81 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteKeyPair{}, middleware.After)
82 if err != nil {
83 return err
84 }
85 if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteKeyPair"); err != nil {
86 return fmt.Errorf("add protocol finalizers: %v", err)
87 }
88
89 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
90 return err
91 }
92 if err = addSetLoggerMiddleware(stack, options); err != nil {
93 return err
94 }
95 if err = addClientRequestID(stack); err != nil {
96 return err
97 }
98 if err = addComputeContentLength(stack); err != nil {
99 return err
100 }
101 if err = addResolveEndpointMiddleware(stack, options); err != nil {
102 return err
103 }
104 if err = addComputePayloadSHA256(stack); err != nil {
105 return err
106 }
107 if err = addRetry(stack, options); err != nil {
108 return err
109 }
110 if err = addRawResponseToMetadata(stack); err != nil {
111 return err
112 }
113 if err = addRecordResponseTiming(stack); err != nil {
114 return err
115 }
116 if err = addSpanRetryLoop(stack, options); err != nil {
117 return err
118 }
119 if err = addClientUserAgent(stack, options); err != nil {
120 return err
121 }
122 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
123 return err
124 }
125 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
126 return err
127 }
128 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
129 return err
130 }
131 if err = addTimeOffsetBuild(stack, c); err != nil {
132 return err
133 }
134 if err = addUserAgentRetryMode(stack, options); err != nil {
135 return err
136 }
137 if err = addCredentialSource(stack, options); err != nil {
138 return err
139 }
140 if err = addOpDeleteKeyPairValidationMiddleware(stack); err != nil {
141 return err
142 }
143 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteKeyPair(options.Region), middleware.Before); err != nil {
144 return err
145 }
146 if err = addRecursionDetection(stack); err != nil {
147 return err
148 }
149 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
150 return err
151 }
152 if err = addResponseErrorMiddleware(stack); err != nil {
153 return err
154 }
155 if err = addRequestResponseLogging(stack, options); err != nil {
156 return err
157 }
158 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
159 return err
160 }
161 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
162 return err
163 }
164 if err = addInterceptAttempt(stack, options); err != nil {
165 return err
166 }
167 if err = addInterceptors(stack, options); err != nil {
168 return err
169 }
170 return nil
171 }
172
173 func newServiceMetadataMiddleware_opDeleteKeyPair(region string) *awsmiddleware.RegisterServiceMetadata {
174 return &awsmiddleware.RegisterServiceMetadata{
175 Region: region,
176 ServiceID: ServiceID,
177 OperationName: "DeleteKeyPair",
178 }
179 }
180