1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package glue
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/glue/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Gets a list of runs for a machine learning transform. Machine learning task runs
16// are asynchronous tasks that AWS Glue runs on your behalf as part of various
17// machine learning workflows. You can get a sortable, filterable list of machine
18// learning task runs by calling GetMLTaskRuns with their parent transform's
19// TransformID and other optional parameters as documented in this section. This
20// operation returns a list of historic runs and must be paginated.
21func (c *Client) GetMLTaskRuns(ctx context.Context, params *GetMLTaskRunsInput, optFns ...func(*Options)) (*GetMLTaskRunsOutput, error) {
22	if params == nil {
23		params = &GetMLTaskRunsInput{}
24	}
25
26	result, metadata, err := c.invokeOperation(ctx, "GetMLTaskRuns", params, optFns, addOperationGetMLTaskRunsMiddlewares)
27	if err != nil {
28		return nil, err
29	}
30
31	out := result.(*GetMLTaskRunsOutput)
32	out.ResultMetadata = metadata
33	return out, nil
34}
35
36type GetMLTaskRunsInput struct {
37
38	// The unique identifier of the machine learning transform.
39	//
40	// This member is required.
41	TransformId *string
42
43	// The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
44	Filter *types.TaskRunFilterCriteria
45
46	// The maximum number of results to return.
47	MaxResults *int32
48
49	// A token for pagination of the results. The default is empty.
50	NextToken *string
51
52	// The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
53	Sort *types.TaskRunSortCriteria
54}
55
56type GetMLTaskRunsOutput struct {
57
58	// A pagination token, if more results are available.
59	NextToken *string
60
61	// A list of task runs that are associated with the transform.
62	TaskRuns []types.TaskRun
63
64	// Metadata pertaining to the operation's result.
65	ResultMetadata middleware.Metadata
66}
67
68func addOperationGetMLTaskRunsMiddlewares(stack *middleware.Stack, options Options) (err error) {
69	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetMLTaskRuns{}, middleware.After)
70	if err != nil {
71		return err
72	}
73	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetMLTaskRuns{}, middleware.After)
74	if err != nil {
75		return err
76	}
77	if err = addSetLoggerMiddleware(stack, options); err != nil {
78		return err
79	}
80	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
81		return err
82	}
83	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
84		return err
85	}
86	if err = addResolveEndpointMiddleware(stack, options); err != nil {
87		return err
88	}
89	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
90		return err
91	}
92	if err = addRetryMiddlewares(stack, options); err != nil {
93		return err
94	}
95	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
96		return err
97	}
98	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
99		return err
100	}
101	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
102		return err
103	}
104	if err = addClientUserAgent(stack); err != nil {
105		return err
106	}
107	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
108		return err
109	}
110	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
111		return err
112	}
113	if err = addOpGetMLTaskRunsValidationMiddleware(stack); err != nil {
114		return err
115	}
116	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetMLTaskRuns(options.Region), middleware.Before); err != nil {
117		return err
118	}
119	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
120		return err
121	}
122	if err = addResponseErrorMiddleware(stack); err != nil {
123		return err
124	}
125	if err = addRequestResponseLogging(stack, options); err != nil {
126		return err
127	}
128	return nil
129}
130
131// GetMLTaskRunsAPIClient is a client that implements the GetMLTaskRuns operation.
132type GetMLTaskRunsAPIClient interface {
133	GetMLTaskRuns(context.Context, *GetMLTaskRunsInput, ...func(*Options)) (*GetMLTaskRunsOutput, error)
134}
135
136var _ GetMLTaskRunsAPIClient = (*Client)(nil)
137
138// GetMLTaskRunsPaginatorOptions is the paginator options for GetMLTaskRuns
139type GetMLTaskRunsPaginatorOptions struct {
140	// The maximum number of results to return.
141	Limit int32
142
143	// Set to true if pagination should stop if the service returns a pagination token
144	// that matches the most recent token provided to the service.
145	StopOnDuplicateToken bool
146}
147
148// GetMLTaskRunsPaginator is a paginator for GetMLTaskRuns
149type GetMLTaskRunsPaginator struct {
150	options   GetMLTaskRunsPaginatorOptions
151	client    GetMLTaskRunsAPIClient
152	params    *GetMLTaskRunsInput
153	nextToken *string
154	firstPage bool
155}
156
157// NewGetMLTaskRunsPaginator returns a new GetMLTaskRunsPaginator
158func NewGetMLTaskRunsPaginator(client GetMLTaskRunsAPIClient, params *GetMLTaskRunsInput, optFns ...func(*GetMLTaskRunsPaginatorOptions)) *GetMLTaskRunsPaginator {
159	options := GetMLTaskRunsPaginatorOptions{}
160	if params.MaxResults != nil {
161		options.Limit = *params.MaxResults
162	}
163
164	for _, fn := range optFns {
165		fn(&options)
166	}
167
168	if params == nil {
169		params = &GetMLTaskRunsInput{}
170	}
171
172	return &GetMLTaskRunsPaginator{
173		options:   options,
174		client:    client,
175		params:    params,
176		firstPage: true,
177	}
178}
179
180// HasMorePages returns a boolean indicating whether more pages are available
181func (p *GetMLTaskRunsPaginator) HasMorePages() bool {
182	return p.firstPage || p.nextToken != nil
183}
184
185// NextPage retrieves the next GetMLTaskRuns page.
186func (p *GetMLTaskRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetMLTaskRunsOutput, error) {
187	if !p.HasMorePages() {
188		return nil, fmt.Errorf("no more pages available")
189	}
190
191	params := *p.params
192	params.NextToken = p.nextToken
193
194	var limit *int32
195	if p.options.Limit > 0 {
196		limit = &p.options.Limit
197	}
198	params.MaxResults = limit
199
200	result, err := p.client.GetMLTaskRuns(ctx, &params, optFns...)
201	if err != nil {
202		return nil, err
203	}
204	p.firstPage = false
205
206	prevToken := p.nextToken
207	p.nextToken = result.NextToken
208
209	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
210		p.nextToken = nil
211	}
212
213	return result, nil
214}
215
216func newServiceMetadataMiddleware_opGetMLTaskRuns(region string) *awsmiddleware.RegisterServiceMetadata {
217	return &awsmiddleware.RegisterServiceMetadata{
218		Region:        region,
219		ServiceID:     ServiceID,
220		SigningName:   "glue",
221		OperationName: "GetMLTaskRuns",
222	}
223}
224