api_op_GetRelationalDatabaseBlueprints.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 // Returns a list of available database blueprints in Amazon Lightsail. A
15 // blueprint describes the major engine version of a database.
16 //
17 // You can use a blueprint ID to create a new database that runs a specific
18 // database engine.
19 func (c *Client) GetRelationalDatabaseBlueprints(ctx context.Context, params *GetRelationalDatabaseBlueprintsInput, optFns ...func(*Options)) (*GetRelationalDatabaseBlueprintsOutput, error) {
20 if params == nil {
21 params = &GetRelationalDatabaseBlueprintsInput{}
22 }
23
24 result, metadata, err := c.invokeOperation(ctx, "GetRelationalDatabaseBlueprints", params, optFns, c.addOperationGetRelationalDatabaseBlueprintsMiddlewares)
25 if err != nil {
26 return nil, err
27 }
28
29 out := result.(*GetRelationalDatabaseBlueprintsOutput)
30 out.ResultMetadata = metadata
31 return out, nil
32 }
33
34 type GetRelationalDatabaseBlueprintsInput struct {
35
36 // The token to advance to the next page of results from your request.
37 //
38 // To get a page token, perform an initial GetRelationalDatabaseBlueprints
39 // request. If your results are paginated, the response will return a next page
40 // token that you can specify as the page token in a subsequent request.
41 PageToken *string
42
43 noSmithyDocumentSerde
44 }
45
46 type GetRelationalDatabaseBlueprintsOutput struct {
47
48 // An object describing the result of your get relational database blueprints
49 // request.
50 Blueprints []types.RelationalDatabaseBlueprint
51
52 // The token to advance to the next page of results from your request.
53 //
54 // A next page token is not returned if there are no more results to display.
55 //
56 // To get the next page of results, perform another GetRelationalDatabaseBlueprints
57 // request and specify the next page token using the pageToken parameter.
58 NextPageToken *string
59
60 // Metadata pertaining to the operation's result.
61 ResultMetadata middleware.Metadata
62
63 noSmithyDocumentSerde
64 }
65
66 func (c *Client) addOperationGetRelationalDatabaseBlueprintsMiddlewares(stack *middleware.Stack, options Options) (err error) {
67 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
68 return err
69 }
70 err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetRelationalDatabaseBlueprints{}, middleware.After)
71 if err != nil {
72 return err
73 }
74 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRelationalDatabaseBlueprints{}, middleware.After)
75 if err != nil {
76 return err
77 }
78 if err := addProtocolFinalizerMiddlewares(stack, options, "GetRelationalDatabaseBlueprints"); err != nil {
79 return fmt.Errorf("add protocol finalizers: %v", err)
80 }
81
82 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
83 return err
84 }
85 if err = addSetLoggerMiddleware(stack, options); err != nil {
86 return err
87 }
88 if err = addClientRequestID(stack); err != nil {
89 return err
90 }
91 if err = addComputeContentLength(stack); err != nil {
92 return err
93 }
94 if err = addResolveEndpointMiddleware(stack, options); err != nil {
95 return err
96 }
97 if err = addComputePayloadSHA256(stack); err != nil {
98 return err
99 }
100 if err = addRetry(stack, options); err != nil {
101 return err
102 }
103 if err = addRawResponseToMetadata(stack); err != nil {
104 return err
105 }
106 if err = addRecordResponseTiming(stack); err != nil {
107 return err
108 }
109 if err = addSpanRetryLoop(stack, options); err != nil {
110 return err
111 }
112 if err = addClientUserAgent(stack, options); err != nil {
113 return err
114 }
115 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
116 return err
117 }
118 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
119 return err
120 }
121 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
122 return err
123 }
124 if err = addTimeOffsetBuild(stack, c); err != nil {
125 return err
126 }
127 if err = addUserAgentRetryMode(stack, options); err != nil {
128 return err
129 }
130 if err = addCredentialSource(stack, options); err != nil {
131 return err
132 }
133 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRelationalDatabaseBlueprints(options.Region), middleware.Before); err != nil {
134 return err
135 }
136 if err = addRecursionDetection(stack); err != nil {
137 return err
138 }
139 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
140 return err
141 }
142 if err = addResponseErrorMiddleware(stack); err != nil {
143 return err
144 }
145 if err = addRequestResponseLogging(stack, options); err != nil {
146 return err
147 }
148 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
149 return err
150 }
151 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
152 return err
153 }
154 if err = addInterceptAttempt(stack, options); err != nil {
155 return err
156 }
157 if err = addInterceptors(stack, options); err != nil {
158 return err
159 }
160 return nil
161 }
162
163 func newServiceMetadataMiddleware_opGetRelationalDatabaseBlueprints(region string) *awsmiddleware.RegisterServiceMetadata {
164 return &awsmiddleware.RegisterServiceMetadata{
165 Region: region,
166 ServiceID: ServiceID,
167 OperationName: "GetRelationalDatabaseBlueprints",
168 }
169 }
170