api_op_DeleteBucket.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 a Amazon Lightsail bucket.
15 //
16 // When you delete your bucket, the bucket name is released and can be reused for
17 // a new bucket in your account or another Amazon Web Services account.
18 func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error) {
19 if params == nil {
20 params = &DeleteBucketInput{}
21 }
22
23 result, metadata, err := c.invokeOperation(ctx, "DeleteBucket", params, optFns, c.addOperationDeleteBucketMiddlewares)
24 if err != nil {
25 return nil, err
26 }
27
28 out := result.(*DeleteBucketOutput)
29 out.ResultMetadata = metadata
30 return out, nil
31 }
32
33 type DeleteBucketInput struct {
34
35 // The name of the bucket to delete.
36 //
37 // Use the [GetBuckets] action to get a list of bucket names that you can specify.
38 //
39 // [GetBuckets]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html
40 //
41 // This member is required.
42 BucketName *string
43
44 // A Boolean value that indicates whether to force delete the bucket.
45 //
46 // You must force delete the bucket if it has one of the following conditions:
47 //
48 // - The bucket is the origin of a distribution.
49 //
50 // - The bucket has instances that were granted access to it using the [SetResourceAccessForBucket]action.
51 //
52 // - The bucket has objects.
53 //
54 // - The bucket has access keys.
55 //
56 // Force deleting a bucket might impact other resources that rely on the bucket,
57 // such as instances, distributions, or software that use the issued access keys.
58 //
59 // [SetResourceAccessForBucket]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html
60 ForceDelete *bool
61
62 noSmithyDocumentSerde
63 }
64
65 type DeleteBucketOutput struct {
66
67 // An array of objects that describe the result of the action, such as the status
68 // of the request, the timestamp of the request, and the resources affected by the
69 // request.
70 Operations []types.Operation
71
72 // Metadata pertaining to the operation's result.
73 ResultMetadata middleware.Metadata
74
75 noSmithyDocumentSerde
76 }
77
78 func (c *Client) addOperationDeleteBucketMiddlewares(stack *middleware.Stack, options Options) (err error) {
79 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
80 return err
81 }
82 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteBucket{}, middleware.After)
83 if err != nil {
84 return err
85 }
86 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteBucket{}, middleware.After)
87 if err != nil {
88 return err
89 }
90 if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteBucket"); err != nil {
91 return fmt.Errorf("add protocol finalizers: %v", err)
92 }
93
94 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
95 return err
96 }
97 if err = addSetLoggerMiddleware(stack, options); err != nil {
98 return err
99 }
100 if err = addClientRequestID(stack); err != nil {
101 return err
102 }
103 if err = addComputeContentLength(stack); err != nil {
104 return err
105 }
106 if err = addResolveEndpointMiddleware(stack, options); err != nil {
107 return err
108 }
109 if err = addComputePayloadSHA256(stack); err != nil {
110 return err
111 }
112 if err = addRetry(stack, options); err != nil {
113 return err
114 }
115 if err = addRawResponseToMetadata(stack); err != nil {
116 return err
117 }
118 if err = addRecordResponseTiming(stack); err != nil {
119 return err
120 }
121 if err = addSpanRetryLoop(stack, options); err != nil {
122 return err
123 }
124 if err = addClientUserAgent(stack, options); err != nil {
125 return err
126 }
127 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
128 return err
129 }
130 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
131 return err
132 }
133 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
134 return err
135 }
136 if err = addTimeOffsetBuild(stack, c); err != nil {
137 return err
138 }
139 if err = addUserAgentRetryMode(stack, options); err != nil {
140 return err
141 }
142 if err = addCredentialSource(stack, options); err != nil {
143 return err
144 }
145 if err = addOpDeleteBucketValidationMiddleware(stack); err != nil {
146 return err
147 }
148 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteBucket(options.Region), middleware.Before); err != nil {
149 return err
150 }
151 if err = addRecursionDetection(stack); err != nil {
152 return err
153 }
154 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
155 return err
156 }
157 if err = addResponseErrorMiddleware(stack); err != nil {
158 return err
159 }
160 if err = addRequestResponseLogging(stack, options); err != nil {
161 return err
162 }
163 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
164 return err
165 }
166 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
167 return err
168 }
169 if err = addInterceptAttempt(stack, options); err != nil {
170 return err
171 }
172 if err = addInterceptors(stack, options); err != nil {
173 return err
174 }
175 return nil
176 }
177
178 func newServiceMetadataMiddleware_opDeleteBucket(region string) *awsmiddleware.RegisterServiceMetadata {
179 return &awsmiddleware.RegisterServiceMetadata{
180 Region: region,
181 ServiceID: ServiceID,
182 OperationName: "DeleteBucket",
183 }
184 }
185