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 the IP address ranges that were specified in calls to
16// ProvisionByoipCidr. To describe the address pools that were created when you
17// provisioned the address ranges, use DescribePublicIpv4Pools or
18// DescribeIpv6Pools.
19func (c *Client) DescribeByoipCidrs(ctx context.Context, params *DescribeByoipCidrsInput, optFns ...func(*Options)) (*DescribeByoipCidrsOutput, error) {
20	if params == nil {
21		params = &DescribeByoipCidrsInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "DescribeByoipCidrs", params, optFns, addOperationDescribeByoipCidrsMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*DescribeByoipCidrsOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34type DescribeByoipCidrsInput struct {
35
36	// The maximum number of results to return with a single call. To retrieve the
37	// remaining results, make another call with the returned nextToken value.
38	//
39	// This member is required.
40	MaxResults int32
41
42	// Checks whether you have the required permissions for the action, without
43	// actually making the request, and provides an error response. If you have the
44	// required permissions, the error response is DryRunOperation. Otherwise, it is
45	// UnauthorizedOperation.
46	DryRun bool
47
48	// The token for the next page of results.
49	NextToken *string
50}
51
52type DescribeByoipCidrsOutput struct {
53
54	// Information about your address ranges.
55	ByoipCidrs []types.ByoipCidr
56
57	// The token to use to retrieve the next page of results. This value is null when
58	// there are no more results to return.
59	NextToken *string
60
61	// Metadata pertaining to the operation's result.
62	ResultMetadata middleware.Metadata
63}
64
65func addOperationDescribeByoipCidrsMiddlewares(stack *middleware.Stack, options Options) (err error) {
66	err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeByoipCidrs{}, middleware.After)
67	if err != nil {
68		return err
69	}
70	err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeByoipCidrs{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	if err = addSetLoggerMiddleware(stack, options); err != nil {
75		return err
76	}
77	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
78		return err
79	}
80	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
81		return err
82	}
83	if err = addResolveEndpointMiddleware(stack, options); err != nil {
84		return err
85	}
86	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
87		return err
88	}
89	if err = addRetryMiddlewares(stack, options); err != nil {
90		return err
91	}
92	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
96		return err
97	}
98	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
99		return err
100	}
101	if err = addClientUserAgent(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
105		return err
106	}
107	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addOpDescribeByoipCidrsValidationMiddleware(stack); err != nil {
111		return err
112	}
113	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeByoipCidrs(options.Region), middleware.Before); err != nil {
114		return err
115	}
116	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
117		return err
118	}
119	if err = addResponseErrorMiddleware(stack); err != nil {
120		return err
121	}
122	if err = addRequestResponseLogging(stack, options); err != nil {
123		return err
124	}
125	return nil
126}
127
128// DescribeByoipCidrsAPIClient is a client that implements the DescribeByoipCidrs
129// operation.
130type DescribeByoipCidrsAPIClient interface {
131	DescribeByoipCidrs(context.Context, *DescribeByoipCidrsInput, ...func(*Options)) (*DescribeByoipCidrsOutput, error)
132}
133
134var _ DescribeByoipCidrsAPIClient = (*Client)(nil)
135
136// DescribeByoipCidrsPaginatorOptions is the paginator options for
137// DescribeByoipCidrs
138type DescribeByoipCidrsPaginatorOptions struct {
139	// The maximum number of results to return with a single call. To retrieve the
140	// remaining results, make another call with the returned nextToken value.
141	Limit int32
142
143	// Set to true if pagination should stop if the service returns a pagination token
144	// that matches the most recent token provided to the service.
145	StopOnDuplicateToken bool
146}
147
148// DescribeByoipCidrsPaginator is a paginator for DescribeByoipCidrs
149type DescribeByoipCidrsPaginator struct {
150	options   DescribeByoipCidrsPaginatorOptions
151	client    DescribeByoipCidrsAPIClient
152	params    *DescribeByoipCidrsInput
153	nextToken *string
154	firstPage bool
155}
156
157// NewDescribeByoipCidrsPaginator returns a new DescribeByoipCidrsPaginator
158func NewDescribeByoipCidrsPaginator(client DescribeByoipCidrsAPIClient, params *DescribeByoipCidrsInput, optFns ...func(*DescribeByoipCidrsPaginatorOptions)) *DescribeByoipCidrsPaginator {
159	options := DescribeByoipCidrsPaginatorOptions{}
160	if params.MaxResults != 0 {
161		options.Limit = params.MaxResults
162	}
163
164	for _, fn := range optFns {
165		fn(&options)
166	}
167
168	if params == nil {
169		params = &DescribeByoipCidrsInput{}
170	}
171
172	return &DescribeByoipCidrsPaginator{
173		options:   options,
174		client:    client,
175		params:    params,
176		firstPage: true,
177	}
178}
179
180// HasMorePages returns a boolean indicating whether more pages are available
181func (p *DescribeByoipCidrsPaginator) HasMorePages() bool {
182	return p.firstPage || p.nextToken != nil
183}
184
185// NextPage retrieves the next DescribeByoipCidrs page.
186func (p *DescribeByoipCidrsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeByoipCidrsOutput, error) {
187	if !p.HasMorePages() {
188		return nil, fmt.Errorf("no more pages available")
189	}
190
191	params := *p.params
192	params.NextToken = p.nextToken
193
194	params.MaxResults = p.options.Limit
195
196	result, err := p.client.DescribeByoipCidrs(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_opDescribeByoipCidrs(region string) *awsmiddleware.RegisterServiceMetadata {
213	return &awsmiddleware.RegisterServiceMetadata{
214		Region:        region,
215		ServiceID:     ServiceID,
216		SigningName:   "ec2",
217		OperationName: "DescribeByoipCidrs",
218	}
219}
220