api_op_UpdateBucketBundle.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 // Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
15 //
16 // A bucket bundle specifies the monthly cost, storage space, and data transfer
17 // quota for a bucket. You can update a bucket's bundle only one time within a
18 // monthly Amazon Web Services billing cycle. To determine if you can update a
19 // bucket's bundle, use the [GetBuckets]action. The ableToUpdateBundle parameter in the
20 // response will indicate whether you can currently update a bucket's bundle.
21 //
22 // Update a bucket's bundle if it's consistently going over its storage space or
23 // data transfer quota, or if a bucket's usage is consistently in the lower range
24 // of its storage space or data transfer quota. Due to the unpredictable usage
25 // fluctuations that a bucket might experience, we strongly recommend that you
26 // update a bucket's bundle only as a long-term strategy, instead of as a
27 // short-term, monthly cost-cutting measure. Choose a bucket bundle that will
28 // provide the bucket with ample storage space and data transfer for a long time to
29 // come.
30 //
31 // [GetBuckets]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html
32 func (c *Client) UpdateBucketBundle(ctx context.Context, params *UpdateBucketBundleInput, optFns ...func(*Options)) (*UpdateBucketBundleOutput, error) {
33 if params == nil {
34 params = &UpdateBucketBundleInput{}
35 }
36
37 result, metadata, err := c.invokeOperation(ctx, "UpdateBucketBundle", params, optFns, c.addOperationUpdateBucketBundleMiddlewares)
38 if err != nil {
39 return nil, err
40 }
41
42 out := result.(*UpdateBucketBundleOutput)
43 out.ResultMetadata = metadata
44 return out, nil
45 }
46
47 type UpdateBucketBundleInput struct {
48
49 // The name of the bucket for which to update the bundle.
50 //
51 // This member is required.
52 BucketName *string
53
54 // The ID of the new bundle to apply to the bucket.
55 //
56 // Use the [GetBucketBundles] action to get a list of bundle IDs that you can specify.
57 //
58 // [GetBucketBundles]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html
59 //
60 // This member is required.
61 BundleId *string
62
63 noSmithyDocumentSerde
64 }
65
66 type UpdateBucketBundleOutput struct {
67
68 // An array of objects that describe the result of the action, such as the status
69 // of the request, the timestamp of the request, and the resources affected by the
70 // request.
71 Operations []types.Operation
72
73 // Metadata pertaining to the operation's result.
74 ResultMetadata middleware.Metadata
75
76 noSmithyDocumentSerde
77 }
78
79 func (c *Client) addOperationUpdateBucketBundleMiddlewares(stack *middleware.Stack, options Options) (err error) {
80 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
81 return err
82 }
83 err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateBucketBundle{}, middleware.After)
84 if err != nil {
85 return err
86 }
87 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateBucketBundle{}, middleware.After)
88 if err != nil {
89 return err
90 }
91 if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateBucketBundle"); err != nil {
92 return fmt.Errorf("add protocol finalizers: %v", err)
93 }
94
95 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
96 return err
97 }
98 if err = addSetLoggerMiddleware(stack, options); err != nil {
99 return err
100 }
101 if err = addClientRequestID(stack); err != nil {
102 return err
103 }
104 if err = addComputeContentLength(stack); err != nil {
105 return err
106 }
107 if err = addResolveEndpointMiddleware(stack, options); err != nil {
108 return err
109 }
110 if err = addComputePayloadSHA256(stack); err != nil {
111 return err
112 }
113 if err = addRetry(stack, options); err != nil {
114 return err
115 }
116 if err = addRawResponseToMetadata(stack); err != nil {
117 return err
118 }
119 if err = addRecordResponseTiming(stack); err != nil {
120 return err
121 }
122 if err = addSpanRetryLoop(stack, options); err != nil {
123 return err
124 }
125 if err = addClientUserAgent(stack, options); err != nil {
126 return err
127 }
128 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
129 return err
130 }
131 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
132 return err
133 }
134 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
135 return err
136 }
137 if err = addTimeOffsetBuild(stack, c); err != nil {
138 return err
139 }
140 if err = addUserAgentRetryMode(stack, options); err != nil {
141 return err
142 }
143 if err = addCredentialSource(stack, options); err != nil {
144 return err
145 }
146 if err = addOpUpdateBucketBundleValidationMiddleware(stack); err != nil {
147 return err
148 }
149 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateBucketBundle(options.Region), middleware.Before); err != nil {
150 return err
151 }
152 if err = addRecursionDetection(stack); err != nil {
153 return err
154 }
155 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
156 return err
157 }
158 if err = addResponseErrorMiddleware(stack); err != nil {
159 return err
160 }
161 if err = addRequestResponseLogging(stack, options); err != nil {
162 return err
163 }
164 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
165 return err
166 }
167 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
168 return err
169 }
170 if err = addInterceptAttempt(stack, options); err != nil {
171 return err
172 }
173 if err = addInterceptors(stack, options); err != nil {
174 return err
175 }
176 return nil
177 }
178
179 func newServiceMetadataMiddleware_opUpdateBucketBundle(region string) *awsmiddleware.RegisterServiceMetadata {
180 return &awsmiddleware.RegisterServiceMetadata{
181 Region: region,
182 ServiceID: ServiceID,
183 OperationName: "UpdateBucketBundle",
184 }
185 }
186