api_op_GetRelationalDatabaseLogEvents.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 "time"
13 )
14
15 // Returns a list of log events for a database in Amazon Lightsail.
16 func (c *Client) GetRelationalDatabaseLogEvents(ctx context.Context, params *GetRelationalDatabaseLogEventsInput, optFns ...func(*Options)) (*GetRelationalDatabaseLogEventsOutput, error) {
17 if params == nil {
18 params = &GetRelationalDatabaseLogEventsInput{}
19 }
20
21 result, metadata, err := c.invokeOperation(ctx, "GetRelationalDatabaseLogEvents", params, optFns, c.addOperationGetRelationalDatabaseLogEventsMiddlewares)
22 if err != nil {
23 return nil, err
24 }
25
26 out := result.(*GetRelationalDatabaseLogEventsOutput)
27 out.ResultMetadata = metadata
28 return out, nil
29 }
30
31 type GetRelationalDatabaseLogEventsInput struct {
32
33 // The name of the log stream.
34 //
35 // Use the get relational database log streams operation to get a list of
36 // available log streams.
37 //
38 // This member is required.
39 LogStreamName *string
40
41 // The name of your database for which to get log events.
42 //
43 // This member is required.
44 RelationalDatabaseName *string
45
46 // The end of the time interval from which to get log events.
47 //
48 // Constraints:
49 //
50 // - Specified in Coordinated Universal Time (UTC).
51 //
52 // - Specified in the Unix time format.
53 //
54 // For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC,
55 // then you input 1538424000 as the end time.
56 EndTime *time.Time
57
58 // The token to advance to the next or previous page of results from your request.
59 //
60 // To get a page token, perform an initial GetRelationalDatabaseLogEvents request.
61 // If your results are paginated, the response will return a next forward token
62 // and/or next backward token that you can specify as the page token in a
63 // subsequent request.
64 PageToken *string
65
66 // Parameter to specify if the log should start from head or tail. If true is
67 // specified, the log event starts from the head of the log. If false is
68 // specified, the log event starts from the tail of the log.
69 //
70 // For PostgreSQL, the default value of false is the only option available.
71 StartFromHead *bool
72
73 // The start of the time interval from which to get log events.
74 //
75 // Constraints:
76 //
77 // - Specified in Coordinated Universal Time (UTC).
78 //
79 // - Specified in the Unix time format.
80 //
81 // For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC,
82 // then you input 1538424000 as the start time.
83 StartTime *time.Time
84
85 noSmithyDocumentSerde
86 }
87
88 type GetRelationalDatabaseLogEventsOutput struct {
89
90 // A token used for advancing to the previous page of results from your get
91 // relational database log events request.
92 NextBackwardToken *string
93
94 // A token used for advancing to the next page of results from your get relational
95 // database log events request.
96 NextForwardToken *string
97
98 // An object describing the result of your get relational database log events
99 // request.
100 ResourceLogEvents []types.LogEvent
101
102 // Metadata pertaining to the operation's result.
103 ResultMetadata middleware.Metadata
104
105 noSmithyDocumentSerde
106 }
107
108 func (c *Client) addOperationGetRelationalDatabaseLogEventsMiddlewares(stack *middleware.Stack, options Options) (err error) {
109 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
110 return err
111 }
112 err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetRelationalDatabaseLogEvents{}, middleware.After)
113 if err != nil {
114 return err
115 }
116 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRelationalDatabaseLogEvents{}, middleware.After)
117 if err != nil {
118 return err
119 }
120 if err := addProtocolFinalizerMiddlewares(stack, options, "GetRelationalDatabaseLogEvents"); err != nil {
121 return fmt.Errorf("add protocol finalizers: %v", err)
122 }
123
124 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
125 return err
126 }
127 if err = addSetLoggerMiddleware(stack, options); err != nil {
128 return err
129 }
130 if err = addClientRequestID(stack); err != nil {
131 return err
132 }
133 if err = addComputeContentLength(stack); err != nil {
134 return err
135 }
136 if err = addResolveEndpointMiddleware(stack, options); err != nil {
137 return err
138 }
139 if err = addComputePayloadSHA256(stack); err != nil {
140 return err
141 }
142 if err = addRetry(stack, options); err != nil {
143 return err
144 }
145 if err = addRawResponseToMetadata(stack); err != nil {
146 return err
147 }
148 if err = addRecordResponseTiming(stack); err != nil {
149 return err
150 }
151 if err = addSpanRetryLoop(stack, options); err != nil {
152 return err
153 }
154 if err = addClientUserAgent(stack, options); err != nil {
155 return err
156 }
157 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
158 return err
159 }
160 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
161 return err
162 }
163 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
164 return err
165 }
166 if err = addTimeOffsetBuild(stack, c); err != nil {
167 return err
168 }
169 if err = addUserAgentRetryMode(stack, options); err != nil {
170 return err
171 }
172 if err = addCredentialSource(stack, options); err != nil {
173 return err
174 }
175 if err = addOpGetRelationalDatabaseLogEventsValidationMiddleware(stack); err != nil {
176 return err
177 }
178 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRelationalDatabaseLogEvents(options.Region), middleware.Before); err != nil {
179 return err
180 }
181 if err = addRecursionDetection(stack); err != nil {
182 return err
183 }
184 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
185 return err
186 }
187 if err = addResponseErrorMiddleware(stack); err != nil {
188 return err
189 }
190 if err = addRequestResponseLogging(stack, options); err != nil {
191 return err
192 }
193 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
194 return err
195 }
196 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
197 return err
198 }
199 if err = addInterceptAttempt(stack, options); err != nil {
200 return err
201 }
202 if err = addInterceptors(stack, options); err != nil {
203 return err
204 }
205 return nil
206 }
207
208 func newServiceMetadataMiddleware_opGetRelationalDatabaseLogEvents(region string) *awsmiddleware.RegisterServiceMetadata {
209 return &awsmiddleware.RegisterServiceMetadata{
210 Region: region,
211 ServiceID: ServiceID,
212 OperationName: "GetRelationalDatabaseLogEvents",
213 }
214 }
215