File: api_op_ListGroupsOlderThanOrderingId.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 (260 lines) | stat: -rw-r--r-- 8,498 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
// Code generated by smithy-go-codegen DO NOT EDIT.

package kendra

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/kendra/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

// Provides a list of groups that are mapped to users before a given ordering or
// timestamp identifier. ListGroupsOlderThanOrderingId is currently not supported
// in the Amazon Web Services GovCloud (US-West) region.
func (c *Client) ListGroupsOlderThanOrderingId(ctx context.Context, params *ListGroupsOlderThanOrderingIdInput, optFns ...func(*Options)) (*ListGroupsOlderThanOrderingIdOutput, error) {
	if params == nil {
		params = &ListGroupsOlderThanOrderingIdInput{}
	}

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

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

type ListGroupsOlderThanOrderingIdInput struct {

	// The identifier of the index for getting a list of groups mapped to users before
	// a given ordering or timestamp identifier.
	//
	// This member is required.
	IndexId *string

	// The timestamp identifier used for the latest PUT or DELETE action for mapping
	// users to their groups.
	//
	// This member is required.
	OrderingId *int64

	// The identifier of the data source for getting a list of groups mapped to users
	// before a given ordering timestamp identifier.
	DataSourceId *string

	// The maximum number of returned groups that are mapped to users before a given
	// ordering or timestamp identifier.
	MaxResults *int32

	// If the previous response was incomplete (because there is more data to
	// retrieve), Amazon Kendra returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of groups that are mapped to
	// users before a given ordering or timestamp identifier.
	NextToken *string

	noSmithyDocumentSerde
}

type ListGroupsOlderThanOrderingIdOutput struct {

	// Summary information for list of groups that are mapped to users before a given
	// ordering or timestamp identifier.
	GroupsSummaries []types.GroupSummary

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of groups that are mapped to
	// users before a given ordering or timestamp identifier.
	NextToken *string

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

	noSmithyDocumentSerde
}

func (c *Client) addOperationListGroupsOlderThanOrderingIdMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListGroupsOlderThanOrderingId{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListGroupsOlderThanOrderingId{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "ListGroupsOlderThanOrderingId"); 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 = addOpListGroupsOlderThanOrderingIdValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListGroupsOlderThanOrderingId(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
}

// ListGroupsOlderThanOrderingIdAPIClient is a client that implements the
// ListGroupsOlderThanOrderingId operation.
type ListGroupsOlderThanOrderingIdAPIClient interface {
	ListGroupsOlderThanOrderingId(context.Context, *ListGroupsOlderThanOrderingIdInput, ...func(*Options)) (*ListGroupsOlderThanOrderingIdOutput, error)
}

var _ ListGroupsOlderThanOrderingIdAPIClient = (*Client)(nil)

// ListGroupsOlderThanOrderingIdPaginatorOptions is the paginator options for
// ListGroupsOlderThanOrderingId
type ListGroupsOlderThanOrderingIdPaginatorOptions struct {
	// The maximum number of returned groups that are mapped to users before a given
	// ordering or timestamp identifier.
	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
}

// ListGroupsOlderThanOrderingIdPaginator is a paginator for
// ListGroupsOlderThanOrderingId
type ListGroupsOlderThanOrderingIdPaginator struct {
	options   ListGroupsOlderThanOrderingIdPaginatorOptions
	client    ListGroupsOlderThanOrderingIdAPIClient
	params    *ListGroupsOlderThanOrderingIdInput
	nextToken *string
	firstPage bool
}

// NewListGroupsOlderThanOrderingIdPaginator returns a new
// ListGroupsOlderThanOrderingIdPaginator
func NewListGroupsOlderThanOrderingIdPaginator(client ListGroupsOlderThanOrderingIdAPIClient, params *ListGroupsOlderThanOrderingIdInput, optFns ...func(*ListGroupsOlderThanOrderingIdPaginatorOptions)) *ListGroupsOlderThanOrderingIdPaginator {
	if params == nil {
		params = &ListGroupsOlderThanOrderingIdInput{}
	}

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

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

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

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

// NextPage retrieves the next ListGroupsOlderThanOrderingId page.
func (p *ListGroupsOlderThanOrderingIdPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOlderThanOrderingIdOutput, 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.ListGroupsOlderThanOrderingId(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_opListGroupsOlderThanOrderingId(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "ListGroupsOlderThanOrderingId",
	}
}