1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cloud9
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/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Gets a list of AWS Cloud9 development environment identifiers.
15func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error) {
16	if params == nil {
17		params = &ListEnvironmentsInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "ListEnvironments", params, optFns, addOperationListEnvironmentsMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*ListEnvironmentsOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type ListEnvironmentsInput struct {
31
32	// The maximum number of environments to get identifiers for.
33	MaxResults *int32
34
35	// During a previous call, if there are more than 25 items in the list, only the
36	// first 25 items are returned, along with a unique string called a next token. To
37	// get the next batch of items in the list, call this operation again, adding the
38	// next token to the call. To get all of the items in the list, keep calling this
39	// operation with each subsequent next token that is returned, until no more next
40	// tokens are returned.
41	NextToken *string
42}
43
44type ListEnvironmentsOutput struct {
45
46	// The list of environment identifiers.
47	EnvironmentIds []string
48
49	// If there are more than 25 items in the list, only the first 25 items are
50	// returned, along with a unique string called a next token. To get the next batch
51	// of items in the list, call this operation again, adding the next token to the
52	// call.
53	NextToken *string
54
55	// Metadata pertaining to the operation's result.
56	ResultMetadata middleware.Metadata
57}
58
59func addOperationListEnvironmentsMiddlewares(stack *middleware.Stack, options Options) (err error) {
60	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListEnvironments{}, middleware.After)
61	if err != nil {
62		return err
63	}
64	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListEnvironments{}, middleware.After)
65	if err != nil {
66		return err
67	}
68	if err = addSetLoggerMiddleware(stack, options); err != nil {
69		return err
70	}
71	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
72		return err
73	}
74	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
75		return err
76	}
77	if err = addResolveEndpointMiddleware(stack, options); err != nil {
78		return err
79	}
80	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
81		return err
82	}
83	if err = addRetryMiddlewares(stack, options); err != nil {
84		return err
85	}
86	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
87		return err
88	}
89	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
90		return err
91	}
92	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
93		return err
94	}
95	if err = addClientUserAgent(stack); err != nil {
96		return err
97	}
98	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
99		return err
100	}
101	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
102		return err
103	}
104	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListEnvironments(options.Region), middleware.Before); err != nil {
105		return err
106	}
107	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addResponseErrorMiddleware(stack); err != nil {
111		return err
112	}
113	if err = addRequestResponseLogging(stack, options); err != nil {
114		return err
115	}
116	return nil
117}
118
119// ListEnvironmentsAPIClient is a client that implements the ListEnvironments
120// operation.
121type ListEnvironmentsAPIClient interface {
122	ListEnvironments(context.Context, *ListEnvironmentsInput, ...func(*Options)) (*ListEnvironmentsOutput, error)
123}
124
125var _ ListEnvironmentsAPIClient = (*Client)(nil)
126
127// ListEnvironmentsPaginatorOptions is the paginator options for ListEnvironments
128type ListEnvironmentsPaginatorOptions struct {
129	// The maximum number of environments to get identifiers for.
130	Limit int32
131
132	// Set to true if pagination should stop if the service returns a pagination token
133	// that matches the most recent token provided to the service.
134	StopOnDuplicateToken bool
135}
136
137// ListEnvironmentsPaginator is a paginator for ListEnvironments
138type ListEnvironmentsPaginator struct {
139	options   ListEnvironmentsPaginatorOptions
140	client    ListEnvironmentsAPIClient
141	params    *ListEnvironmentsInput
142	nextToken *string
143	firstPage bool
144}
145
146// NewListEnvironmentsPaginator returns a new ListEnvironmentsPaginator
147func NewListEnvironmentsPaginator(client ListEnvironmentsAPIClient, params *ListEnvironmentsInput, optFns ...func(*ListEnvironmentsPaginatorOptions)) *ListEnvironmentsPaginator {
148	options := ListEnvironmentsPaginatorOptions{}
149	if params.MaxResults != nil {
150		options.Limit = *params.MaxResults
151	}
152
153	for _, fn := range optFns {
154		fn(&options)
155	}
156
157	if params == nil {
158		params = &ListEnvironmentsInput{}
159	}
160
161	return &ListEnvironmentsPaginator{
162		options:   options,
163		client:    client,
164		params:    params,
165		firstPage: true,
166	}
167}
168
169// HasMorePages returns a boolean indicating whether more pages are available
170func (p *ListEnvironmentsPaginator) HasMorePages() bool {
171	return p.firstPage || p.nextToken != nil
172}
173
174// NextPage retrieves the next ListEnvironments page.
175func (p *ListEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnvironmentsOutput, error) {
176	if !p.HasMorePages() {
177		return nil, fmt.Errorf("no more pages available")
178	}
179
180	params := *p.params
181	params.NextToken = p.nextToken
182
183	var limit *int32
184	if p.options.Limit > 0 {
185		limit = &p.options.Limit
186	}
187	params.MaxResults = limit
188
189	result, err := p.client.ListEnvironments(ctx, &params, optFns...)
190	if err != nil {
191		return nil, err
192	}
193	p.firstPage = false
194
195	prevToken := p.nextToken
196	p.nextToken = result.NextToken
197
198	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
199		p.nextToken = nil
200	}
201
202	return result, nil
203}
204
205func newServiceMetadataMiddleware_opListEnvironments(region string) *awsmiddleware.RegisterServiceMetadata {
206	return &awsmiddleware.RegisterServiceMetadata{
207		Region:        region,
208		ServiceID:     ServiceID,
209		SigningName:   "cloud9",
210		OperationName: "ListEnvironments",
211	}
212}
213