1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package opsworkscm
4
5import (
6	"context"
7	"fmt"
8	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
10	"github.com/aws/aws-sdk-go-v2/service/opsworkscm/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Describes events for a specified server. Results are ordered by time, with
16// newest events first. This operation is synchronous. A ResourceNotFoundException
17// is thrown when the server does not exist. A ValidationException is raised when
18// parameters of the request are not valid.
19func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) {
20	if params == nil {
21		params = &DescribeEventsInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "DescribeEvents", params, optFns, addOperationDescribeEventsMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*DescribeEventsOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34type DescribeEventsInput struct {
35
36	// The name of the server for which you want to view events.
37	//
38	// This member is required.
39	ServerName *string
40
41	// To receive a paginated response, use this parameter to specify the maximum
42	// number of results to be returned with a single call. If the number of available
43	// results exceeds this maximum, the response includes a NextToken value that you
44	// can assign to the NextToken request parameter to get the next set of results.
45	MaxResults *int32
46
47	// NextToken is a string that is returned in some command responses. It indicates
48	// that not all entries have been returned, and that you must run at least one more
49	// request to get remaining items. To get remaining results, call DescribeEvents
50	// again, and assign the token from the previous results as the value of the
51	// nextToken parameter. If there are no more results, the response object's
52	// nextToken parameter value is null. Setting a nextToken value that was not
53	// returned in your previous results causes an InvalidNextTokenException to occur.
54	NextToken *string
55}
56
57type DescribeEventsOutput struct {
58
59	// NextToken is a string that is returned in some command responses. It indicates
60	// that not all entries have been returned, and that you must run at least one more
61	// request to get remaining items. To get remaining results, call DescribeEvents
62	// again, and assign the token from the previous results as the value of the
63	// nextToken parameter. If there are no more results, the response object's
64	// nextToken parameter value is null. Setting a nextToken value that was not
65	// returned in your previous results causes an InvalidNextTokenException to occur.
66	NextToken *string
67
68	// Contains the response to a DescribeEvents request.
69	ServerEvents []types.ServerEvent
70
71	// Metadata pertaining to the operation's result.
72	ResultMetadata middleware.Metadata
73}
74
75func addOperationDescribeEventsMiddlewares(stack *middleware.Stack, options Options) (err error) {
76	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeEvents{}, middleware.After)
77	if err != nil {
78		return err
79	}
80	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeEvents{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	if err = addSetLoggerMiddleware(stack, options); err != nil {
85		return err
86	}
87	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
88		return err
89	}
90	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
91		return err
92	}
93	if err = addResolveEndpointMiddleware(stack, options); err != nil {
94		return err
95	}
96	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
97		return err
98	}
99	if err = addRetryMiddlewares(stack, options); err != nil {
100		return err
101	}
102	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
109		return err
110	}
111	if err = addClientUserAgent(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addOpDescribeEventsValidationMiddleware(stack); err != nil {
121		return err
122	}
123	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeEvents(options.Region), middleware.Before); err != nil {
124		return err
125	}
126	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
127		return err
128	}
129	if err = addResponseErrorMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addRequestResponseLogging(stack, options); err != nil {
133		return err
134	}
135	return nil
136}
137
138// DescribeEventsAPIClient is a client that implements the DescribeEvents
139// operation.
140type DescribeEventsAPIClient interface {
141	DescribeEvents(context.Context, *DescribeEventsInput, ...func(*Options)) (*DescribeEventsOutput, error)
142}
143
144var _ DescribeEventsAPIClient = (*Client)(nil)
145
146// DescribeEventsPaginatorOptions is the paginator options for DescribeEvents
147type DescribeEventsPaginatorOptions struct {
148	// To receive a paginated response, use this parameter to specify the maximum
149	// number of results to be returned with a single call. If the number of available
150	// results exceeds this maximum, the response includes a NextToken value that you
151	// can assign to the NextToken request parameter to get the next set of results.
152	Limit int32
153
154	// Set to true if pagination should stop if the service returns a pagination token
155	// that matches the most recent token provided to the service.
156	StopOnDuplicateToken bool
157}
158
159// DescribeEventsPaginator is a paginator for DescribeEvents
160type DescribeEventsPaginator struct {
161	options   DescribeEventsPaginatorOptions
162	client    DescribeEventsAPIClient
163	params    *DescribeEventsInput
164	nextToken *string
165	firstPage bool
166}
167
168// NewDescribeEventsPaginator returns a new DescribeEventsPaginator
169func NewDescribeEventsPaginator(client DescribeEventsAPIClient, params *DescribeEventsInput, optFns ...func(*DescribeEventsPaginatorOptions)) *DescribeEventsPaginator {
170	if params == nil {
171		params = &DescribeEventsInput{}
172	}
173
174	options := DescribeEventsPaginatorOptions{}
175	if params.MaxResults != nil {
176		options.Limit = *params.MaxResults
177	}
178
179	for _, fn := range optFns {
180		fn(&options)
181	}
182
183	return &DescribeEventsPaginator{
184		options:   options,
185		client:    client,
186		params:    params,
187		firstPage: true,
188	}
189}
190
191// HasMorePages returns a boolean indicating whether more pages are available
192func (p *DescribeEventsPaginator) HasMorePages() bool {
193	return p.firstPage || p.nextToken != nil
194}
195
196// NextPage retrieves the next DescribeEvents page.
197func (p *DescribeEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEventsOutput, error) {
198	if !p.HasMorePages() {
199		return nil, fmt.Errorf("no more pages available")
200	}
201
202	params := *p.params
203	params.NextToken = p.nextToken
204
205	var limit *int32
206	if p.options.Limit > 0 {
207		limit = &p.options.Limit
208	}
209	params.MaxResults = limit
210
211	result, err := p.client.DescribeEvents(ctx, &params, optFns...)
212	if err != nil {
213		return nil, err
214	}
215	p.firstPage = false
216
217	prevToken := p.nextToken
218	p.nextToken = result.NextToken
219
220	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
221		p.nextToken = nil
222	}
223
224	return result, nil
225}
226
227func newServiceMetadataMiddleware_opDescribeEvents(region string) *awsmiddleware.RegisterServiceMetadata {
228	return &awsmiddleware.RegisterServiceMetadata{
229		Region:        region,
230		ServiceID:     ServiceID,
231		SigningName:   "opsworks-cm",
232		OperationName: "DescribeEvents",
233	}
234}
235