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