1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package comprehend
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/comprehend/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Gets a list of the properties of all entity recognizers that you created,
16// including recognizers currently in training. Allows you to filter the list of
17// recognizers based on criteria such as status and submission time. This call
18// returns up to 500 entity recognizers in the list, with a default number of 100
19// recognizers in the list. The results of this list are not in any particular
20// order. Please get the list and sort locally if needed.
21func (c *Client) ListEntityRecognizers(ctx context.Context, params *ListEntityRecognizersInput, optFns ...func(*Options)) (*ListEntityRecognizersOutput, error) {
22	if params == nil {
23		params = &ListEntityRecognizersInput{}
24	}
25
26	result, metadata, err := c.invokeOperation(ctx, "ListEntityRecognizers", params, optFns, addOperationListEntityRecognizersMiddlewares)
27	if err != nil {
28		return nil, err
29	}
30
31	out := result.(*ListEntityRecognizersOutput)
32	out.ResultMetadata = metadata
33	return out, nil
34}
35
36type ListEntityRecognizersInput struct {
37
38	// Filters the list of entities returned. You can filter on Status,
39	// SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
40	Filter *types.EntityRecognizerFilter
41
42	// The maximum number of results to return on each page. The default is 100.
43	MaxResults *int32
44
45	// Identifies the next page of results to return.
46	NextToken *string
47}
48
49type ListEntityRecognizersOutput struct {
50
51	// The list of properties of an entity recognizer.
52	EntityRecognizerPropertiesList []types.EntityRecognizerProperties
53
54	// Identifies the next page of results to return.
55	NextToken *string
56
57	// Metadata pertaining to the operation's result.
58	ResultMetadata middleware.Metadata
59}
60
61func addOperationListEntityRecognizersMiddlewares(stack *middleware.Stack, options Options) (err error) {
62	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListEntityRecognizers{}, middleware.After)
63	if err != nil {
64		return err
65	}
66	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListEntityRecognizers{}, middleware.After)
67	if err != nil {
68		return err
69	}
70	if err = addSetLoggerMiddleware(stack, options); err != nil {
71		return err
72	}
73	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
74		return err
75	}
76	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
77		return err
78	}
79	if err = addResolveEndpointMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
83		return err
84	}
85	if err = addRetryMiddlewares(stack, options); err != nil {
86		return err
87	}
88	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
89		return err
90	}
91	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
95		return err
96	}
97	if err = addClientUserAgent(stack); err != nil {
98		return err
99	}
100	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
101		return err
102	}
103	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
104		return err
105	}
106	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListEntityRecognizers(options.Region), middleware.Before); err != nil {
107		return err
108	}
109	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
110		return err
111	}
112	if err = addResponseErrorMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addRequestResponseLogging(stack, options); err != nil {
116		return err
117	}
118	return nil
119}
120
121// ListEntityRecognizersAPIClient is a client that implements the
122// ListEntityRecognizers operation.
123type ListEntityRecognizersAPIClient interface {
124	ListEntityRecognizers(context.Context, *ListEntityRecognizersInput, ...func(*Options)) (*ListEntityRecognizersOutput, error)
125}
126
127var _ ListEntityRecognizersAPIClient = (*Client)(nil)
128
129// ListEntityRecognizersPaginatorOptions is the paginator options for
130// ListEntityRecognizers
131type ListEntityRecognizersPaginatorOptions struct {
132	// The maximum number of results to return on each page. The default is 100.
133	Limit int32
134
135	// Set to true if pagination should stop if the service returns a pagination token
136	// that matches the most recent token provided to the service.
137	StopOnDuplicateToken bool
138}
139
140// ListEntityRecognizersPaginator is a paginator for ListEntityRecognizers
141type ListEntityRecognizersPaginator struct {
142	options   ListEntityRecognizersPaginatorOptions
143	client    ListEntityRecognizersAPIClient
144	params    *ListEntityRecognizersInput
145	nextToken *string
146	firstPage bool
147}
148
149// NewListEntityRecognizersPaginator returns a new ListEntityRecognizersPaginator
150func NewListEntityRecognizersPaginator(client ListEntityRecognizersAPIClient, params *ListEntityRecognizersInput, optFns ...func(*ListEntityRecognizersPaginatorOptions)) *ListEntityRecognizersPaginator {
151	if params == nil {
152		params = &ListEntityRecognizersInput{}
153	}
154
155	options := ListEntityRecognizersPaginatorOptions{}
156	if params.MaxResults != nil {
157		options.Limit = *params.MaxResults
158	}
159
160	for _, fn := range optFns {
161		fn(&options)
162	}
163
164	return &ListEntityRecognizersPaginator{
165		options:   options,
166		client:    client,
167		params:    params,
168		firstPage: true,
169	}
170}
171
172// HasMorePages returns a boolean indicating whether more pages are available
173func (p *ListEntityRecognizersPaginator) HasMorePages() bool {
174	return p.firstPage || p.nextToken != nil
175}
176
177// NextPage retrieves the next ListEntityRecognizers page.
178func (p *ListEntityRecognizersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEntityRecognizersOutput, error) {
179	if !p.HasMorePages() {
180		return nil, fmt.Errorf("no more pages available")
181	}
182
183	params := *p.params
184	params.NextToken = p.nextToken
185
186	var limit *int32
187	if p.options.Limit > 0 {
188		limit = &p.options.Limit
189	}
190	params.MaxResults = limit
191
192	result, err := p.client.ListEntityRecognizers(ctx, &params, optFns...)
193	if err != nil {
194		return nil, err
195	}
196	p.firstPage = false
197
198	prevToken := p.nextToken
199	p.nextToken = result.NextToken
200
201	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
202		p.nextToken = nil
203	}
204
205	return result, nil
206}
207
208func newServiceMetadataMiddleware_opListEntityRecognizers(region string) *awsmiddleware.RegisterServiceMetadata {
209	return &awsmiddleware.RegisterServiceMetadata{
210		Region:        region,
211		ServiceID:     ServiceID,
212		SigningName:   "comprehend",
213		OperationName: "ListEntityRecognizers",
214	}
215}
216