1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package ec2
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/ec2/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13	"time"
14)
15
16// Describes one or more of your network insights analyses.
17func (c *Client) DescribeNetworkInsightsAnalyses(ctx context.Context, params *DescribeNetworkInsightsAnalysesInput, optFns ...func(*Options)) (*DescribeNetworkInsightsAnalysesOutput, error) {
18	if params == nil {
19		params = &DescribeNetworkInsightsAnalysesInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "DescribeNetworkInsightsAnalyses", params, optFns, addOperationDescribeNetworkInsightsAnalysesMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*DescribeNetworkInsightsAnalysesOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type DescribeNetworkInsightsAnalysesInput struct {
33
34	// The time when the network insights analyses ended.
35	AnalysisEndTime *time.Time
36
37	// The time when the network insights analyses started.
38	AnalysisStartTime *time.Time
39
40	// Checks whether you have the required permissions for the action, without
41	// actually making the request, and provides an error response. If you have the
42	// required permissions, the error response is DryRunOperation. Otherwise, it is
43	// UnauthorizedOperation.
44	DryRun bool
45
46	// The filters. The following are possible values:
47	//
48	// * PathFound - A Boolean value
49	// that indicates whether a feasible path is found.
50	//
51	// * Status - The status of the
52	// analysis (running | succeeded | failed).
53	Filters []types.Filter
54
55	// The maximum number of results to return with a single call. To retrieve the
56	// remaining results, make another call with the returned nextToken value.
57	MaxResults int32
58
59	// The ID of the network insights analyses. You must specify either analysis IDs or
60	// a path ID.
61	NetworkInsightsAnalysisIds []string
62
63	// The ID of the path. You must specify either a path ID or analysis IDs.
64	NetworkInsightsPathId *string
65
66	// The token for the next page of results.
67	NextToken *string
68}
69
70type DescribeNetworkInsightsAnalysesOutput struct {
71
72	// Information about the network insights analyses.
73	NetworkInsightsAnalyses []types.NetworkInsightsAnalysis
74
75	// The token to use to retrieve the next page of results. This value is null when
76	// there are no more results to return.
77	NextToken *string
78
79	// Metadata pertaining to the operation's result.
80	ResultMetadata middleware.Metadata
81}
82
83func addOperationDescribeNetworkInsightsAnalysesMiddlewares(stack *middleware.Stack, options Options) (err error) {
84	err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeNetworkInsightsAnalyses{}, middleware.After)
85	if err != nil {
86		return err
87	}
88	err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeNetworkInsightsAnalyses{}, middleware.After)
89	if err != nil {
90		return err
91	}
92	if err = addSetLoggerMiddleware(stack, options); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
96		return err
97	}
98	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
99		return err
100	}
101	if err = addResolveEndpointMiddleware(stack, options); err != nil {
102		return err
103	}
104	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
105		return err
106	}
107	if err = addRetryMiddlewares(stack, options); err != nil {
108		return err
109	}
110	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
111		return err
112	}
113	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
114		return err
115	}
116	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
117		return err
118	}
119	if err = addClientUserAgent(stack); 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 = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeNetworkInsightsAnalyses(options.Region), middleware.Before); err != nil {
129		return err
130	}
131	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
132		return err
133	}
134	if err = addResponseErrorMiddleware(stack); err != nil {
135		return err
136	}
137	if err = addRequestResponseLogging(stack, options); err != nil {
138		return err
139	}
140	return nil
141}
142
143// DescribeNetworkInsightsAnalysesAPIClient is a client that implements the
144// DescribeNetworkInsightsAnalyses operation.
145type DescribeNetworkInsightsAnalysesAPIClient interface {
146	DescribeNetworkInsightsAnalyses(context.Context, *DescribeNetworkInsightsAnalysesInput, ...func(*Options)) (*DescribeNetworkInsightsAnalysesOutput, error)
147}
148
149var _ DescribeNetworkInsightsAnalysesAPIClient = (*Client)(nil)
150
151// DescribeNetworkInsightsAnalysesPaginatorOptions is the paginator options for
152// DescribeNetworkInsightsAnalyses
153type DescribeNetworkInsightsAnalysesPaginatorOptions struct {
154	// The maximum number of results to return with a single call. To retrieve the
155	// remaining results, make another call with the returned nextToken value.
156	Limit int32
157
158	// Set to true if pagination should stop if the service returns a pagination token
159	// that matches the most recent token provided to the service.
160	StopOnDuplicateToken bool
161}
162
163// DescribeNetworkInsightsAnalysesPaginator is a paginator for
164// DescribeNetworkInsightsAnalyses
165type DescribeNetworkInsightsAnalysesPaginator struct {
166	options   DescribeNetworkInsightsAnalysesPaginatorOptions
167	client    DescribeNetworkInsightsAnalysesAPIClient
168	params    *DescribeNetworkInsightsAnalysesInput
169	nextToken *string
170	firstPage bool
171}
172
173// NewDescribeNetworkInsightsAnalysesPaginator returns a new
174// DescribeNetworkInsightsAnalysesPaginator
175func NewDescribeNetworkInsightsAnalysesPaginator(client DescribeNetworkInsightsAnalysesAPIClient, params *DescribeNetworkInsightsAnalysesInput, optFns ...func(*DescribeNetworkInsightsAnalysesPaginatorOptions)) *DescribeNetworkInsightsAnalysesPaginator {
176	options := DescribeNetworkInsightsAnalysesPaginatorOptions{}
177	if params.MaxResults != 0 {
178		options.Limit = params.MaxResults
179	}
180
181	for _, fn := range optFns {
182		fn(&options)
183	}
184
185	if params == nil {
186		params = &DescribeNetworkInsightsAnalysesInput{}
187	}
188
189	return &DescribeNetworkInsightsAnalysesPaginator{
190		options:   options,
191		client:    client,
192		params:    params,
193		firstPage: true,
194	}
195}
196
197// HasMorePages returns a boolean indicating whether more pages are available
198func (p *DescribeNetworkInsightsAnalysesPaginator) HasMorePages() bool {
199	return p.firstPage || p.nextToken != nil
200}
201
202// NextPage retrieves the next DescribeNetworkInsightsAnalyses page.
203func (p *DescribeNetworkInsightsAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeNetworkInsightsAnalysesOutput, error) {
204	if !p.HasMorePages() {
205		return nil, fmt.Errorf("no more pages available")
206	}
207
208	params := *p.params
209	params.NextToken = p.nextToken
210
211	params.MaxResults = p.options.Limit
212
213	result, err := p.client.DescribeNetworkInsightsAnalyses(ctx, &params, optFns...)
214	if err != nil {
215		return nil, err
216	}
217	p.firstPage = false
218
219	prevToken := p.nextToken
220	p.nextToken = result.NextToken
221
222	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
223		p.nextToken = nil
224	}
225
226	return result, nil
227}
228
229func newServiceMetadataMiddleware_opDescribeNetworkInsightsAnalyses(region string) *awsmiddleware.RegisterServiceMetadata {
230	return &awsmiddleware.RegisterServiceMetadata{
231		Region:        region,
232		ServiceID:     ServiceID,
233		SigningName:   "ec2",
234		OperationName: "DescribeNetworkInsightsAnalyses",
235	}
236}
237