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	"time"
14)
15
16// Lists models created with the CreateModel API.
17func (c *Client) ListModels(ctx context.Context, params *ListModelsInput, optFns ...func(*Options)) (*ListModelsOutput, error) {
18	if params == nil {
19		params = &ListModelsInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "ListModels", params, optFns, addOperationListModelsMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*ListModelsOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type ListModelsInput struct {
33
34	// A filter that returns only models with a creation time greater than or equal to
35	// the specified time (timestamp).
36	CreationTimeAfter *time.Time
37
38	// A filter that returns only models created before the specified time (timestamp).
39	CreationTimeBefore *time.Time
40
41	// The maximum number of models to return in the response.
42	MaxResults *int32
43
44	// A string in the training job name. This filter returns only models in the
45	// training job whose name contains the specified string.
46	NameContains *string
47
48	// If the response to a previous ListModels request was truncated, the response
49	// includes a NextToken. To retrieve the next set of models, use the token in the
50	// next request.
51	NextToken *string
52
53	// Sorts the list of results. The default is CreationTime.
54	SortBy types.ModelSortKey
55
56	// The sort order for results. The default is Descending.
57	SortOrder types.OrderKey
58}
59
60type ListModelsOutput struct {
61
62	// An array of ModelSummary objects, each of which lists a model.
63	//
64	// This member is required.
65	Models []types.ModelSummary
66
67	// If the response is truncated, Amazon SageMaker returns this token. To retrieve
68	// the next set of models, use it in the subsequent request.
69	NextToken *string
70
71	// Metadata pertaining to the operation's result.
72	ResultMetadata middleware.Metadata
73}
74
75func addOperationListModelsMiddlewares(stack *middleware.Stack, options Options) (err error) {
76	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListModels{}, middleware.After)
77	if err != nil {
78		return err
79	}
80	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListModels{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	if err = addSetLoggerMiddleware(stack, options); err != nil {
85		return err
86	}
87	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
88		return err
89	}
90	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
91		return err
92	}
93	if err = addResolveEndpointMiddleware(stack, options); err != nil {
94		return err
95	}
96	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
97		return err
98	}
99	if err = addRetryMiddlewares(stack, options); err != nil {
100		return err
101	}
102	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
109		return err
110	}
111	if err = addClientUserAgent(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListModels(options.Region), middleware.Before); err != nil {
121		return err
122	}
123	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addResponseErrorMiddleware(stack); err != nil {
127		return err
128	}
129	if err = addRequestResponseLogging(stack, options); err != nil {
130		return err
131	}
132	return nil
133}
134
135// ListModelsAPIClient is a client that implements the ListModels operation.
136type ListModelsAPIClient interface {
137	ListModels(context.Context, *ListModelsInput, ...func(*Options)) (*ListModelsOutput, error)
138}
139
140var _ ListModelsAPIClient = (*Client)(nil)
141
142// ListModelsPaginatorOptions is the paginator options for ListModels
143type ListModelsPaginatorOptions struct {
144	// The maximum number of models to return in the response.
145	Limit int32
146
147	// Set to true if pagination should stop if the service returns a pagination token
148	// that matches the most recent token provided to the service.
149	StopOnDuplicateToken bool
150}
151
152// ListModelsPaginator is a paginator for ListModels
153type ListModelsPaginator struct {
154	options   ListModelsPaginatorOptions
155	client    ListModelsAPIClient
156	params    *ListModelsInput
157	nextToken *string
158	firstPage bool
159}
160
161// NewListModelsPaginator returns a new ListModelsPaginator
162func NewListModelsPaginator(client ListModelsAPIClient, params *ListModelsInput, optFns ...func(*ListModelsPaginatorOptions)) *ListModelsPaginator {
163	if params == nil {
164		params = &ListModelsInput{}
165	}
166
167	options := ListModelsPaginatorOptions{}
168	if params.MaxResults != nil {
169		options.Limit = *params.MaxResults
170	}
171
172	for _, fn := range optFns {
173		fn(&options)
174	}
175
176	return &ListModelsPaginator{
177		options:   options,
178		client:    client,
179		params:    params,
180		firstPage: true,
181	}
182}
183
184// HasMorePages returns a boolean indicating whether more pages are available
185func (p *ListModelsPaginator) HasMorePages() bool {
186	return p.firstPage || p.nextToken != nil
187}
188
189// NextPage retrieves the next ListModels page.
190func (p *ListModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelsOutput, error) {
191	if !p.HasMorePages() {
192		return nil, fmt.Errorf("no more pages available")
193	}
194
195	params := *p.params
196	params.NextToken = p.nextToken
197
198	var limit *int32
199	if p.options.Limit > 0 {
200		limit = &p.options.Limit
201	}
202	params.MaxResults = limit
203
204	result, err := p.client.ListModels(ctx, &params, optFns...)
205	if err != nil {
206		return nil, err
207	}
208	p.firstPage = false
209
210	prevToken := p.nextToken
211	p.nextToken = result.NextToken
212
213	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
214		p.nextToken = nil
215	}
216
217	return result, nil
218}
219
220func newServiceMetadataMiddleware_opListModels(region string) *awsmiddleware.RegisterServiceMetadata {
221	return &awsmiddleware.RegisterServiceMetadata{
222		Region:        region,
223		ServiceID:     ServiceID,
224		SigningName:   "sagemaker",
225		OperationName: "ListModels",
226	}
227}
228