api_op_DeleteDisk.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 block storage disk. The disk must be in the available
15 // state (not attached to a Lightsail instance).
16 //
17 // The disk may remain in the deleting state for several minutes.
18 //
19 // The delete disk operation supports tag-based access control via resource tags
20 // applied to the resource identified by disk name . For more information, see the [Amazon Lightsail Developer Guide]
21 // .
22 //
23 // [Amazon Lightsail Developer Guide]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags
24 func (c *Client) DeleteDisk(ctx context.Context, params *DeleteDiskInput, optFns ...func(*Options)) (*DeleteDiskOutput, error) {
25 if params == nil {
26 params = &DeleteDiskInput{}
27 }
28
29 result, metadata, err := c.invokeOperation(ctx, "DeleteDisk", params, optFns, c.addOperationDeleteDiskMiddlewares)
30 if err != nil {
31 return nil, err
32 }
33
34 out := result.(*DeleteDiskOutput)
35 out.ResultMetadata = metadata
36 return out, nil
37 }
38
39 type DeleteDiskInput struct {
40
41 // The unique name of the disk you want to delete ( my-disk ).
42 //
43 // This member is required.
44 DiskName *string
45
46 // A Boolean value to indicate whether to delete all add-ons for the disk.
47 ForceDeleteAddOns *bool
48
49 noSmithyDocumentSerde
50 }
51
52 type DeleteDiskOutput struct {
53
54 // An array of objects that describe the result of the action, such as the status
55 // of the request, the timestamp of the request, and the resources affected by the
56 // request.
57 Operations []types.Operation
58
59 // Metadata pertaining to the operation's result.
60 ResultMetadata middleware.Metadata
61
62 noSmithyDocumentSerde
63 }
64
65 func (c *Client) addOperationDeleteDiskMiddlewares(stack *middleware.Stack, options Options) (err error) {
66 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
67 return err
68 }
69 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteDisk{}, middleware.After)
70 if err != nil {
71 return err
72 }
73 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteDisk{}, middleware.After)
74 if err != nil {
75 return err
76 }
77 if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteDisk"); err != nil {
78 return fmt.Errorf("add protocol finalizers: %v", err)
79 }
80
81 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
82 return err
83 }
84 if err = addSetLoggerMiddleware(stack, options); err != nil {
85 return err
86 }
87 if err = addClientRequestID(stack); err != nil {
88 return err
89 }
90 if err = addComputeContentLength(stack); err != nil {
91 return err
92 }
93 if err = addResolveEndpointMiddleware(stack, options); err != nil {
94 return err
95 }
96 if err = addComputePayloadSHA256(stack); err != nil {
97 return err
98 }
99 if err = addRetry(stack, options); err != nil {
100 return err
101 }
102 if err = addRawResponseToMetadata(stack); err != nil {
103 return err
104 }
105 if err = addRecordResponseTiming(stack); err != nil {
106 return err
107 }
108 if err = addSpanRetryLoop(stack, options); err != nil {
109 return err
110 }
111 if err = addClientUserAgent(stack, options); err != nil {
112 return err
113 }
114 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
115 return err
116 }
117 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
118 return err
119 }
120 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
121 return err
122 }
123 if err = addTimeOffsetBuild(stack, c); err != nil {
124 return err
125 }
126 if err = addUserAgentRetryMode(stack, options); err != nil {
127 return err
128 }
129 if err = addCredentialSource(stack, options); err != nil {
130 return err
131 }
132 if err = addOpDeleteDiskValidationMiddleware(stack); err != nil {
133 return err
134 }
135 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteDisk(options.Region), middleware.Before); err != nil {
136 return err
137 }
138 if err = addRecursionDetection(stack); err != nil {
139 return err
140 }
141 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
142 return err
143 }
144 if err = addResponseErrorMiddleware(stack); err != nil {
145 return err
146 }
147 if err = addRequestResponseLogging(stack, options); err != nil {
148 return err
149 }
150 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
151 return err
152 }
153 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
154 return err
155 }
156 if err = addInterceptAttempt(stack, options); err != nil {
157 return err
158 }
159 if err = addInterceptors(stack, options); err != nil {
160 return err
161 }
162 return nil
163 }
164
165 func newServiceMetadataMiddleware_opDeleteDisk(region string) *awsmiddleware.RegisterServiceMetadata {
166 return &awsmiddleware.RegisterServiceMetadata{
167 Region: region,
168 ServiceID: ServiceID,
169 OperationName: "DeleteDisk",
170 }
171 }
172