1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package xray
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/xray/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// X-Ray reevaluates insights periodically until they're resolved, and records each
16// intermediate state as an event. You can review an insight's events in the Impact
17// Timeline on the Inspect page in the X-Ray console.
18func (c *Client) GetInsightEvents(ctx context.Context, params *GetInsightEventsInput, optFns ...func(*Options)) (*GetInsightEventsOutput, error) {
19	if params == nil {
20		params = &GetInsightEventsInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "GetInsightEvents", params, optFns, addOperationGetInsightEventsMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*GetInsightEventsOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33type GetInsightEventsInput struct {
34
35	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
36	// an InsightId.
37	//
38	// This member is required.
39	InsightId *string
40
41	// Used to retrieve at most the specified value of events.
42	MaxResults *int32
43
44	// Specify the pagination token returned by a previous request to retrieve the next
45	// page of events.
46	NextToken *string
47}
48
49type GetInsightEventsOutput struct {
50
51	// A detailed description of the event. This includes the time of the event, client
52	// and root cause impact statistics, and the top anomalous service at the time of
53	// the event.
54	InsightEvents []types.InsightEvent
55
56	// Use this token to retrieve the next page of insight events.
57	NextToken *string
58
59	// Metadata pertaining to the operation's result.
60	ResultMetadata middleware.Metadata
61}
62
63func addOperationGetInsightEventsMiddlewares(stack *middleware.Stack, options Options) (err error) {
64	err = stack.Serialize.Add(&awsRestjson1_serializeOpGetInsightEvents{}, middleware.After)
65	if err != nil {
66		return err
67	}
68	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetInsightEvents{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	if err = addSetLoggerMiddleware(stack, options); err != nil {
73		return err
74	}
75	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
76		return err
77	}
78	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
79		return err
80	}
81	if err = addResolveEndpointMiddleware(stack, options); err != nil {
82		return err
83	}
84	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
85		return err
86	}
87	if err = addRetryMiddlewares(stack, options); err != nil {
88		return err
89	}
90	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
91		return err
92	}
93	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
94		return err
95	}
96	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
97		return err
98	}
99	if err = addClientUserAgent(stack); err != nil {
100		return err
101	}
102	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
103		return err
104	}
105	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
106		return err
107	}
108	if err = addOpGetInsightEventsValidationMiddleware(stack); err != nil {
109		return err
110	}
111	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInsightEvents(options.Region), middleware.Before); err != nil {
112		return err
113	}
114	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addResponseErrorMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addRequestResponseLogging(stack, options); err != nil {
121		return err
122	}
123	return nil
124}
125
126// GetInsightEventsAPIClient is a client that implements the GetInsightEvents
127// operation.
128type GetInsightEventsAPIClient interface {
129	GetInsightEvents(context.Context, *GetInsightEventsInput, ...func(*Options)) (*GetInsightEventsOutput, error)
130}
131
132var _ GetInsightEventsAPIClient = (*Client)(nil)
133
134// GetInsightEventsPaginatorOptions is the paginator options for GetInsightEvents
135type GetInsightEventsPaginatorOptions struct {
136	// Used to retrieve at most the specified value of events.
137	Limit int32
138
139	// Set to true if pagination should stop if the service returns a pagination token
140	// that matches the most recent token provided to the service.
141	StopOnDuplicateToken bool
142}
143
144// GetInsightEventsPaginator is a paginator for GetInsightEvents
145type GetInsightEventsPaginator struct {
146	options   GetInsightEventsPaginatorOptions
147	client    GetInsightEventsAPIClient
148	params    *GetInsightEventsInput
149	nextToken *string
150	firstPage bool
151}
152
153// NewGetInsightEventsPaginator returns a new GetInsightEventsPaginator
154func NewGetInsightEventsPaginator(client GetInsightEventsAPIClient, params *GetInsightEventsInput, optFns ...func(*GetInsightEventsPaginatorOptions)) *GetInsightEventsPaginator {
155	if params == nil {
156		params = &GetInsightEventsInput{}
157	}
158
159	options := GetInsightEventsPaginatorOptions{}
160	if params.MaxResults != nil {
161		options.Limit = *params.MaxResults
162	}
163
164	for _, fn := range optFns {
165		fn(&options)
166	}
167
168	return &GetInsightEventsPaginator{
169		options:   options,
170		client:    client,
171		params:    params,
172		firstPage: true,
173	}
174}
175
176// HasMorePages returns a boolean indicating whether more pages are available
177func (p *GetInsightEventsPaginator) HasMorePages() bool {
178	return p.firstPage || p.nextToken != nil
179}
180
181// NextPage retrieves the next GetInsightEvents page.
182func (p *GetInsightEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInsightEventsOutput, error) {
183	if !p.HasMorePages() {
184		return nil, fmt.Errorf("no more pages available")
185	}
186
187	params := *p.params
188	params.NextToken = p.nextToken
189
190	var limit *int32
191	if p.options.Limit > 0 {
192		limit = &p.options.Limit
193	}
194	params.MaxResults = limit
195
196	result, err := p.client.GetInsightEvents(ctx, &params, optFns...)
197	if err != nil {
198		return nil, err
199	}
200	p.firstPage = false
201
202	prevToken := p.nextToken
203	p.nextToken = result.NextToken
204
205	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
206		p.nextToken = nil
207	}
208
209	return result, nil
210}
211
212func newServiceMetadataMiddleware_opGetInsightEvents(region string) *awsmiddleware.RegisterServiceMetadata {
213	return &awsmiddleware.RegisterServiceMetadata{
214		Region:        region,
215		ServiceID:     ServiceID,
216		SigningName:   "xray",
217		OperationName: "GetInsightEvents",
218	}
219}
220