File: api_op_SearchAgreements.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (310 lines) | stat: -rw-r--r-- 9,485 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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
// Code generated by smithy-go-codegen DO NOT EDIT.

package marketplaceagreement

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

// Searches across all agreements that a proposer or an acceptor has in AWS
// Marketplace. The search returns a list of agreements with basic agreement
// information.
//
// The following filter combinations are supported:
//
//   - PartyType as Proposer + AgreementType + ResourceIdentifier
//
//   - PartyType as Proposer + AgreementType + OfferId
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId
//
//   - PartyType as Proposer + AgreementType + Status
//
//   - PartyType as Proposer + AgreementType + ResourceIdentifier + Status
//
//   - PartyType as Proposer + AgreementType + OfferId + Status
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId + Status
//
//   - PartyType as Proposer + AgreementType + ResourceType + Status
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType +
//     Status
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId + Status
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId +
//     ResourceIdentifier
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId +
//     ResourceIdentifier + Status
//
//   - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType
func (c *Client) SearchAgreements(ctx context.Context, params *SearchAgreementsInput, optFns ...func(*Options)) (*SearchAgreementsOutput, error) {
	if params == nil {
		params = &SearchAgreementsInput{}
	}

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

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

type SearchAgreementsInput struct {

	// The catalog in which the agreement was created.
	Catalog *string

	// The filter name and value pair used to return a specific list of results.
	//
	// The following filters are supported:
	//
	//   - ResourceIdentifier – The unique identifier of the resource.
	//
	//   - ResourceType – Type of the resource, which is the product ( AmiProduct ,
	//   ContainerProduct , or SaaSProduct ).
	//
	//   - PartyType – The party type (either Acceptor or Proposer ) of the caller. For
	//   agreements where the caller is the proposer, use the Proposer filter. For
	//   agreements where the caller is the acceptor, use the Acceptor filter.
	//
	//   - AcceptorAccountId – The AWS account ID of the party accepting the agreement
	//   terms.
	//
	//   - OfferId – The unique identifier of the offer in which the terms are
	//   registered in the agreement token.
	//
	//   - Status – The current status of the agreement. Values include ACTIVE ,
	//   ARCHIVED , CANCELLED , EXPIRED , RENEWED , REPLACED , and TERMINATED .
	//
	//   - BeforeEndTime – A date used to filter agreements with a date before the
	//   endTime of an agreement.
	//
	//   - AfterEndTime – A date used to filter agreements with a date after the
	//   endTime of an agreement.
	//
	//   - AgreementType – The type of agreement. Values include PurchaseAgreement or
	//   VendorInsightsAgreement .
	Filters []types.Filter

	// The maximum number of agreements to return in the response.
	MaxResults *int32

	// A token to specify where to start pagination.
	NextToken *string

	// An object that contains the SortBy and SortOrder attributes.
	Sort *types.Sort

	noSmithyDocumentSerde
}

type SearchAgreementsOutput struct {

	// A summary of the agreement, including top-level attributes (for example, the
	// agreement ID, version, proposer, and acceptor).
	AgreementViewSummaries []types.AgreementViewSummary

	// The token used for pagination. The field is null if there are no more results.
	NextToken *string

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

	noSmithyDocumentSerde
}

func (c *Client) addOperationSearchAgreementsMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsAwsjson10_serializeOpSearchAgreements{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpSearchAgreements{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "SearchAgreements"); 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 = addClientRequestID(stack); err != nil {
		return err
	}
	if err = addComputeContentLength(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = addComputePayloadSHA256(stack); err != nil {
		return err
	}
	if err = addRetry(stack, options); err != nil {
		return err
	}
	if err = addRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
		return err
	}
	if err = addUserAgentRetryMode(stack, options); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchAgreements(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = 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
}

// SearchAgreementsPaginatorOptions is the paginator options for SearchAgreements
type SearchAgreementsPaginatorOptions struct {
	// The maximum number of agreements to return in the response.
	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
}

// SearchAgreementsPaginator is a paginator for SearchAgreements
type SearchAgreementsPaginator struct {
	options   SearchAgreementsPaginatorOptions
	client    SearchAgreementsAPIClient
	params    *SearchAgreementsInput
	nextToken *string
	firstPage bool
}

// NewSearchAgreementsPaginator returns a new SearchAgreementsPaginator
func NewSearchAgreementsPaginator(client SearchAgreementsAPIClient, params *SearchAgreementsInput, optFns ...func(*SearchAgreementsPaginatorOptions)) *SearchAgreementsPaginator {
	if params == nil {
		params = &SearchAgreementsInput{}
	}

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

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

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

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

// NextPage retrieves the next SearchAgreements page.
func (p *SearchAgreementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAgreementsOutput, 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

	optFns = append([]func(*Options){
		addIsPaginatorUserAgent,
	}, optFns...)
	result, err := p.client.SearchAgreements(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
}

// SearchAgreementsAPIClient is a client that implements the SearchAgreements
// operation.
type SearchAgreementsAPIClient interface {
	SearchAgreements(context.Context, *SearchAgreementsInput, ...func(*Options)) (*SearchAgreementsOutput, error)
}

var _ SearchAgreementsAPIClient = (*Client)(nil)

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