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, 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
45type DescribeWorkspaceDirectoriesOutput struct {
46
47	// Information about the directories.
48	Directories []types.WorkspaceDirectory
49
50	// The token to use to retrieve the next set of results, or null if no more results
51	// are available.
52	NextToken *string
53
54	// Metadata pertaining to the operation's result.
55	ResultMetadata middleware.Metadata
56}
57
58func addOperationDescribeWorkspaceDirectoriesMiddlewares(stack *middleware.Stack, options Options) (err error) {
59	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeWorkspaceDirectories{}, middleware.After)
60	if err != nil {
61		return err
62	}
63	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeWorkspaceDirectories{}, middleware.After)
64	if err != nil {
65		return err
66	}
67	if err = addSetLoggerMiddleware(stack, options); err != nil {
68		return err
69	}
70	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
71		return err
72	}
73	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
74		return err
75	}
76	if err = addResolveEndpointMiddleware(stack, options); err != nil {
77		return err
78	}
79	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
80		return err
81	}
82	if err = addRetryMiddlewares(stack, options); err != nil {
83		return err
84	}
85	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
86		return err
87	}
88	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
89		return err
90	}
91	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
92		return err
93	}
94	if err = addClientUserAgent(stack); err != nil {
95		return err
96	}
97	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
98		return err
99	}
100	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
101		return err
102	}
103	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeWorkspaceDirectories(options.Region), middleware.Before); err != nil {
104		return err
105	}
106	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
107		return err
108	}
109	if err = addResponseErrorMiddleware(stack); err != nil {
110		return err
111	}
112	if err = addRequestResponseLogging(stack, options); err != nil {
113		return err
114	}
115	return nil
116}
117
118// DescribeWorkspaceDirectoriesAPIClient is a client that implements the
119// DescribeWorkspaceDirectories operation.
120type DescribeWorkspaceDirectoriesAPIClient interface {
121	DescribeWorkspaceDirectories(context.Context, *DescribeWorkspaceDirectoriesInput, ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)
122}
123
124var _ DescribeWorkspaceDirectoriesAPIClient = (*Client)(nil)
125
126// DescribeWorkspaceDirectoriesPaginatorOptions is the paginator options for
127// DescribeWorkspaceDirectories
128type DescribeWorkspaceDirectoriesPaginatorOptions struct {
129	// Set to true if pagination should stop if the service returns a pagination token
130	// that matches the most recent token provided to the service.
131	StopOnDuplicateToken bool
132}
133
134// DescribeWorkspaceDirectoriesPaginator is a paginator for
135// DescribeWorkspaceDirectories
136type DescribeWorkspaceDirectoriesPaginator struct {
137	options   DescribeWorkspaceDirectoriesPaginatorOptions
138	client    DescribeWorkspaceDirectoriesAPIClient
139	params    *DescribeWorkspaceDirectoriesInput
140	nextToken *string
141	firstPage bool
142}
143
144// NewDescribeWorkspaceDirectoriesPaginator returns a new
145// DescribeWorkspaceDirectoriesPaginator
146func NewDescribeWorkspaceDirectoriesPaginator(client DescribeWorkspaceDirectoriesAPIClient, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*DescribeWorkspaceDirectoriesPaginatorOptions)) *DescribeWorkspaceDirectoriesPaginator {
147	options := DescribeWorkspaceDirectoriesPaginatorOptions{}
148
149	for _, fn := range optFns {
150		fn(&options)
151	}
152
153	if params == nil {
154		params = &DescribeWorkspaceDirectoriesInput{}
155	}
156
157	return &DescribeWorkspaceDirectoriesPaginator{
158		options:   options,
159		client:    client,
160		params:    params,
161		firstPage: true,
162	}
163}
164
165// HasMorePages returns a boolean indicating whether more pages are available
166func (p *DescribeWorkspaceDirectoriesPaginator) HasMorePages() bool {
167	return p.firstPage || p.nextToken != nil
168}
169
170// NextPage retrieves the next DescribeWorkspaceDirectories page.
171func (p *DescribeWorkspaceDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error) {
172	if !p.HasMorePages() {
173		return nil, fmt.Errorf("no more pages available")
174	}
175
176	params := *p.params
177	params.NextToken = p.nextToken
178
179	result, err := p.client.DescribeWorkspaceDirectories(ctx, &params, optFns...)
180	if err != nil {
181		return nil, err
182	}
183	p.firstPage = false
184
185	prevToken := p.nextToken
186	p.nextToken = result.NextToken
187
188	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
189		p.nextToken = nil
190	}
191
192	return result, nil
193}
194
195func newServiceMetadataMiddleware_opDescribeWorkspaceDirectories(region string) *awsmiddleware.RegisterServiceMetadata {
196	return &awsmiddleware.RegisterServiceMetadata{
197		Region:        region,
198		ServiceID:     ServiceID,
199		SigningName:   "workspaces",
200		OperationName: "DescribeWorkspaceDirectories",
201	}
202}
203