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