1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package sagemaker
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/sagemaker/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Use this operation to list all private and vendor workforces in an AWS Region.
16// Note that you can only have one private workforce per AWS Region.
17func (c *Client) ListWorkforces(ctx context.Context, params *ListWorkforcesInput, optFns ...func(*Options)) (*ListWorkforcesOutput, error) {
18	if params == nil {
19		params = &ListWorkforcesInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "ListWorkforces", params, optFns, addOperationListWorkforcesMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*ListWorkforcesOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type ListWorkforcesInput struct {
33
34	// The maximum number of workforces returned in the response.
35	MaxResults *int32
36
37	// A filter you can use to search for workforces using part of the workforce name.
38	NameContains *string
39
40	// A token to resume pagination.
41	NextToken *string
42
43	// Sort workforces using the workforce name or creation date.
44	SortBy types.ListWorkforcesSortByOptions
45
46	// Sort workforces in ascending or descending order.
47	SortOrder types.SortOrder
48}
49
50type ListWorkforcesOutput struct {
51
52	// A list containing information about your workforce.
53	//
54	// This member is required.
55	Workforces []types.Workforce
56
57	// A token to resume pagination.
58	NextToken *string
59
60	// Metadata pertaining to the operation's result.
61	ResultMetadata middleware.Metadata
62}
63
64func addOperationListWorkforcesMiddlewares(stack *middleware.Stack, options Options) (err error) {
65	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListWorkforces{}, middleware.After)
66	if err != nil {
67		return err
68	}
69	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListWorkforces{}, middleware.After)
70	if err != nil {
71		return err
72	}
73	if err = addSetLoggerMiddleware(stack, options); err != nil {
74		return err
75	}
76	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
77		return err
78	}
79	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
80		return err
81	}
82	if err = addResolveEndpointMiddleware(stack, options); err != nil {
83		return err
84	}
85	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
86		return err
87	}
88	if err = addRetryMiddlewares(stack, options); err != nil {
89		return err
90	}
91	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
98		return err
99	}
100	if err = addClientUserAgent(stack); err != nil {
101		return err
102	}
103	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
107		return err
108	}
109	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListWorkforces(options.Region), middleware.Before); err != nil {
110		return err
111	}
112	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addResponseErrorMiddleware(stack); err != nil {
116		return err
117	}
118	if err = addRequestResponseLogging(stack, options); err != nil {
119		return err
120	}
121	return nil
122}
123
124// ListWorkforcesAPIClient is a client that implements the ListWorkforces
125// operation.
126type ListWorkforcesAPIClient interface {
127	ListWorkforces(context.Context, *ListWorkforcesInput, ...func(*Options)) (*ListWorkforcesOutput, error)
128}
129
130var _ ListWorkforcesAPIClient = (*Client)(nil)
131
132// ListWorkforcesPaginatorOptions is the paginator options for ListWorkforces
133type ListWorkforcesPaginatorOptions struct {
134	// The maximum number of workforces returned in the response.
135	Limit int32
136
137	// Set to true if pagination should stop if the service returns a pagination token
138	// that matches the most recent token provided to the service.
139	StopOnDuplicateToken bool
140}
141
142// ListWorkforcesPaginator is a paginator for ListWorkforces
143type ListWorkforcesPaginator struct {
144	options   ListWorkforcesPaginatorOptions
145	client    ListWorkforcesAPIClient
146	params    *ListWorkforcesInput
147	nextToken *string
148	firstPage bool
149}
150
151// NewListWorkforcesPaginator returns a new ListWorkforcesPaginator
152func NewListWorkforcesPaginator(client ListWorkforcesAPIClient, params *ListWorkforcesInput, optFns ...func(*ListWorkforcesPaginatorOptions)) *ListWorkforcesPaginator {
153	if params == nil {
154		params = &ListWorkforcesInput{}
155	}
156
157	options := ListWorkforcesPaginatorOptions{}
158	if params.MaxResults != nil {
159		options.Limit = *params.MaxResults
160	}
161
162	for _, fn := range optFns {
163		fn(&options)
164	}
165
166	return &ListWorkforcesPaginator{
167		options:   options,
168		client:    client,
169		params:    params,
170		firstPage: true,
171	}
172}
173
174// HasMorePages returns a boolean indicating whether more pages are available
175func (p *ListWorkforcesPaginator) HasMorePages() bool {
176	return p.firstPage || p.nextToken != nil
177}
178
179// NextPage retrieves the next ListWorkforces page.
180func (p *ListWorkforcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkforcesOutput, error) {
181	if !p.HasMorePages() {
182		return nil, fmt.Errorf("no more pages available")
183	}
184
185	params := *p.params
186	params.NextToken = p.nextToken
187
188	var limit *int32
189	if p.options.Limit > 0 {
190		limit = &p.options.Limit
191	}
192	params.MaxResults = limit
193
194	result, err := p.client.ListWorkforces(ctx, &params, optFns...)
195	if err != nil {
196		return nil, err
197	}
198	p.firstPage = false
199
200	prevToken := p.nextToken
201	p.nextToken = result.NextToken
202
203	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
204		p.nextToken = nil
205	}
206
207	return result, nil
208}
209
210func newServiceMetadataMiddleware_opListWorkforces(region string) *awsmiddleware.RegisterServiceMetadata {
211	return &awsmiddleware.RegisterServiceMetadata{
212		Region:        region,
213		ServiceID:     ServiceID,
214		SigningName:   "sagemaker",
215		OperationName: "ListWorkforces",
216	}
217}
218