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)
14
15// Describes available AWS services in a prefix list format, which includes the
16// prefix list name and prefix list ID of the service and the IP address range for
17// the service. We recommend that you use DescribeManagedPrefixLists instead.
18func (c *Client) DescribePrefixLists(ctx context.Context, params *DescribePrefixListsInput, optFns ...func(*Options)) (*DescribePrefixListsOutput, error) {
19	if params == nil {
20		params = &DescribePrefixListsInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "DescribePrefixLists", params, optFns, addOperationDescribePrefixListsMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*DescribePrefixListsOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33type DescribePrefixListsInput struct {
34
35	// Checks whether you have the required permissions for the action, without
36	// actually making the request, and provides an error response. If you have the
37	// required permissions, the error response is DryRunOperation. Otherwise, it is
38	// UnauthorizedOperation.
39	DryRun *bool
40
41	// One or more filters.
42	//
43	// * prefix-list-id: The ID of a prefix list.
44	//
45	// *
46	// prefix-list-name: The name of a prefix list.
47	Filters []types.Filter
48
49	// The maximum number of results to return with a single call. To retrieve the
50	// remaining results, make another call with the returned nextToken value.
51	MaxResults *int32
52
53	// The token for the next page of results.
54	NextToken *string
55
56	// One or more prefix list IDs.
57	PrefixListIds []string
58}
59
60type DescribePrefixListsOutput struct {
61
62	// The token to use to retrieve the next page of results. This value is null when
63	// there are no more results to return.
64	NextToken *string
65
66	// All available prefix lists.
67	PrefixLists []types.PrefixList
68
69	// Metadata pertaining to the operation's result.
70	ResultMetadata middleware.Metadata
71}
72
73func addOperationDescribePrefixListsMiddlewares(stack *middleware.Stack, options Options) (err error) {
74	err = stack.Serialize.Add(&awsEc2query_serializeOpDescribePrefixLists{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribePrefixLists{}, middleware.After)
79	if err != nil {
80		return err
81	}
82	if err = addSetLoggerMiddleware(stack, options); err != nil {
83		return err
84	}
85	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
86		return err
87	}
88	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
89		return err
90	}
91	if err = addResolveEndpointMiddleware(stack, options); err != nil {
92		return err
93	}
94	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
95		return err
96	}
97	if err = addRetryMiddlewares(stack, options); err != nil {
98		return err
99	}
100	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
104		return err
105	}
106	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
107		return err
108	}
109	if err = addClientUserAgent(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePrefixLists(options.Region), middleware.Before); err != nil {
119		return err
120	}
121	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addResponseErrorMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addRequestResponseLogging(stack, options); err != nil {
128		return err
129	}
130	return nil
131}
132
133// DescribePrefixListsAPIClient is a client that implements the DescribePrefixLists
134// operation.
135type DescribePrefixListsAPIClient interface {
136	DescribePrefixLists(context.Context, *DescribePrefixListsInput, ...func(*Options)) (*DescribePrefixListsOutput, error)
137}
138
139var _ DescribePrefixListsAPIClient = (*Client)(nil)
140
141// DescribePrefixListsPaginatorOptions is the paginator options for
142// DescribePrefixLists
143type DescribePrefixListsPaginatorOptions struct {
144	// The maximum number of results to return with a single call. To retrieve the
145	// remaining results, make another call with the returned nextToken value.
146	Limit int32
147
148	// Set to true if pagination should stop if the service returns a pagination token
149	// that matches the most recent token provided to the service.
150	StopOnDuplicateToken bool
151}
152
153// DescribePrefixListsPaginator is a paginator for DescribePrefixLists
154type DescribePrefixListsPaginator struct {
155	options   DescribePrefixListsPaginatorOptions
156	client    DescribePrefixListsAPIClient
157	params    *DescribePrefixListsInput
158	nextToken *string
159	firstPage bool
160}
161
162// NewDescribePrefixListsPaginator returns a new DescribePrefixListsPaginator
163func NewDescribePrefixListsPaginator(client DescribePrefixListsAPIClient, params *DescribePrefixListsInput, optFns ...func(*DescribePrefixListsPaginatorOptions)) *DescribePrefixListsPaginator {
164	if params == nil {
165		params = &DescribePrefixListsInput{}
166	}
167
168	options := DescribePrefixListsPaginatorOptions{}
169	if params.MaxResults != nil {
170		options.Limit = *params.MaxResults
171	}
172
173	for _, fn := range optFns {
174		fn(&options)
175	}
176
177	return &DescribePrefixListsPaginator{
178		options:   options,
179		client:    client,
180		params:    params,
181		firstPage: true,
182	}
183}
184
185// HasMorePages returns a boolean indicating whether more pages are available
186func (p *DescribePrefixListsPaginator) HasMorePages() bool {
187	return p.firstPage || p.nextToken != nil
188}
189
190// NextPage retrieves the next DescribePrefixLists page.
191func (p *DescribePrefixListsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePrefixListsOutput, error) {
192	if !p.HasMorePages() {
193		return nil, fmt.Errorf("no more pages available")
194	}
195
196	params := *p.params
197	params.NextToken = p.nextToken
198
199	var limit *int32
200	if p.options.Limit > 0 {
201		limit = &p.options.Limit
202	}
203	params.MaxResults = limit
204
205	result, err := p.client.DescribePrefixLists(ctx, &params, optFns...)
206	if err != nil {
207		return nil, err
208	}
209	p.firstPage = false
210
211	prevToken := p.nextToken
212	p.nextToken = result.NextToken
213
214	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
215		p.nextToken = nil
216	}
217
218	return result, nil
219}
220
221func newServiceMetadataMiddleware_opDescribePrefixLists(region string) *awsmiddleware.RegisterServiceMetadata {
222	return &awsmiddleware.RegisterServiceMetadata{
223		Region:        region,
224		ServiceID:     ServiceID,
225		SigningName:   "ec2",
226		OperationName: "DescribePrefixLists",
227	}
228}
229