api_op_GetRelationalDatabaseParameters.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 all of the runtime parameters offered by the underlying database
15 // software, or engine, for a specific database in Amazon Lightsail.
16 //
17 // In addition to the parameter names and values, this operation returns other
18 // information about each parameter. This information includes whether changes
19 // require a reboot, whether the parameter is modifiable, the allowed values, and
20 // the data types.
21 func (c *Client) GetRelationalDatabaseParameters(ctx context.Context, params *GetRelationalDatabaseParametersInput, optFns ...func(*Options)) (*GetRelationalDatabaseParametersOutput, error) {
22 if params == nil {
23 params = &GetRelationalDatabaseParametersInput{}
24 }
25
26 result, metadata, err := c.invokeOperation(ctx, "GetRelationalDatabaseParameters", params, optFns, c.addOperationGetRelationalDatabaseParametersMiddlewares)
27 if err != nil {
28 return nil, err
29 }
30
31 out := result.(*GetRelationalDatabaseParametersOutput)
32 out.ResultMetadata = metadata
33 return out, nil
34 }
35
36 type GetRelationalDatabaseParametersInput struct {
37
38 // The name of your database for which to get parameters.
39 //
40 // This member is required.
41 RelationalDatabaseName *string
42
43 // The token to advance to the next page of results from your request.
44 //
45 // To get a page token, perform an initial GetRelationalDatabaseParameters
46 // request. If your results are paginated, the response will return a next page
47 // token that you can specify as the page token in a subsequent request.
48 PageToken *string
49
50 noSmithyDocumentSerde
51 }
52
53 type GetRelationalDatabaseParametersOutput struct {
54
55 // The token to advance to the next page of results from your request.
56 //
57 // A next page token is not returned if there are no more results to display.
58 //
59 // To get the next page of results, perform another GetRelationalDatabaseParameters
60 // request and specify the next page token using the pageToken parameter.
61 NextPageToken *string
62
63 // An object describing the result of your get relational database parameters
64 // request.
65 Parameters []types.RelationalDatabaseParameter
66
67 // Metadata pertaining to the operation's result.
68 ResultMetadata middleware.Metadata
69
70 noSmithyDocumentSerde
71 }
72
73 func (c *Client) addOperationGetRelationalDatabaseParametersMiddlewares(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_serializeOpGetRelationalDatabaseParameters{}, middleware.After)
78 if err != nil {
79 return err
80 }
81 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRelationalDatabaseParameters{}, middleware.After)
82 if err != nil {
83 return err
84 }
85 if err := addProtocolFinalizerMiddlewares(stack, options, "GetRelationalDatabaseParameters"); 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 = addOpGetRelationalDatabaseParametersValidationMiddleware(stack); err != nil {
141 return err
142 }
143 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRelationalDatabaseParameters(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_opGetRelationalDatabaseParameters(region string) *awsmiddleware.RegisterServiceMetadata {
174 return &awsmiddleware.RegisterServiceMetadata{
175 Region: region,
176 ServiceID: ServiceID,
177 OperationName: "GetRelationalDatabaseParameters",
178 }
179 }
180