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 reservations that are associated with Dedicated Hosts in your account.
16func (c *Client) DescribeHostReservations(ctx context.Context, params *DescribeHostReservationsInput, optFns ...func(*Options)) (*DescribeHostReservationsOutput, error) {
17	if params == nil {
18		params = &DescribeHostReservationsInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeHostReservations", params, optFns, c.addOperationDescribeHostReservationsMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeHostReservationsOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeHostReservationsInput struct {
32
33	// The filters.
34	//
35	// * instance-family - The instance family (for example, m4).
36	//
37	// *
38	// payment-option - The payment option (NoUpfront | PartialUpfront |
39	// AllUpfront).
40	//
41	// * state - The state of the reservation (payment-pending |
42	// payment-failed | active | retired).
43	//
44	// * tag: - The key/value combination of a tag
45	// assigned to the resource. Use the tag key in the filter name and the tag value
46	// as the filter value. For example, to find all resources that have a tag with the
47	// key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA
48	// for the filter value.
49	//
50	// * tag-key - The key of a tag assigned to the resource.
51	// Use this filter to find all resources assigned a tag with a specific key,
52	// regardless of the tag value.
53	Filter []types.Filter
54
55	// The host reservation IDs.
56	HostReservationIdSet []string
57
58	// The maximum number of results to return for the request in a single page. The
59	// remaining results can be seen by sending another request with the returned
60	// nextToken value. This value can be between 5 and 500. If maxResults is given a
61	// larger value than 500, you receive an error.
62	MaxResults *int32
63
64	// The token to use to retrieve the next page of results.
65	NextToken *string
66
67	noSmithyDocumentSerde
68}
69
70type DescribeHostReservationsOutput struct {
71
72	// Details about the reservation's configuration.
73	HostReservationSet []types.HostReservation
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	noSmithyDocumentSerde
83}
84
85func (c *Client) addOperationDescribeHostReservationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
86	err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeHostReservations{}, middleware.After)
87	if err != nil {
88		return err
89	}
90	err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeHostReservations{}, middleware.After)
91	if err != nil {
92		return err
93	}
94	if err = addSetLoggerMiddleware(stack, options); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
98		return err
99	}
100	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
101		return err
102	}
103	if err = addResolveEndpointMiddleware(stack, options); err != nil {
104		return err
105	}
106	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
107		return err
108	}
109	if err = addRetryMiddlewares(stack, options); err != nil {
110		return err
111	}
112	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
113		return err
114	}
115	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
116		return err
117	}
118	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
119		return err
120	}
121	if err = addClientUserAgent(stack); err != nil {
122		return err
123	}
124	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
125		return err
126	}
127	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
128		return err
129	}
130	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeHostReservations(options.Region), middleware.Before); err != nil {
131		return err
132	}
133	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
134		return err
135	}
136	if err = addResponseErrorMiddleware(stack); err != nil {
137		return err
138	}
139	if err = addRequestResponseLogging(stack, options); err != nil {
140		return err
141	}
142	return nil
143}
144
145// DescribeHostReservationsAPIClient is a client that implements the
146// DescribeHostReservations operation.
147type DescribeHostReservationsAPIClient interface {
148	DescribeHostReservations(context.Context, *DescribeHostReservationsInput, ...func(*Options)) (*DescribeHostReservationsOutput, error)
149}
150
151var _ DescribeHostReservationsAPIClient = (*Client)(nil)
152
153// DescribeHostReservationsPaginatorOptions is the paginator options for
154// DescribeHostReservations
155type DescribeHostReservationsPaginatorOptions struct {
156	// The maximum number of results to return for the request in a single page. The
157	// remaining results can be seen by sending another request with the returned
158	// nextToken value. This value can be between 5 and 500. If maxResults is given a
159	// larger value than 500, you receive an error.
160	Limit int32
161
162	// Set to true if pagination should stop if the service returns a pagination token
163	// that matches the most recent token provided to the service.
164	StopOnDuplicateToken bool
165}
166
167// DescribeHostReservationsPaginator is a paginator for DescribeHostReservations
168type DescribeHostReservationsPaginator struct {
169	options   DescribeHostReservationsPaginatorOptions
170	client    DescribeHostReservationsAPIClient
171	params    *DescribeHostReservationsInput
172	nextToken *string
173	firstPage bool
174}
175
176// NewDescribeHostReservationsPaginator returns a new
177// DescribeHostReservationsPaginator
178func NewDescribeHostReservationsPaginator(client DescribeHostReservationsAPIClient, params *DescribeHostReservationsInput, optFns ...func(*DescribeHostReservationsPaginatorOptions)) *DescribeHostReservationsPaginator {
179	if params == nil {
180		params = &DescribeHostReservationsInput{}
181	}
182
183	options := DescribeHostReservationsPaginatorOptions{}
184	if params.MaxResults != nil {
185		options.Limit = *params.MaxResults
186	}
187
188	for _, fn := range optFns {
189		fn(&options)
190	}
191
192	return &DescribeHostReservationsPaginator{
193		options:   options,
194		client:    client,
195		params:    params,
196		firstPage: true,
197	}
198}
199
200// HasMorePages returns a boolean indicating whether more pages are available
201func (p *DescribeHostReservationsPaginator) HasMorePages() bool {
202	return p.firstPage || p.nextToken != nil
203}
204
205// NextPage retrieves the next DescribeHostReservations page.
206func (p *DescribeHostReservationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeHostReservationsOutput, error) {
207	if !p.HasMorePages() {
208		return nil, fmt.Errorf("no more pages available")
209	}
210
211	params := *p.params
212	params.NextToken = p.nextToken
213
214	var limit *int32
215	if p.options.Limit > 0 {
216		limit = &p.options.Limit
217	}
218	params.MaxResults = limit
219
220	result, err := p.client.DescribeHostReservations(ctx, &params, optFns...)
221	if err != nil {
222		return nil, err
223	}
224	p.firstPage = false
225
226	prevToken := p.nextToken
227	p.nextToken = result.NextToken
228
229	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
230		p.nextToken = nil
231	}
232
233	return result, nil
234}
235
236func newServiceMetadataMiddleware_opDescribeHostReservations(region string) *awsmiddleware.RegisterServiceMetadata {
237	return &awsmiddleware.RegisterServiceMetadata{
238		Region:        region,
239		ServiceID:     ServiceID,
240		SigningName:   "ec2",
241		OperationName: "DescribeHostReservations",
242	}
243}
244