File: api_op_ListModelCardExportJobs.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (266 lines) | stat: -rw-r--r-- 8,204 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
// Code generated by smithy-go-codegen DO NOT EDIT.

package sagemaker

import (
	"context"
	"fmt"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
	"github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
	"time"
)

// List the export jobs for the Amazon SageMaker Model Card.
func (c *Client) ListModelCardExportJobs(ctx context.Context, params *ListModelCardExportJobsInput, optFns ...func(*Options)) (*ListModelCardExportJobsOutput, error) {
	if params == nil {
		params = &ListModelCardExportJobsInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "ListModelCardExportJobs", params, optFns, c.addOperationListModelCardExportJobsMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*ListModelCardExportJobsOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type ListModelCardExportJobsInput struct {

	// List export jobs for the model card with the specified name.
	//
	// This member is required.
	ModelCardName *string

	// Only list model card export jobs that were created after the time specified.
	CreationTimeAfter *time.Time

	// Only list model card export jobs that were created before the time specified.
	CreationTimeBefore *time.Time

	// The maximum number of model card export jobs to list.
	MaxResults *int32

	// Only list model card export jobs with names that contain the specified string.
	ModelCardExportJobNameContains *string

	// List export jobs for the model card with the specified version.
	ModelCardVersion *int32

	// If the response to a previous ListModelCardExportJobs request was truncated,
	// the response includes a NextToken . To retrieve the next set of model card
	// export jobs, use the token in the next request.
	NextToken *string

	// Sort model card export jobs by either name or creation time. Sorts by creation
	// time by default.
	SortBy types.ModelCardExportJobSortBy

	// Sort model card export jobs by ascending or descending order.
	SortOrder types.ModelCardExportJobSortOrder

	// Only list model card export jobs with the specified status.
	StatusEquals types.ModelCardExportJobStatus

	noSmithyDocumentSerde
}

type ListModelCardExportJobsOutput struct {

	// The summaries of the listed model card export jobs.
	//
	// This member is required.
	ModelCardExportJobSummaries []types.ModelCardExportJobSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of model card export jobs, use it in the subsequent request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationListModelCardExportJobsMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListModelCardExportJobs{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListModelCardExportJobs{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "ListModelCardExportJobs"); err != nil {
		return fmt.Errorf("add protocol finalizers: %v", err)
	}

	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
		return err
	}
	if err = addSetLoggerMiddleware(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
		return err
	}
	if err = addRetryMiddlewares(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addClientUserAgent(stack, options); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
		return err
	}
	if err = addOpListModelCardExportJobsValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListModelCardExportJobs(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
		return err
	}
	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
		return err
	}
	if err = addResponseErrorMiddleware(stack); err != nil {
		return err
	}
	if err = addRequestResponseLogging(stack, options); err != nil {
		return err
	}
	if err = addDisableHTTPSMiddleware(stack, options); err != nil {
		return err
	}
	return nil
}

// ListModelCardExportJobsAPIClient is a client that implements the
// ListModelCardExportJobs operation.
type ListModelCardExportJobsAPIClient interface {
	ListModelCardExportJobs(context.Context, *ListModelCardExportJobsInput, ...func(*Options)) (*ListModelCardExportJobsOutput, error)
}

var _ ListModelCardExportJobsAPIClient = (*Client)(nil)

// ListModelCardExportJobsPaginatorOptions is the paginator options for
// ListModelCardExportJobs
type ListModelCardExportJobsPaginatorOptions struct {
	// The maximum number of model card export jobs to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

// ListModelCardExportJobsPaginator is a paginator for ListModelCardExportJobs
type ListModelCardExportJobsPaginator struct {
	options   ListModelCardExportJobsPaginatorOptions
	client    ListModelCardExportJobsAPIClient
	params    *ListModelCardExportJobsInput
	nextToken *string
	firstPage bool
}

// NewListModelCardExportJobsPaginator returns a new
// ListModelCardExportJobsPaginator
func NewListModelCardExportJobsPaginator(client ListModelCardExportJobsAPIClient, params *ListModelCardExportJobsInput, optFns ...func(*ListModelCardExportJobsPaginatorOptions)) *ListModelCardExportJobsPaginator {
	if params == nil {
		params = &ListModelCardExportJobsInput{}
	}

	options := ListModelCardExportJobsPaginatorOptions{}
	if params.MaxResults != nil {
		options.Limit = *params.MaxResults
	}

	for _, fn := range optFns {
		fn(&options)
	}

	return &ListModelCardExportJobsPaginator{
		options:   options,
		client:    client,
		params:    params,
		firstPage: true,
		nextToken: params.NextToken,
	}
}

// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListModelCardExportJobsPaginator) HasMorePages() bool {
	return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}

// NextPage retrieves the next ListModelCardExportJobs page.
func (p *ListModelCardExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelCardExportJobsOutput, error) {
	if !p.HasMorePages() {
		return nil, fmt.Errorf("no more pages available")
	}

	params := *p.params
	params.NextToken = p.nextToken

	var limit *int32
	if p.options.Limit > 0 {
		limit = &p.options.Limit
	}
	params.MaxResults = limit

	result, err := p.client.ListModelCardExportJobs(ctx, &params, optFns...)
	if err != nil {
		return nil, err
	}
	p.firstPage = false

	prevToken := p.nextToken
	p.nextToken = result.NextToken

	if p.options.StopOnDuplicateToken &&
		prevToken != nil &&
		p.nextToken != nil &&
		*prevToken == *p.nextToken {
		p.nextToken = nil
	}

	return result, nil
}

func newServiceMetadataMiddleware_opListModelCardExportJobs(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "ListModelCardExportJobs",
	}
}