1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package workspaces
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/workspaces/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Describes the available directories that are registered with Amazon WorkSpaces.
16func (c *Client) DescribeWorkspaceDirectories(ctx context.Context, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error) {
17	if params == nil {
18		params = &DescribeWorkspaceDirectoriesInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeWorkspaceDirectories", params, optFns, c.addOperationDescribeWorkspaceDirectoriesMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeWorkspaceDirectoriesOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeWorkspaceDirectoriesInput struct {
32
33	// The identifiers of the directories. If the value is null, all directories are
34	// retrieved.
35	DirectoryIds []string
36
37	// The maximum number of directories to return.
38	Limit *int32
39
40	// If you received a NextToken from a previous call that was paginated, provide
41	// this token to receive the next set of results.
42	NextToken *string
43
44	noSmithyDocumentSerde
45}
46
47type DescribeWorkspaceDirectoriesOutput struct {
48
49	// Information about the directories.
50	Directories []types.WorkspaceDirectory
51
52	// The token to use to retrieve the next page of results. This value is null when
53	// there are no more results to return.
54	NextToken *string
55
56	// Metadata pertaining to the operation's result.
57	ResultMetadata middleware.Metadata
58
59	noSmithyDocumentSerde
60}
61
62func (c *Client) addOperationDescribeWorkspaceDirectoriesMiddlewares(stack *middleware.Stack, options Options) (err error) {
63	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeWorkspaceDirectories{}, middleware.After)
64	if err != nil {
65		return err
66	}
67	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeWorkspaceDirectories{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	if err = addSetLoggerMiddleware(stack, options); err != nil {
72		return err
73	}
74	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
75		return err
76	}
77	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
78		return err
79	}
80	if err = addResolveEndpointMiddleware(stack, options); err != nil {
81		return err
82	}
83	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
84		return err
85	}
86	if err = addRetryMiddlewares(stack, options); err != nil {
87		return err
88	}
89	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
90		return err
91	}
92	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
96		return err
97	}
98	if err = addClientUserAgent(stack); err != nil {
99		return err
100	}
101	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
105		return err
106	}
107	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeWorkspaceDirectories(options.Region), middleware.Before); err != nil {
108		return err
109	}
110	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
111		return err
112	}
113	if err = addResponseErrorMiddleware(stack); err != nil {
114		return err
115	}
116	if err = addRequestResponseLogging(stack, options); err != nil {
117		return err
118	}
119	return nil
120}
121
122// DescribeWorkspaceDirectoriesAPIClient is a client that implements the
123// DescribeWorkspaceDirectories operation.
124type DescribeWorkspaceDirectoriesAPIClient interface {
125	DescribeWorkspaceDirectories(context.Context, *DescribeWorkspaceDirectoriesInput, ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)
126}
127
128var _ DescribeWorkspaceDirectoriesAPIClient = (*Client)(nil)
129
130// DescribeWorkspaceDirectoriesPaginatorOptions is the paginator options for
131// DescribeWorkspaceDirectories
132type DescribeWorkspaceDirectoriesPaginatorOptions struct {
133	// Set to true if pagination should stop if the service returns a pagination token
134	// that matches the most recent token provided to the service.
135	StopOnDuplicateToken bool
136}
137
138// DescribeWorkspaceDirectoriesPaginator is a paginator for
139// DescribeWorkspaceDirectories
140type DescribeWorkspaceDirectoriesPaginator struct {
141	options   DescribeWorkspaceDirectoriesPaginatorOptions
142	client    DescribeWorkspaceDirectoriesAPIClient
143	params    *DescribeWorkspaceDirectoriesInput
144	nextToken *string
145	firstPage bool
146}
147
148// NewDescribeWorkspaceDirectoriesPaginator returns a new
149// DescribeWorkspaceDirectoriesPaginator
150func NewDescribeWorkspaceDirectoriesPaginator(client DescribeWorkspaceDirectoriesAPIClient, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*DescribeWorkspaceDirectoriesPaginatorOptions)) *DescribeWorkspaceDirectoriesPaginator {
151	if params == nil {
152		params = &DescribeWorkspaceDirectoriesInput{}
153	}
154
155	options := DescribeWorkspaceDirectoriesPaginatorOptions{}
156
157	for _, fn := range optFns {
158		fn(&options)
159	}
160
161	return &DescribeWorkspaceDirectoriesPaginator{
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 *DescribeWorkspaceDirectoriesPaginator) HasMorePages() bool {
171	return p.firstPage || p.nextToken != nil
172}
173
174// NextPage retrieves the next DescribeWorkspaceDirectories page.
175func (p *DescribeWorkspaceDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, 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	result, err := p.client.DescribeWorkspaceDirectories(ctx, &params, optFns...)
184	if err != nil {
185		return nil, err
186	}
187	p.firstPage = false
188
189	prevToken := p.nextToken
190	p.nextToken = result.NextToken
191
192	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
193		p.nextToken = nil
194	}
195
196	return result, nil
197}
198
199func newServiceMetadataMiddleware_opDescribeWorkspaceDirectories(region string) *awsmiddleware.RegisterServiceMetadata {
200	return &awsmiddleware.RegisterServiceMetadata{
201		Region:        region,
202		ServiceID:     ServiceID,
203		SigningName:   "workspaces",
204		OperationName: "DescribeWorkspaceDirectories",
205	}
206}
207