Debian Codegraph @

service/marketplaceagreement/api.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 package marketplaceagreement
4
5 import (
6 "fmt"
7 "time"
8
9 "github.com/aws/aws-sdk-go/aws"
10 "github.com/aws/aws-sdk-go/aws/awsutil"
11 "github.com/aws/aws-sdk-go/aws/request"
12 "github.com/aws/aws-sdk-go/private/protocol"
13 )
14
15 const opDescribeAgreement = "DescribeAgreement"
16
17 // DescribeAgreementRequest generates a "aws/request.Request" representing the
18 // client's request for the DescribeAgreement operation. The "output" return
19 // value will be populated with the request's response once the request completes
20 // successfully.
21 //
22 // Use "Send" method on the returned Request to send the API call to the service.
23 // the "output" return value is not valid until after Send returns without error.
24 //
25 // See DescribeAgreement for more information on using the DescribeAgreement
26 // API call, and error handling.
27 //
28 // This method is useful when you want to inject custom logic or configuration
29 // into the SDK's request lifecycle. Such as custom headers, or retry logic.
30 //
31 // // Example sending a request using the DescribeAgreementRequest method.
32 // req, resp := client.DescribeAgreementRequest(params)
33 //
34 // err := req.Send()
35 // if err == nil { // resp is now filled
36 // fmt.Println(resp)
37 // }
38 //
39 // See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/DescribeAgreement
40 func (c *MarketplaceAgreement) DescribeAgreementRequest(input *DescribeAgreementInput) (req *request.Request, output *DescribeAgreementOutput) {
41 op := &request.Operation{
42 Name: opDescribeAgreement,
43 HTTPMethod: "POST",
44 HTTPPath: "/",
45 }
46
47 if input == nil {
48 input = &DescribeAgreementInput{}
49 }
50
51 output = &DescribeAgreementOutput{}
52 req = c.newRequest(op, input, output)
53 return
54 }
55
56 // DescribeAgreement API operation for AWS Marketplace Agreement Service.
57 //
58 // Provides details about an agreement, such as the proposer, acceptor, start
59 // date, and end date.
60 //
61 // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
62 // with awserr.Error's Code and Message methods to get detailed information about
63 // the error.
64 //
65 // See the AWS API reference guide for AWS Marketplace Agreement Service's
66 // API operation DescribeAgreement for usage and error information.
67 //
68 // Returned Error Types:
69 //
70 // - ValidationException
71 // The input fails to satisfy the constraints specified by the service.
72 //
73 // - AccessDeniedException
74 // User does not have sufficient access to perform this action.
75 //
76 // - ThrottlingException
77 // Request was denied due to request throttling.
78 //
79 // - ResourceNotFoundException
80 // Request references a resource which does not exist.
81 //
82 // - InternalServerException
83 // Unexpected error during processing of request.
84 //
85 // See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/DescribeAgreement
86 func (c *MarketplaceAgreement) DescribeAgreement(input *DescribeAgreementInput) (*DescribeAgreementOutput, error) {
87 req, out := c.DescribeAgreementRequest(input)
88 return out, req.Send()
89 }
90
91 // DescribeAgreementWithContext is the same as DescribeAgreement with the addition of
92 // the ability to pass a context and additional request options.
93 //
94 // See DescribeAgreement for details on how to use this API operation.
95 //
96 // The context must be non-nil and will be used for request cancellation. If
97 // the context is nil a panic will occur. In the future the SDK may create
98 // sub-contexts for http.Requests. See https://golang.org/pkg/context/
99 // for more information on using Contexts.
100 func (c *MarketplaceAgreement) DescribeAgreementWithContext(ctx aws.Context, input *DescribeAgreementInput, opts ...request.Option) (*DescribeAgreementOutput, error) {
101 req, out := c.DescribeAgreementRequest(input)
102 req.SetContext(ctx)
103 req.ApplyOptions(opts...)
104 return out, req.Send()
105 }
106
107 const opGetAgreementTerms = "GetAgreementTerms"
108
109 // GetAgreementTermsRequest generates a "aws/request.Request" representing the
110 // client's request for the GetAgreementTerms operation. The "output" return
111 // value will be populated with the request's response once the request completes
112 // successfully.
113 //
114 // Use "Send" method on the returned Request to send the API call to the service.
115 // the "output" return value is not valid until after Send returns without error.
116 //
117 // See GetAgreementTerms for more information on using the GetAgreementTerms
118 // API call, and error handling.
119 //
120 // This method is useful when you want to inject custom logic or configuration
121 // into the SDK's request lifecycle. Such as custom headers, or retry logic.
122 //
123 // // Example sending a request using the GetAgreementTermsRequest method.
124 // req, resp := client.GetAgreementTermsRequest(params)
125 //
126 // err := req.Send()
127 // if err == nil { // resp is now filled
128 // fmt.Println(resp)
129 // }
130 //
131 // See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/GetAgreementTerms
132 func (c *MarketplaceAgreement) GetAgreementTermsRequest(input *GetAgreementTermsInput) (req *request.Request, output *GetAgreementTermsOutput) {
133 op := &request.Operation{
134 Name: opGetAgreementTerms,
135 HTTPMethod: "POST",
136 HTTPPath: "/",
137 Paginator: &request.Paginator{
138 InputTokens: []string{"nextToken"},
139 OutputTokens: []string{"nextToken"},
140 LimitToken: "maxResults",
141 TruncationToken: "",
142 },
143 }
144
145 if input == nil {
146 input = &GetAgreementTermsInput{}
147 }
148
149 output = &GetAgreementTermsOutput{}
150 req = c.newRequest(op, input, output)
151 return
152 }
153
154 // GetAgreementTerms API operation for AWS Marketplace Agreement Service.
155 //
156 // Obtains details about the terms in an agreement that you participated in
157 // as proposer or acceptor.
158 //
159 // The details include:
160 //
161 // - TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.
162 //
163 // - TermID – The ID of the particular term, which is common between offer
164 // and agreement.
165 //
166 // - TermPayload – The key information contained in the term, such as the
167 // EULA for LegalTerm or pricing and dimensions for various pricing terms,
168 // such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.
169 //
170 // - Configuration – The buyer/acceptor's selection at the time of agreement
171 // creation, such as the number of units purchased for a dimension or setting
172 // the EnableAutoRenew flag.
173 //
174 // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
175 // with awserr.Error's Code and Message methods to get detailed information about
176 // the error.
177 //
178 // See the AWS API reference guide for AWS Marketplace Agreement Service's
179 // API operation GetAgreementTerms for usage and error information.
180 //
181 // Returned Error Types:
182 //
183 // - ValidationException
184 // The input fails to satisfy the constraints specified by the service.
185 //
186 // - AccessDeniedException
187 // User does not have sufficient access to perform this action.
188 //
189 // - ThrottlingException
190 // Request was denied due to request throttling.
191 //
192 // - ResourceNotFoundException
193 // Request references a resource which does not exist.
194 //
195 // - InternalServerException
196 // Unexpected error during processing of request.
197 //
198 // See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/GetAgreementTerms
199 func (c *MarketplaceAgreement) GetAgreementTerms(input *GetAgreementTermsInput) (*GetAgreementTermsOutput, error) {
200 req, out := c.GetAgreementTermsRequest(input)
201 return out, req.Send()
202 }
203
204 // GetAgreementTermsWithContext is the same as GetAgreementTerms with the addition of
205 // the ability to pass a context and additional request options.
206 //
207 // See GetAgreementTerms for details on how to use this API operation.
208 //
209 // The context must be non-nil and will be used for request cancellation. If
210 // the context is nil a panic will occur. In the future the SDK may create
211 // sub-contexts for http.Requests. See https://golang.org/pkg/context/
212 // for more information on using Contexts.
213 func (c *MarketplaceAgreement) GetAgreementTermsWithContext(ctx aws.Context, input *GetAgreementTermsInput, opts ...request.Option) (*GetAgreementTermsOutput, error) {
214 req, out := c.GetAgreementTermsRequest(input)
215 req.SetContext(ctx)
216 req.ApplyOptions(opts...)
217 return out, req.Send()
218 }
219
220 // GetAgreementTermsPages iterates over the pages of a GetAgreementTerms operation,
221 // calling the "fn" function with the response data for each page. To stop
222 // iterating, return false from the fn function.
223 //
224 // See GetAgreementTerms method for more information on how to use this operation.
225 //
226 // Note: This operation can generate multiple requests to a service.
227 //
228 // // Example iterating over at most 3 pages of a GetAgreementTerms operation.
229 // pageNum := 0
230 // err := client.GetAgreementTermsPages(params,
231 // func(page *marketplaceagreement.GetAgreementTermsOutput, lastPage bool) bool {
232 // pageNum++
233 // fmt.Println(page)
234 // return pageNum <= 3
235 // })
236 func (c *MarketplaceAgreement) GetAgreementTermsPages(input *GetAgreementTermsInput, fn func(*GetAgreementTermsOutput, bool) bool) error {
237 return c.GetAgreementTermsPagesWithContext(aws.BackgroundContext(), input, fn)
238 }
239
240 // GetAgreementTermsPagesWithContext same as GetAgreementTermsPages except
241 // it takes a Context and allows setting request options on the pages.
242 //
243 // The context must be non-nil and will be used for request cancellation. If
244 // the context is nil a panic will occur. In the future the SDK may create
245 // sub-contexts for http.Requests. See https://golang.org/pkg/context/
246 // for more information on using Contexts.
247 func (c *MarketplaceAgreement) GetAgreementTermsPagesWithContext(ctx aws.Context, input *GetAgreementTermsInput, fn func(*GetAgreementTermsOutput, bool) bool, opts ...request.Option) error {
248 p := request.Pagination{
249 NewRequest: func() (*request.Request, error) {
250 var inCpy *GetAgreementTermsInput
251 if input != nil {
252 tmp := *input
253 inCpy = &tmp
254 }
255 req, _ := c.GetAgreementTermsRequest(inCpy)
256 req.SetContext(ctx)
257 req.ApplyOptions(opts...)
258 return req, nil
259 },
260 }
261
262 for p.Next() {
263 if !fn(p.Page().(*GetAgreementTermsOutput), !p.HasNextPage()) {
264 break
265 }
266 }
267
268 return p.Err()
269 }
270
271 const opSearchAgreements = "SearchAgreements"
272
273 // SearchAgreementsRequest generates a "aws/request.Request" representing the
274 // client's request for the SearchAgreements operation. The "output" return
275 // value will be populated with the request's response once the request completes
276 // successfully.
277 //
278 // Use "Send" method on the returned Request to send the API call to the service.
279 // the "output" return value is not valid until after Send returns without error.
280 //
281 // See SearchAgreements for more information on using the SearchAgreements
282 // API call, and error handling.
283 //
284 // This method is useful when you want to inject custom logic or configuration
285 // into the SDK's request lifecycle. Such as custom headers, or retry logic.
286 //
287 // // Example sending a request using the SearchAgreementsRequest method.
288 // req, resp := client.SearchAgreementsRequest(params)
289 //
290 // err := req.Send()
291 // if err == nil { // resp is now filled
292 // fmt.Println(resp)
293 // }
294 //
295 // See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/SearchAgreements
296 func (c *MarketplaceAgreement) SearchAgreementsRequest(input *SearchAgreementsInput) (req *request.Request, output *SearchAgreementsOutput) {
297 op := &request.Operation{
298 Name: opSearchAgreements,
299 HTTPMethod: "POST",
300 HTTPPath: "/",
301 Paginator: &request.Paginator{
302 InputTokens: []string{"nextToken"},
303 OutputTokens: []string{"nextToken"},
304 LimitToken: "maxResults",
305 TruncationToken: "",
306 },
307 }
308
309 if input == nil {
310 input = &SearchAgreementsInput{}
311 }
312
313 output = &SearchAgreementsOutput{}
314 req = c.newRequest(op, input, output)
315 return
316 }
317
318 // SearchAgreements API operation for AWS Marketplace Agreement Service.
319 //
320 // Searches across all agreements that a proposer or an acceptor has in AWS
321 // Marketplace. The search returns a list of agreements with basic agreement
322 // information.
323 //
324 // The following filter combinations are supported:
325 //
326 // - PartyType as Proposer + AgreementType + ResourceIdentifier
327 //
328 // - PartyType as Proposer + AgreementType + OfferId
329 //
330 // - PartyType as Proposer + AgreementType + AcceptorAccountId
331 //
332 // - PartyType as Proposer + AgreementType + Status
333 //
334 // - PartyType as Proposer + AgreementType + ResourceIdentifier + Status
335 //
336 // - PartyType as Proposer + AgreementType + OfferId + Status
337 //
338 // - PartyType as Proposer + AgreementType + AcceptorAccountId + Status
339 //
340 // - PartyType as Proposer + AgreementType + ResourceType + Status
341 //
342 // - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType
343 //
344 // - Status
345 //
346 // - PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId
347 //
348 // - PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId
349 //
350 // - Status
351 //
352 // - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier
353 //
354 // - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier
355 //
356 // - Status
357 //
358 // - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType
359 //
360 // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
361 // with awserr.Error's Code and Message methods to get detailed information about
362 // the error.
363 //
364 // See the AWS API reference guide for AWS Marketplace Agreement Service's
365 // API operation SearchAgreements for usage and error information.
366 //
367 // Returned Error Types:
368 //
369 // - ValidationException
370 // The input fails to satisfy the constraints specified by the service.
371 //
372 // - AccessDeniedException
373 // User does not have sufficient access to perform this action.
374 //
375 // - ThrottlingException
376 // Request was denied due to request throttling.
377 //
378 // - InternalServerException
379 // Unexpected error during processing of request.
380 //
381 // See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/SearchAgreements
382 func (c *MarketplaceAgreement) SearchAgreements(input *SearchAgreementsInput) (*SearchAgreementsOutput, error) {
383 req, out := c.SearchAgreementsRequest(input)
384 return out, req.Send()
385 }
386
387 // SearchAgreementsWithContext is the same as SearchAgreements with the addition of
388 // the ability to pass a context and additional request options.
389 //
390 // See SearchAgreements for details on how to use this API operation.
391 //
392 // The context must be non-nil and will be used for request cancellation. If
393 // the context is nil a panic will occur. In the future the SDK may create
394 // sub-contexts for http.Requests. See https://golang.org/pkg/context/
395 // for more information on using Contexts.
396 func (c *MarketplaceAgreement) SearchAgreementsWithContext(ctx aws.Context, input *SearchAgreementsInput, opts ...request.Option) (*SearchAgreementsOutput, error) {
397 req, out := c.SearchAgreementsRequest(input)
398 req.SetContext(ctx)
399 req.ApplyOptions(opts...)
400 return out, req.Send()
401 }
402
403 // SearchAgreementsPages iterates over the pages of a SearchAgreements operation,
404 // calling the "fn" function with the response data for each page. To stop
405 // iterating, return false from the fn function.
406 //
407 // See SearchAgreements method for more information on how to use this operation.
408 //
409 // Note: This operation can generate multiple requests to a service.
410 //
411 // // Example iterating over at most 3 pages of a SearchAgreements operation.
412 // pageNum := 0
413 // err := client.SearchAgreementsPages(params,
414 // func(page *marketplaceagreement.SearchAgreementsOutput, lastPage bool) bool {
415 // pageNum++
416 // fmt.Println(page)
417 // return pageNum <= 3
418 // })
419 func (c *MarketplaceAgreement) SearchAgreementsPages(input *SearchAgreementsInput, fn func(*SearchAgreementsOutput, bool) bool) error {
420 return c.SearchAgreementsPagesWithContext(aws.BackgroundContext(), input, fn)
421 }
422
423 // SearchAgreementsPagesWithContext same as SearchAgreementsPages except
424 // it takes a Context and allows setting request options on the pages.
425 //
426 // The context must be non-nil and will be used for request cancellation. If
427 // the context is nil a panic will occur. In the future the SDK may create
428 // sub-contexts for http.Requests. See https://golang.org/pkg/context/
429 // for more information on using Contexts.
430 func (c *MarketplaceAgreement) SearchAgreementsPagesWithContext(ctx aws.Context, input *SearchAgreementsInput, fn func(*SearchAgreementsOutput, bool) bool, opts ...request.Option) error {
431 p := request.Pagination{
432 NewRequest: func() (*request.Request, error) {
433 var inCpy *SearchAgreementsInput
434 if input != nil {
435 tmp := *input
436 inCpy = &tmp
437 }
438 req, _ := c.SearchAgreementsRequest(inCpy)
439 req.SetContext(ctx)
440 req.ApplyOptions(opts...)
441 return req, nil
442 },
443 }
444
445 for p.Next() {
446 if !fn(p.Page().(*SearchAgreementsOutput), !p.HasNextPage()) {
447 break
448 }
449 }
450
451 return p.Err()
452 }
453
454 // A subset of terms proposed by the proposer, which have been accepted by the
455 // acceptor as part of agreement creation.
456 type AcceptedTerm struct {
457 _ struct{} `type:"structure"`
458
459 // Enables you and your customers to move your existing agreements to AWS Marketplace.
460 // The customer won't be charged for product usage in AWS Marketplace because
461 // they already paid for the product outside of AWS Marketplace.
462 ByolPricingTerm *ByolPricingTerm `locationName:"byolPricingTerm" type:"structure"`
463
464 // Defines a prepaid payment model that allows buyers to configure the entitlements
465 // they want to purchase and the duration.
466 ConfigurableUpfrontPricingTerm *ConfigurableUpfrontPricingTerm `locationName:"configurableUpfrontPricingTerm" type:"structure"`
467
468 // Defines a pre-paid pricing model where the customers are charged a fixed
469 // upfront amount.
470 FixedUpfrontPricingTerm *FixedUpfrontPricingTerm `locationName:"fixedUpfrontPricingTerm" type:"structure"`
471
472 // Defines a short-term free pricing model where the buyers aren’t charged
473 // anything within a specified limit.
474 FreeTrialPricingTerm *FreeTrialPricingTerm `locationName:"freeTrialPricingTerm" type:"structure"`
475
476 // Defines the list of text agreements proposed to the acceptors. An example
477 // is the end user license agreement (EULA).
478 LegalTerm *LegalTerm `locationName:"legalTerm" type:"structure"`
479
480 // Defines an installment-based pricing model where customers are charged a
481 // fixed price on different dates during the agreement validity period. This
482 // is used most commonly for flexible payment schedule pricing.
483 PaymentScheduleTerm *PaymentScheduleTerm `locationName:"paymentScheduleTerm" type:"structure"`
484
485 // Defines a pricing model where customers are charged a fixed recurring price
486 // at the end of each billing period.
487 RecurringPaymentTerm *RecurringPaymentTerm `locationName:"recurringPaymentTerm" type:"structure"`
488
489 // Defines that on graceful expiration of the agreement (when the agreement
490 // ends on its pre-defined end date), a new agreement will be created using
491 // the accepted terms on the existing agreement. In other words, the agreement
492 // will be renewed. Presence of RenewalTerm in the offer document means that
493 // auto-renewal is allowed. Buyers will have the option to accept or decline
494 // auto-renewal at the offer acceptance/agreement creation. Buyers can also
495 // change this flag from True to False or False to True at anytime during the
496 // agreement's lifecycle.
497 RenewalTerm *RenewalTerm `locationName:"renewalTerm" type:"structure"`
498
499 // Defines the customer support available for the acceptors when they purchase
500 // the software.
501 SupportTerm *SupportTerm `locationName:"supportTerm" type:"structure"`
502
503 // Defines a usage-based pricing model (typically, pay-as-you-go pricing), where
504 // the customers are charged based on product usage.
505 UsageBasedPricingTerm *UsageBasedPricingTerm `locationName:"usageBasedPricingTerm" type:"structure"`
506
507 // Defines the conditions that will keep an agreement created from this offer
508 // valid.
509 ValidityTerm *ValidityTerm `locationName:"validityTerm" type:"structure"`
510 }
511
512 // String returns the string representation.
513 //
514 // API parameter values that are decorated as "sensitive" in the API will not
515 // be included in the string output. The member name will be present, but the
516 // value will be replaced with "sensitive".
517 func (s AcceptedTerm) String() string {
518 return awsutil.Prettify(s)
519 }
520
521 // GoString returns the string representation.
522 //
523 // API parameter values that are decorated as "sensitive" in the API will not
524 // be included in the string output. The member name will be present, but the
525 // value will be replaced with "sensitive".
526 func (s AcceptedTerm) GoString() string {
527 return s.String()
528 }
529
530 // SetByolPricingTerm sets the ByolPricingTerm field's value.
531 func (s *AcceptedTerm) SetByolPricingTerm(v *ByolPricingTerm) *AcceptedTerm {
532 s.ByolPricingTerm = v
533 return s
534 }
535
536 // SetConfigurableUpfrontPricingTerm sets the ConfigurableUpfrontPricingTerm field's value.
537 func (s *AcceptedTerm) SetConfigurableUpfrontPricingTerm(v *ConfigurableUpfrontPricingTerm) *AcceptedTerm {
538 s.ConfigurableUpfrontPricingTerm = v
539 return s
540 }
541
542 // SetFixedUpfrontPricingTerm sets the FixedUpfrontPricingTerm field's value.
543 func (s *AcceptedTerm) SetFixedUpfrontPricingTerm(v *FixedUpfrontPricingTerm) *AcceptedTerm {
544 s.FixedUpfrontPricingTerm = v
545 return s
546 }
547
548 // SetFreeTrialPricingTerm sets the FreeTrialPricingTerm field's value.
549 func (s *AcceptedTerm) SetFreeTrialPricingTerm(v *FreeTrialPricingTerm) *AcceptedTerm {
550 s.FreeTrialPricingTerm = v
551 return s
552 }
553
554 // SetLegalTerm sets the LegalTerm field's value.
555 func (s *AcceptedTerm) SetLegalTerm(v *LegalTerm) *AcceptedTerm {
556 s.LegalTerm = v
557 return s
558 }
559
560 // SetPaymentScheduleTerm sets the PaymentScheduleTerm field's value.
561 func (s *AcceptedTerm) SetPaymentScheduleTerm(v *PaymentScheduleTerm) *AcceptedTerm {
562 s.PaymentScheduleTerm = v
563 return s
564 }
565
566 // SetRecurringPaymentTerm sets the RecurringPaymentTerm field's value.
567 func (s *AcceptedTerm) SetRecurringPaymentTerm(v *RecurringPaymentTerm) *AcceptedTerm {
568 s.RecurringPaymentTerm = v
569 return s
570 }
571
572 // SetRenewalTerm sets the RenewalTerm field's value.
573 func (s *AcceptedTerm) SetRenewalTerm(v *RenewalTerm) *AcceptedTerm {
574 s.RenewalTerm = v
575 return s
576 }
577
578 // SetSupportTerm sets the SupportTerm field's value.
579 func (s *AcceptedTerm) SetSupportTerm(v *SupportTerm) *AcceptedTerm {
580 s.SupportTerm = v
581 return s
582 }
583
584 // SetUsageBasedPricingTerm sets the UsageBasedPricingTerm field's value.
585 func (s *AcceptedTerm) SetUsageBasedPricingTerm(v *UsageBasedPricingTerm) *AcceptedTerm {
586 s.UsageBasedPricingTerm = v
587 return s
588 }
589
590 // SetValidityTerm sets the ValidityTerm field's value.
591 func (s *AcceptedTerm) SetValidityTerm(v *ValidityTerm) *AcceptedTerm {
592 s.ValidityTerm = v
593 return s
594 }
595
596 // The details of the party accepting the agreement terms. This is commonly
597 // the buyer for PurchaseAgreement.
598 type Acceptor struct {
599 _ struct{} `type:"structure"`
600
601 // The AWS account ID of the acceptor.
602 AccountId *string `locationName:"accountId" min:"1" type:"string"`
603 }
604
605 // String returns the string representation.
606 //
607 // API parameter values that are decorated as "sensitive" in the API will not
608 // be included in the string output. The member name will be present, but the
609 // value will be replaced with "sensitive".
610 func (s Acceptor) String() string {
611 return awsutil.Prettify(s)
612 }
613
614 // GoString returns the string representation.
615 //
616 // API parameter values that are decorated as "sensitive" in the API will not
617 // be included in the string output. The member name will be present, but the
618 // value will be replaced with "sensitive".
619 func (s Acceptor) GoString() string {
620 return s.String()
621 }
622
623 // SetAccountId sets the AccountId field's value.
624 func (s *Acceptor) SetAccountId(v string) *Acceptor {
625 s.AccountId = &v
626 return s
627 }
628
629 // User does not have sufficient access to perform this action.
630 type AccessDeniedException struct {
631 _ struct{} `type:"structure"`
632 RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
633
634 Message_ *string `locationName:"message" min:"1" type:"string"`
635
636 // The unique identifier for the error.
637 RequestId *string `locationName:"requestId" min:"1" type:"string"`
638 }
639
640 // String returns the string representation.
641 //
642 // API parameter values that are decorated as "sensitive" in the API will not
643 // be included in the string output. The member name will be present, but the
644 // value will be replaced with "sensitive".
645 func (s AccessDeniedException) String() string {
646 return awsutil.Prettify(s)
647 }
648
649 // GoString returns the string representation.
650 //
651 // API parameter values that are decorated as "sensitive" in the API will not
652 // be included in the string output. The member name will be present, but the
653 // value will be replaced with "sensitive".
654 func (s AccessDeniedException) GoString() string {
655 return s.String()
656 }
657
658 func newErrorAccessDeniedException(v protocol.ResponseMetadata) error {
659 return &AccessDeniedException{
660 RespMetadata: v,
661 }
662 }
663
664 // Code returns the exception type name.
665 func (s *AccessDeniedException) Code() string {
666 return "AccessDeniedException"
667 }
668
669 // Message returns the exception's message.
670 func (s *AccessDeniedException) Message() string {
671 if s.Message_ != nil {
672 return *s.Message_
673 }
674 return ""
675 }
676
677 // OrigErr always returns nil, satisfies awserr.Error interface.
678 func (s *AccessDeniedException) OrigErr() error {
679 return nil
680 }
681
682 func (s *AccessDeniedException) Error() string {
683 return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
684 }
685
686 // Status code returns the HTTP status code for the request's response error.
687 func (s *AccessDeniedException) StatusCode() int {
688 return s.RespMetadata.StatusCode
689 }
690
691 // RequestID returns the service's response RequestID for request.
692 func (s *AccessDeniedException) RequestID() string {
693 return s.RespMetadata.RequestID
694 }
695
696 // A summary of the agreement, including top-level attributes (for example,
697 // the agreement ID, version, proposer, and acceptor).
698 type AgreementViewSummary struct {
699 _ struct{} `type:"structure"`
700
701 // The date and time that the agreement was accepted.
702 AcceptanceTime *time.Time `locationName:"acceptanceTime" type:"timestamp"`
703
704 // Details of the party accepting the agreement terms. This is commonly the
705 // buyer for PurchaseAgreement.
706 Acceptor *Acceptor `locationName:"acceptor" type:"structure"`
707
708 // The unique identifier of the agreement.
709 AgreementId *string `locationName:"agreementId" min:"1" type:"string"`
710
711 // The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
712 AgreementType *string `locationName:"agreementType" min:"1" type:"string"`
713
714 // The date and time when the agreement ends. The field is null for pay-as-you-go
715 // agreements, which don’t have end dates.
716 EndTime *time.Time `locationName:"endTime" type:"timestamp"`
717
718 // A summary of the proposal
719 ProposalSummary *ProposalSummary `locationName:"proposalSummary" type:"structure"`
720
721 // Details of the party proposing the agreement terms, most commonly the seller
722 // for PurchaseAgreement.
723 Proposer *Proposer `locationName:"proposer" type:"structure"`
724
725 // The date and time when the agreement starts.
726 StartTime *time.Time `locationName:"startTime" type:"timestamp"`
727
728 // The current status of the agreement.
729 Status *string `locationName:"status" type:"string" enum:"AgreementStatus"`
730 }
731
732 // String returns the string representation.
733 //
734 // API parameter values that are decorated as "sensitive" in the API will not
735 // be included in the string output. The member name will be present, but the
736 // value will be replaced with "sensitive".
737 func (s AgreementViewSummary) String() string {
738 return awsutil.Prettify(s)
739 }
740
741 // GoString returns the string representation.
742 //
743 // API parameter values that are decorated as "sensitive" in the API will not
744 // be included in the string output. The member name will be present, but the
745 // value will be replaced with "sensitive".
746 func (s AgreementViewSummary) GoString() string {
747 return s.String()
748 }
749
750 // SetAcceptanceTime sets the AcceptanceTime field's value.
751 func (s *AgreementViewSummary) SetAcceptanceTime(v time.Time) *AgreementViewSummary {
752 s.AcceptanceTime = &v
753 return s
754 }
755
756 // SetAcceptor sets the Acceptor field's value.
757 func (s *AgreementViewSummary) SetAcceptor(v *Acceptor) *AgreementViewSummary {
758 s.Acceptor = v
759 return s
760 }
761
762 // SetAgreementId sets the AgreementId field's value.
763 func (s *AgreementViewSummary) SetAgreementId(v string) *AgreementViewSummary {
764 s.AgreementId = &v
765 return s
766 }
767
768 // SetAgreementType sets the AgreementType field's value.
769 func (s *AgreementViewSummary) SetAgreementType(v string) *AgreementViewSummary {
770 s.AgreementType = &v
771 return s
772 }
773
774 // SetEndTime sets the EndTime field's value.
775 func (s *AgreementViewSummary) SetEndTime(v time.Time) *AgreementViewSummary {
776 s.EndTime = &v
777 return s
778 }
779
780 // SetProposalSummary sets the ProposalSummary field's value.
781 func (s *AgreementViewSummary) SetProposalSummary(v *ProposalSummary) *AgreementViewSummary {
782 s.ProposalSummary = v
783 return s
784 }
785
786 // SetProposer sets the Proposer field's value.
787 func (s *AgreementViewSummary) SetProposer(v *Proposer) *AgreementViewSummary {
788 s.Proposer = v
789 return s
790 }
791
792 // SetStartTime sets the StartTime field's value.
793 func (s *AgreementViewSummary) SetStartTime(v time.Time) *AgreementViewSummary {
794 s.StartTime = &v
795 return s
796 }
797
798 // SetStatus sets the Status field's value.
799 func (s *AgreementViewSummary) SetStatus(v string) *AgreementViewSummary {
800 s.Status = &v
801 return s
802 }
803
804 // Enables you and your customers to move your existing agreements to AWS Marketplace.
805 // The customer won't be charged for product usage in AWS Marketplace because
806 // they already paid for the product outside of AWS Marketplace.
807 type ByolPricingTerm struct {
808 _ struct{} `type:"structure"`
809
810 // Type of the term being updated.
811 Type *string `locationName:"type" min:"1" type:"string"`
812 }
813
814 // String returns the string representation.
815 //
816 // API parameter values that are decorated as "sensitive" in the API will not
817 // be included in the string output. The member name will be present, but the
818 // value will be replaced with "sensitive".
819 func (s ByolPricingTerm) String() string {
820 return awsutil.Prettify(s)
821 }
822
823 // GoString returns the string representation.
824 //
825 // API parameter values that are decorated as "sensitive" in the API will not
826 // be included in the string output. The member name will be present, but the
827 // value will be replaced with "sensitive".
828 func (s ByolPricingTerm) GoString() string {
829 return s.String()
830 }
831
832 // SetType sets the Type field's value.
833 func (s *ByolPricingTerm) SetType(v string) *ByolPricingTerm {
834 s.Type = &v
835 return s
836 }
837
838 // Defines a prepaid payment model that allows buyers to configure the entitlements
839 // they want to purchase and the duration.
840 type ConfigurableUpfrontPricingTerm struct {
841 _ struct{} `type:"structure"`
842
843 // Additional parameters specified by the acceptor while accepting the term.
844 Configuration *ConfigurableUpfrontPricingTermConfiguration `locationName:"configuration" type:"structure"`
845
846 // Defines the currency for the prices mentioned in the term.
847 CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
848
849 // A rate card defines the per unit rates for product dimensions.
850 RateCards []*ConfigurableUpfrontRateCardItem `locationName:"rateCards" type:"list"`
851
852 // Category of selector.
853 Type *string `locationName:"type" min:"1" type:"string"`
854 }
855
856 // String returns the string representation.
857 //
858 // API parameter values that are decorated as "sensitive" in the API will not
859 // be included in the string output. The member name will be present, but the
860 // value will be replaced with "sensitive".
861 func (s ConfigurableUpfrontPricingTerm) String() string {
862 return awsutil.Prettify(s)
863 }
864
865 // GoString returns the string representation.
866 //
867 // API parameter values that are decorated as "sensitive" in the API will not
868 // be included in the string output. The member name will be present, but the
869 // value will be replaced with "sensitive".
870 func (s ConfigurableUpfrontPricingTerm) GoString() string {
871 return s.String()
872 }
873
874 // SetConfiguration sets the Configuration field's value.
875 func (s *ConfigurableUpfrontPricingTerm) SetConfiguration(v *ConfigurableUpfrontPricingTermConfiguration) *ConfigurableUpfrontPricingTerm {
876 s.Configuration = v
877 return s
878 }
879
880 // SetCurrencyCode sets the CurrencyCode field's value.
881 func (s *ConfigurableUpfrontPricingTerm) SetCurrencyCode(v string) *ConfigurableUpfrontPricingTerm {
882 s.CurrencyCode = &v
883 return s
884 }
885
886 // SetRateCards sets the RateCards field's value.
887 func (s *ConfigurableUpfrontPricingTerm) SetRateCards(v []*ConfigurableUpfrontRateCardItem) *ConfigurableUpfrontPricingTerm {
888 s.RateCards = v
889 return s
890 }
891
892 // SetType sets the Type field's value.
893 func (s *ConfigurableUpfrontPricingTerm) SetType(v string) *ConfigurableUpfrontPricingTerm {
894 s.Type = &v
895 return s
896 }
897
898 // Defines a prepaid payment model that allows buyers to configure the entitlements
899 // they want to purchase and the duration.
900 type ConfigurableUpfrontPricingTermConfiguration struct {
901 _ struct{} `type:"structure"`
902
903 // Defines the dimensions that the acceptor has purchased from the overall set
904 // of dimensions presented in the rate card.
905 //
906 // Dimensions is a required field
907 Dimensions []*Dimension `locationName:"dimensions" min:"1" type:"list" required:"true"`
908
909 // Defines the length of time for which the particular pricing/dimension is
910 // being purchased by the acceptor.
911 //
912 // SelectorValue is a required field
913 SelectorValue *string `locationName:"selectorValue" min:"1" type:"string" required:"true"`
914 }
915
916 // String returns the string representation.
917 //
918 // API parameter values that are decorated as "sensitive" in the API will not
919 // be included in the string output. The member name will be present, but the
920 // value will be replaced with "sensitive".
921 func (s ConfigurableUpfrontPricingTermConfiguration) String() string {
922 return awsutil.Prettify(s)
923 }
924
925 // GoString returns the string representation.
926 //
927 // API parameter values that are decorated as "sensitive" in the API will not
928 // be included in the string output. The member name will be present, but the
929 // value will be replaced with "sensitive".
930 func (s ConfigurableUpfrontPricingTermConfiguration) GoString() string {
931 return s.String()
932 }
933
934 // SetDimensions sets the Dimensions field's value.
935 func (s *ConfigurableUpfrontPricingTermConfiguration) SetDimensions(v []*Dimension) *ConfigurableUpfrontPricingTermConfiguration {
936 s.Dimensions = v
937 return s
938 }
939
940 // SetSelectorValue sets the SelectorValue field's value.
941 func (s *ConfigurableUpfrontPricingTermConfiguration) SetSelectorValue(v string) *ConfigurableUpfrontPricingTermConfiguration {
942 s.SelectorValue = &v
943 return s
944 }
945
946 // Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm,
947 // the RateCardItem defines all the various rate cards (including pricing and
948 // dimensions) that have been proposed.
949 type ConfigurableUpfrontRateCardItem struct {
950 _ struct{} `type:"structure"`
951
952 // Defines limits on how the term can be configured by acceptors.
953 Constraints *Constraints `locationName:"constraints" type:"structure"`
954
955 // Defines the per unit rates for product dimensions.
956 RateCard []*RateCardItem `locationName:"rateCard" type:"list"`
957
958 // Differentiates between the mutually exclusive rate cards in the same pricing
959 // term to be selected by the buyer.
960 Selector *Selector `locationName:"selector" type:"structure"`
961 }
962
963 // String returns the string representation.
964 //
965 // API parameter values that are decorated as "sensitive" in the API will not
966 // be included in the string output. The member name will be present, but the
967 // value will be replaced with "sensitive".
968 func (s ConfigurableUpfrontRateCardItem) String() string {
969 return awsutil.Prettify(s)
970 }
971
972 // GoString returns the string representation.
973 //
974 // API parameter values that are decorated as "sensitive" in the API will not
975 // be included in the string output. The member name will be present, but the
976 // value will be replaced with "sensitive".
977 func (s ConfigurableUpfrontRateCardItem) GoString() string {
978 return s.String()
979 }
980
981 // SetConstraints sets the Constraints field's value.
982 func (s *ConfigurableUpfrontRateCardItem) SetConstraints(v *Constraints) *ConfigurableUpfrontRateCardItem {
983 s.Constraints = v
984 return s
985 }
986
987 // SetRateCard sets the RateCard field's value.
988 func (s *ConfigurableUpfrontRateCardItem) SetRateCard(v []*RateCardItem) *ConfigurableUpfrontRateCardItem {
989 s.RateCard = v
990 return s
991 }
992
993 // SetSelector sets the Selector field's value.
994 func (s *ConfigurableUpfrontRateCardItem) SetSelector(v *Selector) *ConfigurableUpfrontRateCardItem {
995 s.Selector = v
996 return s
997 }
998
999 // Defines limits on how the term can be configured by acceptors.
1000 type Constraints struct {
1001 _ struct{} `type:"structure"`
1002
1003 // Determines if buyers are allowed to select multiple dimensions in the rate
1004 // card. The possible values are Allowed and Disallowed. The default value is
1005 // Allowed.
1006 MultipleDimensionSelection *string `locationName:"multipleDimensionSelection" min:"1" type:"string"`
1007
1008 // Determines if acceptors are allowed to configure quantity for each dimension
1009 // in rate card. The possible values are Allowed and Disallowed. The default
1010 // value is Allowed.
1011 QuantityConfiguration *string `locationName:"quantityConfiguration" min:"1" type:"string"`
1012 }
1013
1014 // String returns the string representation.
1015 //
1016 // API parameter values that are decorated as "sensitive" in the API will not
1017 // be included in the string output. The member name will be present, but the
1018 // value will be replaced with "sensitive".
1019 func (s Constraints) String() string {
1020 return awsutil.Prettify(s)
1021 }
1022
1023 // GoString returns the string representation.
1024 //
1025 // API parameter values that are decorated as "sensitive" in the API will not
1026 // be included in the string output. The member name will be present, but the
1027 // value will be replaced with "sensitive".
1028 func (s Constraints) GoString() string {
1029 return s.String()
1030 }
1031
1032 // SetMultipleDimensionSelection sets the MultipleDimensionSelection field's value.
1033 func (s *Constraints) SetMultipleDimensionSelection(v string) *Constraints {
1034 s.MultipleDimensionSelection = &v
1035 return s
1036 }
1037
1038 // SetQuantityConfiguration sets the QuantityConfiguration field's value.
1039 func (s *Constraints) SetQuantityConfiguration(v string) *Constraints {
1040 s.QuantityConfiguration = &v
1041 return s
1042 }
1043
1044 type DescribeAgreementInput struct {
1045 _ struct{} `type:"structure"`
1046
1047 // The unique identifier of the agreement.
1048 //
1049 // AgreementId is a required field
1050 AgreementId *string `locationName:"agreementId" min:"1" type:"string" required:"true"`
1051 }
1052
1053 // String returns the string representation.
1054 //
1055 // API parameter values that are decorated as "sensitive" in the API will not
1056 // be included in the string output. The member name will be present, but the
1057 // value will be replaced with "sensitive".
1058 func (s DescribeAgreementInput) String() string {
1059 return awsutil.Prettify(s)
1060 }
1061
1062 // GoString returns the string representation.
1063 //
1064 // API parameter values that are decorated as "sensitive" in the API will not
1065 // be included in the string output. The member name will be present, but the
1066 // value will be replaced with "sensitive".
1067 func (s DescribeAgreementInput) GoString() string {
1068 return s.String()
1069 }
1070
1071 // Validate inspects the fields of the type to determine if they are valid.
1072 func (s *DescribeAgreementInput) Validate() error {
1073 invalidParams := request.ErrInvalidParams{Context: "DescribeAgreementInput"}
1074 if s.AgreementId == nil {
1075 invalidParams.Add(request.NewErrParamRequired("AgreementId"))
1076 }
1077 if s.AgreementId != nil && len(*s.AgreementId) < 1 {
1078 invalidParams.Add(request.NewErrParamMinLen("AgreementId", 1))
1079 }
1080
1081 if invalidParams.Len() > 0 {
1082 return invalidParams
1083 }
1084 return nil
1085 }
1086
1087 // SetAgreementId sets the AgreementId field's value.
1088 func (s *DescribeAgreementInput) SetAgreementId(v string) *DescribeAgreementInput {
1089 s.AgreementId = &v
1090 return s
1091 }
1092
1093 type DescribeAgreementOutput struct {
1094 _ struct{} `type:"structure"`
1095
1096 // The date and time the offer was accepted or the agreement was created.
1097 //
1098 // AcceptanceTime and StartTime can differ for future dated agreements (FDAs).
1099 AcceptanceTime *time.Time `locationName:"acceptanceTime" type:"timestamp"`
1100
1101 // The details of the party accepting the agreement terms. This is commonly
1102 // the buyer for PurchaseAgreement.
1103 Acceptor *Acceptor `locationName:"acceptor" type:"structure"`
1104
1105 // The unique identifier of the agreement.
1106 AgreementId *string `locationName:"agreementId" min:"1" type:"string"`
1107
1108 // The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
1109 AgreementType *string `locationName:"agreementType" min:"1" type:"string"`
1110
1111 // The date and time when the agreement ends. The field is null for pay-as-you-go
1112 // agreements, which don’t have end dates.
1113 EndTime *time.Time `locationName:"endTime" type:"timestamp"`
1114
1115 // The estimated cost of the agreement.
1116 EstimatedCharges *EstimatedCharges `locationName:"estimatedCharges" type:"structure"`
1117
1118 // A summary of the proposal received from the proposer.
1119 ProposalSummary *ProposalSummary `locationName:"proposalSummary" type:"structure"`
1120
1121 // The details of the party proposing the agreement terms. This is commonly
1122 // the seller for PurchaseAgreement.
1123 Proposer *Proposer `locationName:"proposer" type:"structure"`
1124
1125 // The date and time when the agreement starts.
1126 StartTime *time.Time `locationName:"startTime" type:"timestamp"`
1127
1128 // The current status of the agreement.
1129 //
1130 // Statuses include:
1131 //
1132 // * ACTIVE – The terms of the agreement are active.
1133 //
1134 // * ARCHIVED – The agreement ended without a specified reason.
1135 //
1136 // * CANCELLED – The acceptor ended the agreement before the defined end
1137 // date.
1138 //
1139 // * EXPIRED – The agreement ended on the defined end date.
1140 //
1141 // * RENEWED – The agreement was renewed into a new agreement (for example,
1142 // an auto-renewal).
1143 //
1144 // * REPLACED – The agreement was replaced using an agreement replacement
1145 // offer.
1146 //
1147 // * ROLLED_BACK (Only applicable to inactive agreement revisions) – The
1148 // agreement revision has been rolled back because of an error. An earlier
1149 // revision is now active.
1150 //
1151 // * SUPERCEDED (Only applicable to inactive agreement revisions) – The
1152 // agreement revision is no longer active and another agreement revision
1153 // is now active.
1154 //
1155 // * TERMINATED – The agreement ended before the defined end date because
1156 // of an AWS termination (for example, a payment failure).
1157 Status *string `locationName:"status" type:"string" enum:"AgreementStatus"`
1158 }
1159
1160 // String returns the string representation.
1161 //
1162 // API parameter values that are decorated as "sensitive" in the API will not
1163 // be included in the string output. The member name will be present, but the
1164 // value will be replaced with "sensitive".
1165 func (s DescribeAgreementOutput) String() string {
1166 return awsutil.Prettify(s)
1167 }
1168
1169 // GoString returns the string representation.
1170 //
1171 // API parameter values that are decorated as "sensitive" in the API will not
1172 // be included in the string output. The member name will be present, but the
1173 // value will be replaced with "sensitive".
1174 func (s DescribeAgreementOutput) GoString() string {
1175 return s.String()
1176 }
1177
1178 // SetAcceptanceTime sets the AcceptanceTime field's value.
1179 func (s *DescribeAgreementOutput) SetAcceptanceTime(v time.Time) *DescribeAgreementOutput {
1180 s.AcceptanceTime = &v
1181 return s
1182 }
1183
1184 // SetAcceptor sets the Acceptor field's value.
1185 func (s *DescribeAgreementOutput) SetAcceptor(v *Acceptor) *DescribeAgreementOutput {
1186 s.Acceptor = v
1187 return s
1188 }
1189
1190 // SetAgreementId sets the AgreementId field's value.
1191 func (s *DescribeAgreementOutput) SetAgreementId(v string) *DescribeAgreementOutput {
1192 s.AgreementId = &v
1193 return s
1194 }
1195
1196 // SetAgreementType sets the AgreementType field's value.
1197 func (s *DescribeAgreementOutput) SetAgreementType(v string) *DescribeAgreementOutput {
1198 s.AgreementType = &v
1199 return s
1200 }
1201
1202 // SetEndTime sets the EndTime field's value.
1203 func (s *DescribeAgreementOutput) SetEndTime(v time.Time) *DescribeAgreementOutput {
1204 s.EndTime = &v
1205 return s
1206 }
1207
1208 // SetEstimatedCharges sets the EstimatedCharges field's value.
1209 func (s *DescribeAgreementOutput) SetEstimatedCharges(v *EstimatedCharges) *DescribeAgreementOutput {
1210 s.EstimatedCharges = v
1211 return s
1212 }
1213
1214 // SetProposalSummary sets the ProposalSummary field's value.
1215 func (s *DescribeAgreementOutput) SetProposalSummary(v *ProposalSummary) *DescribeAgreementOutput {
1216 s.ProposalSummary = v
1217 return s
1218 }
1219
1220 // SetProposer sets the Proposer field's value.
1221 func (s *DescribeAgreementOutput) SetProposer(v *Proposer) *DescribeAgreementOutput {
1222 s.Proposer = v
1223 return s
1224 }
1225
1226 // SetStartTime sets the StartTime field's value.
1227 func (s *DescribeAgreementOutput) SetStartTime(v time.Time) *DescribeAgreementOutput {
1228 s.StartTime = &v
1229 return s
1230 }
1231
1232 // SetStatus sets the Status field's value.
1233 func (s *DescribeAgreementOutput) SetStatus(v string) *DescribeAgreementOutput {
1234 s.Status = &v
1235 return s
1236 }
1237
1238 // Defines the dimensions that the acceptor has purchased from the overall set
1239 // of dimensions presented in the rate card.
1240 type Dimension struct {
1241 _ struct{} `type:"structure"`
1242
1243 // The name of key value of the dimension.
1244 //
1245 // DimensionKey is a required field
1246 DimensionKey *string `locationName:"dimensionKey" min:"1" type:"string" required:"true"`
1247
1248 // The number of units of the dimension the acceptor has purchased.
1249 //
1250 // For Agreements with ConfigurableUpfrontPricingTerm, the RateCard section
1251 // will define the prices and dimensions defined by the seller (proposer), whereas
1252 // the Configuration section will define the actual dimensions, prices, and
1253 // units the buyer has chosen to accept.
1254 //
1255 // DimensionValue is a required field
1256 DimensionValue *int64 `locationName:"dimensionValue" type:"integer" required:"true"`
1257 }
1258
1259 // String returns the string representation.
1260 //
1261 // API parameter values that are decorated as "sensitive" in the API will not
1262 // be included in the string output. The member name will be present, but the
1263 // value will be replaced with "sensitive".
1264 func (s Dimension) String() string {
1265 return awsutil.Prettify(s)
1266 }
1267
1268 // GoString returns the string representation.
1269 //
1270 // API parameter values that are decorated as "sensitive" in the API will not
1271 // be included in the string output. The member name will be present, but the
1272 // value will be replaced with "sensitive".
1273 func (s Dimension) GoString() string {
1274 return s.String()
1275 }
1276
1277 // SetDimensionKey sets the DimensionKey field's value.
1278 func (s *Dimension) SetDimensionKey(v string) *Dimension {
1279 s.DimensionKey = &v
1280 return s
1281 }
1282
1283 // SetDimensionValue sets the DimensionValue field's value.
1284 func (s *Dimension) SetDimensionValue(v int64) *Dimension {
1285 s.DimensionValue = &v
1286 return s
1287 }
1288
1289 // Includes the list of references to legal resources proposed by the proposer
1290 // to the acceptor. Each DocumentItem refers to an individual reference.
1291 type DocumentItem struct {
1292 _ struct{} `type:"structure"`
1293
1294 // Category of the document. Document types include:
1295 //
1296 // * CustomEula – A custom EULA provided by you as seller. A URL for a
1297 // EULA stored in an accessible Amazon S3 bucket is required for this document
1298 // type.
1299 //
1300 // * CustomDsa – A custom Data Subscription Agreement (DSA) provided by
1301 // you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket
1302 // is required for this document type.
1303 //
1304 // * StandardEula – The Standard Contract for AWS Marketplace (SCMP). For
1305 // more information about SCMP, see the AWS Marketplace Seller Guide. You
1306 // don’t provide a URL for this type because it’s managed by AWS Marketplace.
1307 //
1308 // * StandardDsa – DSA for AWS Marketplace. For more information about
1309 // the DSA, see the AWS Data Exchange User Guide. You don’t provide a URL
1310 // for this type because it’s managed by AWS Marketplace.
1311 Type *string `locationName:"type" min:"1" type:"string"`
1312
1313 // A URL to the legal document for buyers to read. Required when Type is CustomEula.
1314 Url *string `locationName:"url" min:"1" type:"string"`
1315
1316 // Version of standard contracts provided by AWS Marketplace. Required when
1317 // Type is StandardEula or StandardDsa.
1318 Version *string `locationName:"version" min:"1" type:"string"`
1319 }
1320
1321 // String returns the string representation.
1322 //
1323 // API parameter values that are decorated as "sensitive" in the API will not
1324 // be included in the string output. The member name will be present, but the
1325 // value will be replaced with "sensitive".
1326 func (s DocumentItem) String() string {
1327 return awsutil.Prettify(s)
1328 }
1329
1330 // GoString returns the string representation.
1331 //
1332 // API parameter values that are decorated as "sensitive" in the API will not
1333 // be included in the string output. The member name will be present, but the
1334 // value will be replaced with "sensitive".
1335 func (s DocumentItem) GoString() string {
1336 return s.String()
1337 }
1338
1339 // SetType sets the Type field's value.
1340 func (s *DocumentItem) SetType(v string) *DocumentItem {
1341 s.Type = &v
1342 return s
1343 }
1344
1345 // SetUrl sets the Url field's value.
1346 func (s *DocumentItem) SetUrl(v string) *DocumentItem {
1347 s.Url = &v
1348 return s
1349 }
1350
1351 // SetVersion sets the Version field's value.
1352 func (s *DocumentItem) SetVersion(v string) *DocumentItem {
1353 s.Version = &v
1354 return s
1355 }
1356
1357 // Estimated cost of the agreement.
1358 type EstimatedCharges struct {
1359 _ struct{} `type:"structure"`
1360
1361 // The total known amount customer has to pay across the lifecycle of the agreement.
1362 //
1363 // This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm
1364 // or FixedUpfrontPricingTerm. In the case of pure contract pricing, this will
1365 // be the total value of the contract. In the case of contracts with consumption
1366 // pricing, this will only include the committed value and not include any overages
1367 // that occur.
1368 //
1369 // If the accepted terms contain PaymentScheduleTerm, it will be the total payment
1370 // schedule amount. This occurs when flexible payment schedule is used, and
1371 // is the sum of all invoice charges in the payment schedule.
1372 //
1373 // In case a customer has amended an agreement, by purchasing more units of
1374 // any dimension, this will include both the original cost as well as the added
1375 // cost incurred due to addition of new units.
1376 //
1377 // This is 0 if the accepted terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm
1378 // or RecurringPaymentTerm. This occurs for usage-based pricing (such as SaaS
1379 // metered or AMI/container hourly or monthly), because the exact usage is not
1380 // known upfront.
1381 AgreementValue *string `locationName:"agreementValue" min:"1" type:"string"`
1382
1383 // Defines the currency code for the charge.
1384 CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
1385 }
1386
1387 // String returns the string representation.
1388 //
1389 // API parameter values that are decorated as "sensitive" in the API will not
1390 // be included in the string output. The member name will be present, but the
1391 // value will be replaced with "sensitive".
1392 func (s EstimatedCharges) String() string {
1393 return awsutil.Prettify(s)
1394 }
1395
1396 // GoString returns the string representation.
1397 //
1398 // API parameter values that are decorated as "sensitive" in the API will not
1399 // be included in the string output. The member name will be present, but the
1400 // value will be replaced with "sensitive".
1401 func (s EstimatedCharges) GoString() string {
1402 return s.String()
1403 }
1404
1405 // SetAgreementValue sets the AgreementValue field's value.
1406 func (s *EstimatedCharges) SetAgreementValue(v string) *EstimatedCharges {
1407 s.AgreementValue = &v
1408 return s
1409 }
1410
1411 // SetCurrencyCode sets the CurrencyCode field's value.
1412 func (s *EstimatedCharges) SetCurrencyCode(v string) *EstimatedCharges {
1413 s.CurrencyCode = &v
1414 return s
1415 }
1416
1417 // The filter name and value pair that is used to return a more specific list
1418 // of results. Filters can be used to match a set of resources by various criteria,
1419 // such as offerId or productId.
1420 type Filter struct {
1421 _ struct{} `type:"structure"`
1422
1423 // The name of the filter.
1424 Name *string `locationName:"name" min:"1" type:"string"`
1425
1426 // The filter value.
1427 Values []*string `locationName:"values" min:"1" type:"list"`
1428 }
1429
1430 // String returns the string representation.
1431 //
1432 // API parameter values that are decorated as "sensitive" in the API will not
1433 // be included in the string output. The member name will be present, but the
1434 // value will be replaced with "sensitive".
1435 func (s Filter) String() string {
1436 return awsutil.Prettify(s)
1437 }
1438
1439 // GoString returns the string representation.
1440 //
1441 // API parameter values that are decorated as "sensitive" in the API will not
1442 // be included in the string output. The member name will be present, but the
1443 // value will be replaced with "sensitive".
1444 func (s Filter) GoString() string {
1445 return s.String()
1446 }
1447
1448 // Validate inspects the fields of the type to determine if they are valid.
1449 func (s *Filter) Validate() error {
1450 invalidParams := request.ErrInvalidParams{Context: "Filter"}
1451 if s.Name != nil && len(*s.Name) < 1 {
1452 invalidParams.Add(request.NewErrParamMinLen("Name", 1))
1453 }
1454 if s.Values != nil && len(s.Values) < 1 {
1455 invalidParams.Add(request.NewErrParamMinLen("Values", 1))
1456 }
1457
1458 if invalidParams.Len() > 0 {
1459 return invalidParams
1460 }
1461 return nil
1462 }
1463
1464 // SetName sets the Name field's value.
1465 func (s *Filter) SetName(v string) *Filter {
1466 s.Name = &v
1467 return s
1468 }
1469
1470 // SetValues sets the Values field's value.
1471 func (s *Filter) SetValues(v []*string) *Filter {
1472 s.Values = v
1473 return s
1474 }
1475
1476 // Defines a prepaid pricing model where the customers are charged a fixed upfront
1477 // amount.
1478 type FixedUpfrontPricingTerm struct {
1479 _ struct{} `type:"structure"`
1480
1481 // Defines the currency for the prices mentioned in this term.
1482 CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
1483
1484 // Contract duration for the terms.
1485 Duration *string `locationName:"duration" min:"1" type:"string"`
1486
1487 // Entitlements granted to the acceptor of fixed upfront as part of agreement
1488 // execution.
1489 Grants []*GrantItem `locationName:"grants" type:"list"`
1490
1491 // Fixed amount to be charged to the customer when this term is accepted.
1492 Price *string `locationName:"price" min:"1" type:"string"`
1493
1494 // Category of the term being updated.
1495 Type *string `locationName:"type" min:"1" type:"string"`
1496 }
1497
1498 // String returns the string representation.
1499 //
1500 // API parameter values that are decorated as "sensitive" in the API will not
1501 // be included in the string output. The member name will be present, but the
1502 // value will be replaced with "sensitive".
1503 func (s FixedUpfrontPricingTerm) String() string {
1504 return awsutil.Prettify(s)
1505 }
1506
1507 // GoString returns the string representation.
1508 //
1509 // API parameter values that are decorated as "sensitive" in the API will not
1510 // be included in the string output. The member name will be present, but the
1511 // value will be replaced with "sensitive".
1512 func (s FixedUpfrontPricingTerm) GoString() string {
1513 return s.String()
1514 }
1515
1516 // SetCurrencyCode sets the CurrencyCode field's value.
1517 func (s *FixedUpfrontPricingTerm) SetCurrencyCode(v string) *FixedUpfrontPricingTerm {
1518 s.CurrencyCode = &v
1519 return s
1520 }
1521
1522 // SetDuration sets the Duration field's value.
1523 func (s *FixedUpfrontPricingTerm) SetDuration(v string) *FixedUpfrontPricingTerm {
1524 s.Duration = &v
1525 return s
1526 }
1527
1528 // SetGrants sets the Grants field's value.
1529 func (s *FixedUpfrontPricingTerm) SetGrants(v []*GrantItem) *FixedUpfrontPricingTerm {
1530 s.Grants = v
1531 return s
1532 }
1533
1534 // SetPrice sets the Price field's value.
1535 func (s *FixedUpfrontPricingTerm) SetPrice(v string) *FixedUpfrontPricingTerm {
1536 s.Price = &v
1537 return s
1538 }
1539
1540 // SetType sets the Type field's value.
1541 func (s *FixedUpfrontPricingTerm) SetType(v string) *FixedUpfrontPricingTerm {
1542 s.Type = &v
1543 return s
1544 }
1545
1546 // Defines a short-term free pricing model where the buyers aren’t charged
1547 // anything within a specified limit.
1548 type FreeTrialPricingTerm struct {
1549 _ struct{} `type:"structure"`
1550
1551 // Duration of the free trial period (5–31 days).
1552 Duration *string `locationName:"duration" min:"1" type:"string"`
1553
1554 // Entitlements granted to the acceptor of a free trial as part of an agreement
1555 // execution.
1556 Grants []*GrantItem `locationName:"grants" type:"list"`
1557
1558 // Category of the term.
1559 Type *string `locationName:"type" min:"1" type:"string"`
1560 }
1561
1562 // String returns the string representation.
1563 //
1564 // API parameter values that are decorated as "sensitive" in the API will not
1565 // be included in the string output. The member name will be present, but the
1566 // value will be replaced with "sensitive".
1567 func (s FreeTrialPricingTerm) String() string {
1568 return awsutil.Prettify(s)
1569 }
1570
1571 // GoString returns the string representation.
1572 //
1573 // API parameter values that are decorated as "sensitive" in the API will not
1574 // be included in the string output. The member name will be present, but the
1575 // value will be replaced with "sensitive".
1576 func (s FreeTrialPricingTerm) GoString() string {
1577 return s.String()
1578 }
1579
1580 // SetDuration sets the Duration field's value.
1581 func (s *FreeTrialPricingTerm) SetDuration(v string) *FreeTrialPricingTerm {
1582 s.Duration = &v
1583 return s
1584 }
1585
1586 // SetGrants sets the Grants field's value.
1587 func (s *FreeTrialPricingTerm) SetGrants(v []*GrantItem) *FreeTrialPricingTerm {
1588 s.Grants = v
1589 return s
1590 }
1591
1592 // SetType sets the Type field's value.
1593 func (s *FreeTrialPricingTerm) SetType(v string) *FreeTrialPricingTerm {
1594 s.Type = &v
1595 return s
1596 }
1597
1598 type GetAgreementTermsInput struct {
1599 _ struct{} `type:"structure"`
1600
1601 // The unique identifier of the agreement.
1602 //
1603 // AgreementId is a required field
1604 AgreementId *string `locationName:"agreementId" min:"1" type:"string" required:"true"`
1605
1606 // The maximum number of agreements to return in the response.
1607 MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
1608
1609 // A token to specify where to start pagination
1610 NextToken *string `locationName:"nextToken" type:"string"`
1611 }
1612
1613 // String returns the string representation.
1614 //
1615 // API parameter values that are decorated as "sensitive" in the API will not
1616 // be included in the string output. The member name will be present, but the
1617 // value will be replaced with "sensitive".
1618 func (s GetAgreementTermsInput) String() string {
1619 return awsutil.Prettify(s)
1620 }
1621
1622 // GoString returns the string representation.
1623 //
1624 // API parameter values that are decorated as "sensitive" in the API will not
1625 // be included in the string output. The member name will be present, but the
1626 // value will be replaced with "sensitive".
1627 func (s GetAgreementTermsInput) GoString() string {
1628 return s.String()
1629 }
1630
1631 // Validate inspects the fields of the type to determine if they are valid.
1632 func (s *GetAgreementTermsInput) Validate() error {
1633 invalidParams := request.ErrInvalidParams{Context: "GetAgreementTermsInput"}
1634 if s.AgreementId == nil {
1635 invalidParams.Add(request.NewErrParamRequired("AgreementId"))
1636 }
1637 if s.AgreementId != nil && len(*s.AgreementId) < 1 {
1638 invalidParams.Add(request.NewErrParamMinLen("AgreementId", 1))
1639 }
1640 if s.MaxResults != nil && *s.MaxResults < 1 {
1641 invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
1642 }
1643
1644 if invalidParams.Len() > 0 {
1645 return invalidParams
1646 }
1647 return nil
1648 }
1649
1650 // SetAgreementId sets the AgreementId field's value.
1651 func (s *GetAgreementTermsInput) SetAgreementId(v string) *GetAgreementTermsInput {
1652 s.AgreementId = &v
1653 return s
1654 }
1655
1656 // SetMaxResults sets the MaxResults field's value.
1657 func (s *GetAgreementTermsInput) SetMaxResults(v int64) *GetAgreementTermsInput {
1658 s.MaxResults = &v
1659 return s
1660 }
1661
1662 // SetNextToken sets the NextToken field's value.
1663 func (s *GetAgreementTermsInput) SetNextToken(v string) *GetAgreementTermsInput {
1664 s.NextToken = &v
1665 return s
1666 }
1667
1668 type GetAgreementTermsOutput struct {
1669 _ struct{} `type:"structure"`
1670
1671 // A subset of terms proposed by the proposer that have been accepted by the
1672 // acceptor as part of the agreement creation.
1673 AcceptedTerms []*AcceptedTerm `locationName:"acceptedTerms" type:"list"`
1674
1675 // A token to specify where to start pagination
1676 NextToken *string `locationName:"nextToken" type:"string"`
1677 }
1678
1679 // String returns the string representation.
1680 //
1681 // API parameter values that are decorated as "sensitive" in the API will not
1682 // be included in the string output. The member name will be present, but the
1683 // value will be replaced with "sensitive".
1684 func (s GetAgreementTermsOutput) String() string {
1685 return awsutil.Prettify(s)
1686 }
1687
1688 // GoString returns the string representation.
1689 //
1690 // API parameter values that are decorated as "sensitive" in the API will not
1691 // be included in the string output. The member name will be present, but the
1692 // value will be replaced with "sensitive".
1693 func (s GetAgreementTermsOutput) GoString() string {
1694 return s.String()
1695 }
1696
1697 // SetAcceptedTerms sets the AcceptedTerms field's value.
1698 func (s *GetAgreementTermsOutput) SetAcceptedTerms(v []*AcceptedTerm) *GetAgreementTermsOutput {
1699 s.AcceptedTerms = v
1700 return s
1701 }
1702
1703 // SetNextToken sets the NextToken field's value.
1704 func (s *GetAgreementTermsOutput) SetNextToken(v string) *GetAgreementTermsOutput {
1705 s.NextToken = &v
1706 return s
1707 }
1708
1709 // Entitlements granted to the acceptor of fixed upfront as part of agreement
1710 // execution.
1711 type GrantItem struct {
1712 _ struct{} `type:"structure"`
1713
1714 // Unique dimension key defined in the product document. Dimensions represent
1715 // categories of capacity in a product and are specified when the product is
1716 // listed in AWS Marketplace.
1717 DimensionKey *string `locationName:"dimensionKey" min:"1" type:"string"`
1718
1719 // Maximum amount of capacity that the buyer can be entitled to the given dimension
1720 // of the product. If MaxQuantity is not provided, the buyer will be able to
1721 // use an unlimited amount of the given dimension.
1722 MaxQuantity *int64 `locationName:"maxQuantity" min:"1" type:"integer"`
1723 }
1724
1725 // String returns the string representation.
1726 //
1727 // API parameter values that are decorated as "sensitive" in the API will not
1728 // be included in the string output. The member name will be present, but the
1729 // value will be replaced with "sensitive".
1730 func (s GrantItem) String() string {
1731 return awsutil.Prettify(s)
1732 }
1733
1734 // GoString returns the string representation.
1735 //
1736 // API parameter values that are decorated as "sensitive" in the API will not
1737 // be included in the string output. The member name will be present, but the
1738 // value will be replaced with "sensitive".
1739 func (s GrantItem) GoString() string {
1740 return s.String()
1741 }
1742
1743 // SetDimensionKey sets the DimensionKey field's value.
1744 func (s *GrantItem) SetDimensionKey(v string) *GrantItem {
1745 s.DimensionKey = &v
1746 return s
1747 }
1748
1749 // SetMaxQuantity sets the MaxQuantity field's value.
1750 func (s *GrantItem) SetMaxQuantity(v int64) *GrantItem {
1751 s.MaxQuantity = &v
1752 return s
1753 }
1754
1755 // Unexpected error during processing of request.
1756 type InternalServerException struct {
1757 _ struct{} `type:"structure"`
1758 RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
1759
1760 Message_ *string `locationName:"message" min:"1" type:"string"`
1761
1762 // The unique identifier for the error.
1763 RequestId *string `locationName:"requestId" min:"1" type:"string"`
1764 }
1765
1766 // String returns the string representation.
1767 //
1768 // API parameter values that are decorated as "sensitive" in the API will not
1769 // be included in the string output. The member name will be present, but the
1770 // value will be replaced with "sensitive".
1771 func (s InternalServerException) String() string {
1772 return awsutil.Prettify(s)
1773 }
1774
1775 // GoString returns the string representation.
1776 //
1777 // API parameter values that are decorated as "sensitive" in the API will not
1778 // be included in the string output. The member name will be present, but the
1779 // value will be replaced with "sensitive".
1780 func (s InternalServerException) GoString() string {
1781 return s.String()
1782 }
1783
1784 func newErrorInternalServerException(v protocol.ResponseMetadata) error {
1785 return &InternalServerException{
1786 RespMetadata: v,
1787 }
1788 }
1789
1790 // Code returns the exception type name.
1791 func (s *InternalServerException) Code() string {
1792 return "InternalServerException"
1793 }
1794
1795 // Message returns the exception's message.
1796 func (s *InternalServerException) Message() string {
1797 if s.Message_ != nil {
1798 return *s.Message_
1799 }
1800 return ""
1801 }
1802
1803 // OrigErr always returns nil, satisfies awserr.Error interface.
1804 func (s *InternalServerException) OrigErr() error {
1805 return nil
1806 }
1807
1808 func (s *InternalServerException) Error() string {
1809 return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
1810 }
1811
1812 // Status code returns the HTTP status code for the request's response error.
1813 func (s *InternalServerException) StatusCode() int {
1814 return s.RespMetadata.StatusCode
1815 }
1816
1817 // RequestID returns the service's response RequestID for request.
1818 func (s *InternalServerException) RequestID() string {
1819 return s.RespMetadata.RequestID
1820 }
1821
1822 // Defines the list of text agreements proposed to the acceptors. An example
1823 // is the end user license agreement (EULA).
1824 type LegalTerm struct {
1825 _ struct{} `type:"structure"`
1826
1827 // List of references to legal resources proposed to the buyers. An example
1828 // is the EULA.
1829 Documents []*DocumentItem `locationName:"documents" type:"list"`
1830
1831 // Category of the term being updated.
1832 Type *string `locationName:"type" min:"1" type:"string"`
1833 }
1834
1835 // String returns the string representation.
1836 //
1837 // API parameter values that are decorated as "sensitive" in the API will not
1838 // be included in the string output. The member name will be present, but the
1839 // value will be replaced with "sensitive".
1840 func (s LegalTerm) String() string {
1841 return awsutil.Prettify(s)
1842 }
1843
1844 // GoString returns the string representation.
1845 //
1846 // API parameter values that are decorated as "sensitive" in the API will not
1847 // be included in the string output. The member name will be present, but the
1848 // value will be replaced with "sensitive".
1849 func (s LegalTerm) GoString() string {
1850 return s.String()
1851 }
1852
1853 // SetDocuments sets the Documents field's value.
1854 func (s *LegalTerm) SetDocuments(v []*DocumentItem) *LegalTerm {
1855 s.Documents = v
1856 return s
1857 }
1858
1859 // SetType sets the Type field's value.
1860 func (s *LegalTerm) SetType(v string) *LegalTerm {
1861 s.Type = &v
1862 return s
1863 }
1864
1865 // Defines an installment-based pricing model where customers are charged a
1866 // fixed price on different dates during the agreement validity period. This
1867 // is used most commonly for flexible payment schedule pricing.
1868 type PaymentScheduleTerm struct {
1869 _ struct{} `type:"structure"`
1870
1871 // Defines the currency for the prices mentioned in the term.
1872 CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
1873
1874 // List of the payment schedule where each element defines one installment of
1875 // payment. It contains the information necessary for calculating the price.
1876 Schedule []*ScheduleItem `locationName:"schedule" type:"list"`
1877
1878 // Type of the term.
1879 Type *string `locationName:"type" min:"1" type:"string"`
1880 }
1881
1882 // String returns the string representation.
1883 //
1884 // API parameter values that are decorated as "sensitive" in the API will not
1885 // be included in the string output. The member name will be present, but the
1886 // value will be replaced with "sensitive".
1887 func (s PaymentScheduleTerm) String() string {
1888 return awsutil.Prettify(s)
1889 }
1890
1891 // GoString returns the string representation.
1892 //
1893 // API parameter values that are decorated as "sensitive" in the API will not
1894 // be included in the string output. The member name will be present, but the
1895 // value will be replaced with "sensitive".
1896 func (s PaymentScheduleTerm) GoString() string {
1897 return s.String()
1898 }
1899
1900 // SetCurrencyCode sets the CurrencyCode field's value.
1901 func (s *PaymentScheduleTerm) SetCurrencyCode(v string) *PaymentScheduleTerm {
1902 s.CurrencyCode = &v
1903 return s
1904 }
1905
1906 // SetSchedule sets the Schedule field's value.
1907 func (s *PaymentScheduleTerm) SetSchedule(v []*ScheduleItem) *PaymentScheduleTerm {
1908 s.Schedule = v
1909 return s
1910 }
1911
1912 // SetType sets the Type field's value.
1913 func (s *PaymentScheduleTerm) SetType(v string) *PaymentScheduleTerm {
1914 s.Type = &v
1915 return s
1916 }
1917
1918 // A summary of the proposal received from the proposer.
1919 type ProposalSummary struct {
1920 _ struct{} `type:"structure"`
1921
1922 // The unique identifier of the offer in AWS Marketplace.
1923 OfferId *string `locationName:"offerId" min:"1" type:"string"`
1924
1925 // The list of resources involved in the agreement.
1926 Resources []*Resource `locationName:"resources" type:"list"`
1927 }
1928
1929 // String returns the string representation.
1930 //
1931 // API parameter values that are decorated as "sensitive" in the API will not
1932 // be included in the string output. The member name will be present, but the
1933 // value will be replaced with "sensitive".
1934 func (s ProposalSummary) String() string {
1935 return awsutil.Prettify(s)
1936 }
1937
1938 // GoString returns the string representation.
1939 //
1940 // API parameter values that are decorated as "sensitive" in the API will not
1941 // be included in the string output. The member name will be present, but the
1942 // value will be replaced with "sensitive".
1943 func (s ProposalSummary) GoString() string {
1944 return s.String()
1945 }
1946
1947 // SetOfferId sets the OfferId field's value.
1948 func (s *ProposalSummary) SetOfferId(v string) *ProposalSummary {
1949 s.OfferId = &v
1950 return s
1951 }
1952
1953 // SetResources sets the Resources field's value.
1954 func (s *ProposalSummary) SetResources(v []*Resource) *ProposalSummary {
1955 s.Resources = v
1956 return s
1957 }
1958
1959 // Details of the party proposing the agreement terms,. This is commonly the
1960 // seller for PurchaseAgreement.
1961 type Proposer struct {
1962 _ struct{} `type:"structure"`
1963
1964 // The AWS account ID of the proposer.
1965 AccountId *string `locationName:"accountId" min:"1" type:"string"`
1966 }
1967
1968 // String returns the string representation.
1969 //
1970 // API parameter values that are decorated as "sensitive" in the API will not
1971 // be included in the string output. The member name will be present, but the
1972 // value will be replaced with "sensitive".
1973 func (s Proposer) String() string {
1974 return awsutil.Prettify(s)
1975 }
1976
1977 // GoString returns the string representation.
1978 //
1979 // API parameter values that are decorated as "sensitive" in the API will not
1980 // be included in the string output. The member name will be present, but the
1981 // value will be replaced with "sensitive".
1982 func (s Proposer) GoString() string {
1983 return s.String()
1984 }
1985
1986 // SetAccountId sets the AccountId field's value.
1987 func (s *Proposer) SetAccountId(v string) *Proposer {
1988 s.AccountId = &v
1989 return s
1990 }
1991
1992 // Defines the per unit rates for each individual product dimension.
1993 type RateCardItem struct {
1994 _ struct{} `type:"structure"`
1995
1996 // Dimension for which the given entitlement applies. Dimensions represent categories
1997 // of capacity in a product and are specified when the product is listed in
1998 // AWS Marketplace.
1999 DimensionKey *string `locationName:"dimensionKey" min:"1" type:"string"`
2000
2001 // Per unit price for the product dimension that’s used for calculating the
2002 // amount to be charged.
2003 Price *string `locationName:"price" min:"1" type:"string"`
2004 }
2005
2006 // String returns the string representation.
2007 //
2008 // API parameter values that are decorated as "sensitive" in the API will not
2009 // be included in the string output. The member name will be present, but the
2010 // value will be replaced with "sensitive".
2011 func (s RateCardItem) String() string {
2012 return awsutil.Prettify(s)
2013 }
2014
2015 // GoString returns the string representation.
2016 //
2017 // API parameter values that are decorated as "sensitive" in the API will not
2018 // be included in the string output. The member name will be present, but the
2019 // value will be replaced with "sensitive".
2020 func (s RateCardItem) GoString() string {
2021 return s.String()
2022 }
2023
2024 // SetDimensionKey sets the DimensionKey field's value.
2025 func (s *RateCardItem) SetDimensionKey(v string) *RateCardItem {
2026 s.DimensionKey = &v
2027 return s
2028 }
2029
2030 // SetPrice sets the Price field's value.
2031 func (s *RateCardItem) SetPrice(v string) *RateCardItem {
2032 s.Price = &v
2033 return s
2034 }
2035
2036 // Defines a pricing model where customers are charged a fixed recurring price
2037 // at the end of each billing period.
2038 type RecurringPaymentTerm struct {
2039 _ struct{} `type:"structure"`
2040
2041 // Defines the recurrence at which buyers are charged.
2042 BillingPeriod *string `locationName:"billingPeriod" min:"1" type:"string"`
2043
2044 // Defines the currency for the prices mentioned in this term.
2045 CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
2046
2047 // Amount charged to the buyer every billing period.
2048 Price *string `locationName:"price" min:"1" type:"string"`
2049
2050 // Type of the term being updated.
2051 Type *string `locationName:"type" min:"1" type:"string"`
2052 }
2053
2054 // String returns the string representation.
2055 //
2056 // API parameter values that are decorated as "sensitive" in the API will not
2057 // be included in the string output. The member name will be present, but the
2058 // value will be replaced with "sensitive".
2059 func (s RecurringPaymentTerm) String() string {
2060 return awsutil.Prettify(s)
2061 }
2062
2063 // GoString returns the string representation.
2064 //
2065 // API parameter values that are decorated as "sensitive" in the API will not
2066 // be included in the string output. The member name will be present, but the
2067 // value will be replaced with "sensitive".
2068 func (s RecurringPaymentTerm) GoString() string {
2069 return s.String()
2070 }
2071
2072 // SetBillingPeriod sets the BillingPeriod field's value.
2073 func (s *RecurringPaymentTerm) SetBillingPeriod(v string) *RecurringPaymentTerm {
2074 s.BillingPeriod = &v
2075 return s
2076 }
2077
2078 // SetCurrencyCode sets the CurrencyCode field's value.
2079 func (s *RecurringPaymentTerm) SetCurrencyCode(v string) *RecurringPaymentTerm {
2080 s.CurrencyCode = &v
2081 return s
2082 }
2083
2084 // SetPrice sets the Price field's value.
2085 func (s *RecurringPaymentTerm) SetPrice(v string) *RecurringPaymentTerm {
2086 s.Price = &v
2087 return s
2088 }
2089
2090 // SetType sets the Type field's value.
2091 func (s *RecurringPaymentTerm) SetType(v string) *RecurringPaymentTerm {
2092 s.Type = &v
2093 return s
2094 }
2095
2096 // Defines that on graceful expiration of the agreement (when the agreement
2097 // ends on its pre-defined end date), a new agreement will be created using
2098 // the accepted terms on the existing agreement. In other words, the agreement
2099 // will be renewed. The presence of RenewalTerm in the offer document means
2100 // that auto-renewal is allowed. Buyers will have the option to accept or decline
2101 // auto-renewal at the offer acceptance/agreement creation. Buyers can also
2102 // change this flag from True to False or False to True at anytime during the
2103 // agreement's lifecycle.
2104 type RenewalTerm struct {
2105 _ struct{} `type:"structure"`
2106
2107 // Additional parameters specified by the acceptor while accepting the term.
2108 Configuration *RenewalTermConfiguration `locationName:"configuration" type:"structure"`
2109
2110 // Category of the term being updated.
2111 Type *string `locationName:"type" min:"1" type:"string"`
2112 }
2113
2114 // String returns the string representation.
2115 //
2116 // API parameter values that are decorated as "sensitive" in the API will not
2117 // be included in the string output. The member name will be present, but the
2118 // value will be replaced with "sensitive".
2119 func (s RenewalTerm) String() string {
2120 return awsutil.Prettify(s)
2121 }
2122
2123 // GoString returns the string representation.
2124 //
2125 // API parameter values that are decorated as "sensitive" in the API will not
2126 // be included in the string output. The member name will be present, but the
2127 // value will be replaced with "sensitive".
2128 func (s RenewalTerm) GoString() string {
2129 return s.String()
2130 }
2131
2132 // SetConfiguration sets the Configuration field's value.
2133 func (s *RenewalTerm) SetConfiguration(v *RenewalTermConfiguration) *RenewalTerm {
2134 s.Configuration = v
2135 return s
2136 }
2137
2138 // SetType sets the Type field's value.
2139 func (s *RenewalTerm) SetType(v string) *RenewalTerm {
2140 s.Type = &v
2141 return s
2142 }
2143
2144 // Additional parameters specified by the acceptor while accepting the term.
2145 type RenewalTermConfiguration struct {
2146 _ struct{} `type:"structure"`
2147
2148 // Defines whether the acceptor has chosen to auto-renew the agreement at the
2149 // end of its lifecycle. Can be set to True or False.
2150 //
2151 // EnableAutoRenew is a required field
2152 EnableAutoRenew *bool `locationName:"enableAutoRenew" type:"boolean" required:"true"`
2153 }
2154
2155 // String returns the string representation.
2156 //
2157 // API parameter values that are decorated as "sensitive" in the API will not
2158 // be included in the string output. The member name will be present, but the
2159 // value will be replaced with "sensitive".
2160 func (s RenewalTermConfiguration) String() string {
2161 return awsutil.Prettify(s)
2162 }
2163
2164 // GoString returns the string representation.
2165 //
2166 // API parameter values that are decorated as "sensitive" in the API will not
2167 // be included in the string output. The member name will be present, but the
2168 // value will be replaced with "sensitive".
2169 func (s RenewalTermConfiguration) GoString() string {
2170 return s.String()
2171 }
2172
2173 // SetEnableAutoRenew sets the EnableAutoRenew field's value.
2174 func (s *RenewalTermConfiguration) SetEnableAutoRenew(v bool) *RenewalTermConfiguration {
2175 s.EnableAutoRenew = &v
2176 return s
2177 }
2178
2179 // The list of resources involved in the agreement.
2180 type Resource struct {
2181 _ struct{} `type:"structure"`
2182
2183 // The unique identifier of the resource.
2184 //
2185 // We mention the term resource, which is most commonly a product, so a resourceId
2186 // is also a productId.
2187 Id *string `locationName:"id" min:"1" type:"string"`
2188
2189 // Type of the resource, which is the product. Values include SaaSProduct or
2190 // AmiProduct.
2191 Type *string `locationName:"type" min:"1" type:"string"`
2192 }
2193
2194 // String returns the string representation.
2195 //
2196 // API parameter values that are decorated as "sensitive" in the API will not
2197 // be included in the string output. The member name will be present, but the
2198 // value will be replaced with "sensitive".
2199 func (s Resource) String() string {
2200 return awsutil.Prettify(s)
2201 }
2202
2203 // GoString returns the string representation.
2204 //
2205 // API parameter values that are decorated as "sensitive" in the API will not
2206 // be included in the string output. The member name will be present, but the
2207 // value will be replaced with "sensitive".
2208 func (s Resource) GoString() string {
2209 return s.String()
2210 }
2211
2212 // SetId sets the Id field's value.
2213 func (s *Resource) SetId(v string) *Resource {
2214 s.Id = &v
2215 return s
2216 }
2217
2218 // SetType sets the Type field's value.
2219 func (s *Resource) SetType(v string) *Resource {
2220 s.Type = &v
2221 return s
2222 }
2223
2224 // Request references a resource which does not exist.
2225 type ResourceNotFoundException struct {
2226 _ struct{} `type:"structure"`
2227 RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
2228
2229 Message_ *string `locationName:"message" min:"1" type:"string"`
2230
2231 // The unique identifier for the error.
2232 RequestId *string `locationName:"requestId" min:"1" type:"string"`
2233
2234 // The unique identifier for the resource.
2235 ResourceId *string `locationName:"resourceId" min:"1" type:"string"`
2236
2237 // The type of resource.
2238 ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
2239 }
2240
2241 // String returns the string representation.
2242 //
2243 // API parameter values that are decorated as "sensitive" in the API will not
2244 // be included in the string output. The member name will be present, but the
2245 // value will be replaced with "sensitive".
2246 func (s ResourceNotFoundException) String() string {
2247 return awsutil.Prettify(s)
2248 }
2249
2250 // GoString returns the string representation.
2251 //
2252 // API parameter values that are decorated as "sensitive" in the API will not
2253 // be included in the string output. The member name will be present, but the
2254 // value will be replaced with "sensitive".
2255 func (s ResourceNotFoundException) GoString() string {
2256 return s.String()
2257 }
2258
2259 func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
2260 return &ResourceNotFoundException{
2261 RespMetadata: v,
2262 }
2263 }
2264
2265 // Code returns the exception type name.
2266 func (s *ResourceNotFoundException) Code() string {
2267 return "ResourceNotFoundException"
2268 }
2269
2270 // Message returns the exception's message.
2271 func (s *ResourceNotFoundException) Message() string {
2272 if s.Message_ != nil {
2273 return *s.Message_
2274 }
2275 return ""
2276 }
2277
2278 // OrigErr always returns nil, satisfies awserr.Error interface.
2279 func (s *ResourceNotFoundException) OrigErr() error {
2280 return nil
2281 }
2282
2283 func (s *ResourceNotFoundException) Error() string {
2284 return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
2285 }
2286
2287 // Status code returns the HTTP status code for the request's response error.
2288 func (s *ResourceNotFoundException) StatusCode() int {
2289 return s.RespMetadata.StatusCode
2290 }
2291
2292 // RequestID returns the service's response RequestID for request.
2293 func (s *ResourceNotFoundException) RequestID() string {
2294 return s.RespMetadata.RequestID
2295 }
2296
2297 // An individual installment of the payment that includes the date and amount
2298 // of the charge.
2299 type ScheduleItem struct {
2300 _ struct{} `type:"structure"`
2301
2302 // The price that the customer would pay on the scheduled date (chargeDate).
2303 ChargeAmount *string `locationName:"chargeAmount" min:"1" type:"string"`
2304
2305 // The date that the customer would pay the price defined in this payment schedule
2306 // term. Invoices are generated on the date provided.
2307 ChargeDate *time.Time `locationName:"chargeDate" type:"timestamp"`
2308 }
2309
2310 // String returns the string representation.
2311 //
2312 // API parameter values that are decorated as "sensitive" in the API will not
2313 // be included in the string output. The member name will be present, but the
2314 // value will be replaced with "sensitive".
2315 func (s ScheduleItem) String() string {
2316 return awsutil.Prettify(s)
2317 }
2318
2319 // GoString returns the string representation.
2320 //
2321 // API parameter values that are decorated as "sensitive" in the API will not
2322 // be included in the string output. The member name will be present, but the
2323 // value will be replaced with "sensitive".
2324 func (s ScheduleItem) GoString() string {
2325 return s.String()
2326 }
2327
2328 // SetChargeAmount sets the ChargeAmount field's value.
2329 func (s *ScheduleItem) SetChargeAmount(v string) *ScheduleItem {
2330 s.ChargeAmount = &v
2331 return s
2332 }
2333
2334 // SetChargeDate sets the ChargeDate field's value.
2335 func (s *ScheduleItem) SetChargeDate(v time.Time) *ScheduleItem {
2336 s.ChargeDate = &v
2337 return s
2338 }
2339
2340 type SearchAgreementsInput struct {
2341 _ struct{} `type:"structure"`
2342
2343 // The catalog in which the agreement was created.
2344 Catalog *string `locationName:"catalog" min:"1" type:"string"`
2345
2346 // The filter name and value pair used to return a specific list of results.
2347 //
2348 // The following filters are supported:
2349 //
2350 // * ResourceIdentifier – The unique identifier of the resource.
2351 //
2352 // * ResourceType – Type of the resource, which is the product (AmiProduct,
2353 // ContainerProduct, or SaaSProduct).
2354 //
2355 // * PartyType – The party type (either Acceptor or Proposer) of the caller.
2356 // For agreements where the caller is the proposer, use the Proposer filter.
2357 // For agreements where the caller is the acceptor, use the Acceptor filter.
2358 //
2359 // * AcceptorAccountId – The AWS account ID of the party accepting the
2360 // agreement terms.
2361 //
2362 // * OfferId – The unique identifier of the offer in which the terms are
2363 // registered in the agreement token.
2364 //
2365 // * Status – The current status of the agreement. Values include ACTIVE,
2366 // ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.
2367 //
2368 // * BeforeEndTime – A date used to filter agreements with a date before
2369 // the endTime of an agreement.
2370 //
2371 // * AfterEndTime – A date used to filter agreements with a date after
2372 // the endTime of an agreement.
2373 //
2374 // * AgreementType – The type of agreement. Values include PurchaseAgreement
2375 // or VendorInsightsAgreement.
2376 Filters []*Filter `locationName:"filters" min:"1" type:"list"`
2377
2378 // The maximum number of agreements to return in the response.
2379 MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
2380
2381 // A token to specify where to start pagination.
2382 NextToken *string `locationName:"nextToken" type:"string"`
2383
2384 // An object that contains the SortBy and SortOrder attributes.
2385 Sort *Sort `locationName:"sort" type:"structure"`
2386 }
2387
2388 // String returns the string representation.
2389 //
2390 // API parameter values that are decorated as "sensitive" in the API will not
2391 // be included in the string output. The member name will be present, but the
2392 // value will be replaced with "sensitive".
2393 func (s SearchAgreementsInput) String() string {
2394 return awsutil.Prettify(s)
2395 }
2396
2397 // GoString returns the string representation.
2398 //
2399 // API parameter values that are decorated as "sensitive" in the API will not
2400 // be included in the string output. The member name will be present, but the
2401 // value will be replaced with "sensitive".
2402 func (s SearchAgreementsInput) GoString() string {
2403 return s.String()
2404 }
2405
2406 // Validate inspects the fields of the type to determine if they are valid.
2407 func (s *SearchAgreementsInput) Validate() error {
2408 invalidParams := request.ErrInvalidParams{Context: "SearchAgreementsInput"}
2409 if s.Catalog != nil && len(*s.Catalog) < 1 {
2410 invalidParams.Add(request.NewErrParamMinLen("Catalog", 1))
2411 }
2412 if s.Filters != nil && len(s.Filters) < 1 {
2413 invalidParams.Add(request.NewErrParamMinLen("Filters", 1))
2414 }
2415 if s.MaxResults != nil && *s.MaxResults < 1 {
2416 invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
2417 }
2418 if s.Filters != nil {
2419 for i, v := range s.Filters {
2420 if v == nil {
2421 continue
2422 }
2423 if err := v.Validate(); err != nil {
2424 invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
2425 }
2426 }
2427 }
2428 if s.Sort != nil {
2429 if err := s.Sort.Validate(); err != nil {
2430 invalidParams.AddNested("Sort", err.(request.ErrInvalidParams))
2431 }
2432 }
2433
2434 if invalidParams.Len() > 0 {
2435 return invalidParams
2436 }
2437 return nil
2438 }
2439
2440 // SetCatalog sets the Catalog field's value.
2441 func (s *SearchAgreementsInput) SetCatalog(v string) *SearchAgreementsInput {
2442 s.Catalog = &v
2443 return s
2444 }
2445
2446 // SetFilters sets the Filters field's value.
2447 func (s *SearchAgreementsInput) SetFilters(v []*Filter) *SearchAgreementsInput {
2448 s.Filters = v
2449 return s
2450 }
2451
2452 // SetMaxResults sets the MaxResults field's value.
2453 func (s *SearchAgreementsInput) SetMaxResults(v int64) *SearchAgreementsInput {
2454 s.MaxResults = &v
2455 return s
2456 }
2457
2458 // SetNextToken sets the NextToken field's value.
2459 func (s *SearchAgreementsInput) SetNextToken(v string) *SearchAgreementsInput {
2460 s.NextToken = &v
2461 return s
2462 }
2463
2464 // SetSort sets the Sort field's value.
2465 func (s *SearchAgreementsInput) SetSort(v *Sort) *SearchAgreementsInput {
2466 s.Sort = v
2467 return s
2468 }
2469
2470 type SearchAgreementsOutput struct {
2471 _ struct{} `type:"structure"`
2472
2473 // A summary of the agreement, including top-level attributes (for example,
2474 // the agreement ID, version, proposer, and acceptor).
2475 AgreementViewSummaries []*AgreementViewSummary `locationName:"agreementViewSummaries" type:"list"`
2476
2477 // The token used for pagination. The field is null if there are no more results.
2478 NextToken *string `locationName:"nextToken" type:"string"`
2479 }
2480
2481 // String returns the string representation.
2482 //
2483 // API parameter values that are decorated as "sensitive" in the API will not
2484 // be included in the string output. The member name will be present, but the
2485 // value will be replaced with "sensitive".
2486 func (s SearchAgreementsOutput) String() string {
2487 return awsutil.Prettify(s)
2488 }
2489
2490 // GoString returns the string representation.
2491 //
2492 // API parameter values that are decorated as "sensitive" in the API will not
2493 // be included in the string output. The member name will be present, but the
2494 // value will be replaced with "sensitive".
2495 func (s SearchAgreementsOutput) GoString() string {
2496 return s.String()
2497 }
2498
2499 // SetAgreementViewSummaries sets the AgreementViewSummaries field's value.
2500 func (s *SearchAgreementsOutput) SetAgreementViewSummaries(v []*AgreementViewSummary) *SearchAgreementsOutput {
2501 s.AgreementViewSummaries = v
2502 return s
2503 }
2504
2505 // SetNextToken sets the NextToken field's value.
2506 func (s *SearchAgreementsOutput) SetNextToken(v string) *SearchAgreementsOutput {
2507 s.NextToken = &v
2508 return s
2509 }
2510
2511 // Differentiates between the mutually exclusive rate cards in the same pricing
2512 // term to be selected by the buyer.
2513 type Selector struct {
2514 _ struct{} `type:"structure"`
2515
2516 // Category of selector.
2517 Type *string `locationName:"type" min:"1" type:"string"`
2518
2519 // Contract duration. This field supports the ISO 8601 format.
2520 Value *string `locationName:"value" min:"1" type:"string"`
2521 }
2522
2523 // String returns the string representation.
2524 //
2525 // API parameter values that are decorated as "sensitive" in the API will not
2526 // be included in the string output. The member name will be present, but the
2527 // value will be replaced with "sensitive".
2528 func (s Selector) String() string {
2529 return awsutil.Prettify(s)
2530 }
2531
2532 // GoString returns the string representation.
2533 //
2534 // API parameter values that are decorated as "sensitive" in the API will not
2535 // be included in the string output. The member name will be present, but the
2536 // value will be replaced with "sensitive".
2537 func (s Selector) GoString() string {
2538 return s.String()
2539 }
2540
2541 // SetType sets the Type field's value.
2542 func (s *Selector) SetType(v string) *Selector {
2543 s.Type = &v
2544 return s
2545 }
2546
2547 // SetValue sets the Value field's value.
2548 func (s *Selector) SetValue(v string) *Selector {
2549 s.Value = &v
2550 return s
2551 }
2552
2553 // An object that contains the SortBy and SortOrder attributes.
2554 type Sort struct {
2555 _ struct{} `type:"structure"`
2556
2557 // The attribute on which the data is grouped, which can be by StartTime and
2558 // EndTime. The default value is EndTime.
2559 SortBy *string `locationName:"sortBy" min:"1" type:"string"`
2560
2561 // The sorting order, which can be ASCENDING or DESCENDING. The default value
2562 // is DESCENDING.
2563 SortOrder *string `locationName:"sortOrder" type:"string" enum:"SortOrder"`
2564 }
2565
2566 // String returns the string representation.
2567 //
2568 // API parameter values that are decorated as "sensitive" in the API will not
2569 // be included in the string output. The member name will be present, but the
2570 // value will be replaced with "sensitive".
2571 func (s Sort) String() string {
2572 return awsutil.Prettify(s)
2573 }
2574
2575 // GoString returns the string representation.
2576 //
2577 // API parameter values that are decorated as "sensitive" in the API will not
2578 // be included in the string output. The member name will be present, but the
2579 // value will be replaced with "sensitive".
2580 func (s Sort) GoString() string {
2581 return s.String()
2582 }
2583
2584 // Validate inspects the fields of the type to determine if they are valid.
2585 func (s *Sort) Validate() error {
2586 invalidParams := request.ErrInvalidParams{Context: "Sort"}
2587 if s.SortBy != nil && len(*s.SortBy) < 1 {
2588 invalidParams.Add(request.NewErrParamMinLen("SortBy", 1))
2589 }
2590
2591 if invalidParams.Len() > 0 {
2592 return invalidParams
2593 }
2594 return nil
2595 }
2596
2597 // SetSortBy sets the SortBy field's value.
2598 func (s *Sort) SetSortBy(v string) *Sort {
2599 s.SortBy = &v
2600 return s
2601 }
2602
2603 // SetSortOrder sets the SortOrder field's value.
2604 func (s *Sort) SetSortOrder(v string) *Sort {
2605 s.SortOrder = &v
2606 return s
2607 }
2608
2609 // Defines the customer support available for the acceptors when they purchase
2610 // the software.
2611 type SupportTerm struct {
2612 _ struct{} `type:"structure"`
2613
2614 // Free-text field about the refund policy description that will be shown to
2615 // customers as is on the website and console.
2616 RefundPolicy *string `locationName:"refundPolicy" min:"1" type:"string"`
2617
2618 // Category of the term being updated.
2619 Type *string `locationName:"type" min:"1" type:"string"`
2620 }
2621
2622 // String returns the string representation.
2623 //
2624 // API parameter values that are decorated as "sensitive" in the API will not
2625 // be included in the string output. The member name will be present, but the
2626 // value will be replaced with "sensitive".
2627 func (s SupportTerm) String() string {
2628 return awsutil.Prettify(s)
2629 }
2630
2631 // GoString returns the string representation.
2632 //
2633 // API parameter values that are decorated as "sensitive" in the API will not
2634 // be included in the string output. The member name will be present, but the
2635 // value will be replaced with "sensitive".
2636 func (s SupportTerm) GoString() string {
2637 return s.String()
2638 }
2639
2640 // SetRefundPolicy sets the RefundPolicy field's value.
2641 func (s *SupportTerm) SetRefundPolicy(v string) *SupportTerm {
2642 s.RefundPolicy = &v
2643 return s
2644 }
2645
2646 // SetType sets the Type field's value.
2647 func (s *SupportTerm) SetType(v string) *SupportTerm {
2648 s.Type = &v
2649 return s
2650 }
2651
2652 // Request was denied due to request throttling.
2653 type ThrottlingException struct {
2654 _ struct{} `type:"structure"`
2655 RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
2656
2657 Message_ *string `locationName:"message" min:"1" type:"string"`
2658
2659 // The unique identifier for the error.
2660 RequestId *string `locationName:"requestId" min:"1" type:"string"`
2661 }
2662
2663 // String returns the string representation.
2664 //
2665 // API parameter values that are decorated as "sensitive" in the API will not
2666 // be included in the string output. The member name will be present, but the
2667 // value will be replaced with "sensitive".
2668 func (s ThrottlingException) String() string {
2669 return awsutil.Prettify(s)
2670 }
2671
2672 // GoString returns the string representation.
2673 //
2674 // API parameter values that are decorated as "sensitive" in the API will not
2675 // be included in the string output. The member name will be present, but the
2676 // value will be replaced with "sensitive".
2677 func (s ThrottlingException) GoString() string {
2678 return s.String()
2679 }
2680
2681 func newErrorThrottlingException(v protocol.ResponseMetadata) error {
2682 return &ThrottlingException{
2683 RespMetadata: v,
2684 }
2685 }
2686
2687 // Code returns the exception type name.
2688 func (s *ThrottlingException) Code() string {
2689 return "ThrottlingException"
2690 }
2691
2692 // Message returns the exception's message.
2693 func (s *ThrottlingException) Message() string {
2694 if s.Message_ != nil {
2695 return *s.Message_
2696 }
2697 return ""
2698 }
2699
2700 // OrigErr always returns nil, satisfies awserr.Error interface.
2701 func (s *ThrottlingException) OrigErr() error {
2702 return nil
2703 }
2704
2705 func (s *ThrottlingException) Error() string {
2706 return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
2707 }
2708
2709 // Status code returns the HTTP status code for the request's response error.
2710 func (s *ThrottlingException) StatusCode() int {
2711 return s.RespMetadata.StatusCode
2712 }
2713
2714 // RequestID returns the service's response RequestID for request.
2715 func (s *ThrottlingException) RequestID() string {
2716 return s.RespMetadata.RequestID
2717 }
2718
2719 // Defines a usage-based pricing model (typically, pay-as-you-go pricing), where
2720 // the customers are charged based on product usage.
2721 type UsageBasedPricingTerm struct {
2722 _ struct{} `type:"structure"`
2723
2724 // Defines the currency for the prices mentioned in the term.
2725 CurrencyCode *string `locationName:"currencyCode" min:"3" type:"string"`
2726
2727 // List of rate cards.
2728 RateCards []*UsageBasedRateCardItem `locationName:"rateCards" type:"list"`
2729
2730 // Category of the term.
2731 Type *string `locationName:"type" min:"1" type:"string"`
2732 }
2733
2734 // String returns the string representation.
2735 //
2736 // API parameter values that are decorated as "sensitive" in the API will not
2737 // be included in the string output. The member name will be present, but the
2738 // value will be replaced with "sensitive".
2739 func (s UsageBasedPricingTerm) String() string {
2740 return awsutil.Prettify(s)
2741 }
2742
2743 // GoString returns the string representation.
2744 //
2745 // API parameter values that are decorated as "sensitive" in the API will not
2746 // be included in the string output. The member name will be present, but the
2747 // value will be replaced with "sensitive".
2748 func (s UsageBasedPricingTerm) GoString() string {
2749 return s.String()
2750 }
2751
2752 // SetCurrencyCode sets the CurrencyCode field's value.
2753 func (s *UsageBasedPricingTerm) SetCurrencyCode(v string) *UsageBasedPricingTerm {
2754 s.CurrencyCode = &v
2755 return s
2756 }
2757
2758 // SetRateCards sets the RateCards field's value.
2759 func (s *UsageBasedPricingTerm) SetRateCards(v []*UsageBasedRateCardItem) *UsageBasedPricingTerm {
2760 s.RateCards = v
2761 return s
2762 }
2763
2764 // SetType sets the Type field's value.
2765 func (s *UsageBasedPricingTerm) SetType(v string) *UsageBasedPricingTerm {
2766 s.Type = &v
2767 return s
2768 }
2769
2770 // Within the pay-as-you-go model defined under UsageBasedPricingTerm, the UsageBasedRateCardItem
2771 // defines an individual rate for a product dimension.
2772 type UsageBasedRateCardItem struct {
2773 _ struct{} `type:"structure"`
2774
2775 // Defines the per unit rates for product dimensions.
2776 RateCard []*RateCardItem `locationName:"rateCard" type:"list"`
2777 }
2778
2779 // String returns the string representation.
2780 //
2781 // API parameter values that are decorated as "sensitive" in the API will not
2782 // be included in the string output. The member name will be present, but the
2783 // value will be replaced with "sensitive".
2784 func (s UsageBasedRateCardItem) String() string {
2785 return awsutil.Prettify(s)
2786 }
2787
2788 // GoString returns the string representation.
2789 //
2790 // API parameter values that are decorated as "sensitive" in the API will not
2791 // be included in the string output. The member name will be present, but the
2792 // value will be replaced with "sensitive".
2793 func (s UsageBasedRateCardItem) GoString() string {
2794 return s.String()
2795 }
2796
2797 // SetRateCard sets the RateCard field's value.
2798 func (s *UsageBasedRateCardItem) SetRateCard(v []*RateCardItem) *UsageBasedRateCardItem {
2799 s.RateCard = v
2800 return s
2801 }
2802
2803 // The input fails to satisfy the constraints specified by the service.
2804 type ValidationException struct {
2805 _ struct{} `type:"structure"`
2806 RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
2807
2808 // The fields associated with the error.
2809 Fields []*ValidationExceptionField `locationName:"fields" type:"list"`
2810
2811 Message_ *string `locationName:"message" min:"1" type:"string"`
2812
2813 // The reason associated with the error.
2814 Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`
2815
2816 // The unique identifier associated with the error.
2817 RequestId *string `locationName:"requestId" min:"1" type:"string"`
2818 }
2819
2820 // String returns the string representation.
2821 //
2822 // API parameter values that are decorated as "sensitive" in the API will not
2823 // be included in the string output. The member name will be present, but the
2824 // value will be replaced with "sensitive".
2825 func (s ValidationException) String() string {
2826 return awsutil.Prettify(s)
2827 }
2828
2829 // GoString returns the string representation.
2830 //
2831 // API parameter values that are decorated as "sensitive" in the API will not
2832 // be included in the string output. The member name will be present, but the
2833 // value will be replaced with "sensitive".
2834 func (s ValidationException) GoString() string {
2835 return s.String()
2836 }
2837
2838 func newErrorValidationException(v protocol.ResponseMetadata) error {
2839 return &ValidationException{
2840 RespMetadata: v,
2841 }
2842 }
2843
2844 // Code returns the exception type name.
2845 func (s *ValidationException) Code() string {
2846 return "ValidationException"
2847 }
2848
2849 // Message returns the exception's message.
2850 func (s *ValidationException) Message() string {
2851 if s.Message_ != nil {
2852 return *s.Message_
2853 }
2854 return ""
2855 }
2856
2857 // OrigErr always returns nil, satisfies awserr.Error interface.
2858 func (s *ValidationException) OrigErr() error {
2859 return nil
2860 }
2861
2862 func (s *ValidationException) Error() string {
2863 return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
2864 }
2865
2866 // Status code returns the HTTP status code for the request's response error.
2867 func (s *ValidationException) StatusCode() int {
2868 return s.RespMetadata.StatusCode
2869 }
2870
2871 // RequestID returns the service's response RequestID for request.
2872 func (s *ValidationException) RequestID() string {
2873 return s.RespMetadata.RequestID
2874 }
2875
2876 // The input fails to satisfy the constraints specified by the service.
2877 type ValidationExceptionField struct {
2878 _ struct{} `type:"structure"`
2879
2880 // See applicable actions.
2881 //
2882 // Message is a required field
2883 Message *string `locationName:"message" min:"1" type:"string" required:"true"`
2884
2885 // The name of the field associated with the error.
2886 //
2887 // Name is a required field
2888 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
2889 }
2890
2891 // String returns the string representation.
2892 //
2893 // API parameter values that are decorated as "sensitive" in the API will not
2894 // be included in the string output. The member name will be present, but the
2895 // value will be replaced with "sensitive".
2896 func (s ValidationExceptionField) String() string {
2897 return awsutil.Prettify(s)
2898 }
2899
2900 // GoString returns the string representation.
2901 //
2902 // API parameter values that are decorated as "sensitive" in the API will not
2903 // be included in the string output. The member name will be present, but the
2904 // value will be replaced with "sensitive".
2905 func (s ValidationExceptionField) GoString() string {
2906 return s.String()
2907 }
2908
2909 // SetMessage sets the Message field's value.
2910 func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField {
2911 s.Message = &v
2912 return s
2913 }
2914
2915 // SetName sets the Name field's value.
2916 func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField {
2917 s.Name = &v
2918 return s
2919 }
2920
2921 // Defines the conditions that will keep an agreement created from this offer
2922 // valid.
2923 type ValidityTerm struct {
2924 _ struct{} `type:"structure"`
2925
2926 // Defines the duration that the agreement remains active. If AgreementStartDate
2927 // isn’t provided, the agreement duration is relative to the agreement signature
2928 // time. The duration is represented in the ISO_8601 format.
2929 AgreementDuration *string `locationName:"agreementDuration" min:"1" type:"string"`
2930
2931 // Defines the date when the agreement ends. The agreement ends at 23:59:59.999
2932 // UTC on the date provided. If AgreementEndDate isn’t provided, the agreement
2933 // end date is determined by the validity of individual terms.
2934 AgreementEndDate *time.Time `locationName:"agreementEndDate" type:"timestamp"`
2935
2936 // Defines the date when agreement starts. The agreement starts at 00:00:00.000
2937 // UTC on the date provided. If AgreementStartDate isn’t provided, the agreement
2938 // start date is determined based on agreement signature time.
2939 AgreementStartDate *time.Time `locationName:"agreementStartDate" type:"timestamp"`
2940
2941 // Category of the term being updated.
2942 Type *string `locationName:"type" min:"1" type:"string"`
2943 }
2944
2945 // String returns the string representation.
2946 //
2947 // API parameter values that are decorated as "sensitive" in the API will not
2948 // be included in the string output. The member name will be present, but the
2949 // value will be replaced with "sensitive".
2950 func (s ValidityTerm) String() string {
2951 return awsutil.Prettify(s)
2952 }
2953
2954 // GoString returns the string representation.
2955 //
2956 // API parameter values that are decorated as "sensitive" in the API will not
2957 // be included in the string output. The member name will be present, but the
2958 // value will be replaced with "sensitive".
2959 func (s ValidityTerm) GoString() string {
2960 return s.String()
2961 }
2962
2963 // SetAgreementDuration sets the AgreementDuration field's value.
2964 func (s *ValidityTerm) SetAgreementDuration(v string) *ValidityTerm {
2965 s.AgreementDuration = &v
2966 return s
2967 }
2968
2969 // SetAgreementEndDate sets the AgreementEndDate field's value.
2970 func (s *ValidityTerm) SetAgreementEndDate(v time.Time) *ValidityTerm {
2971 s.AgreementEndDate = &v
2972 return s
2973 }
2974
2975 // SetAgreementStartDate sets the AgreementStartDate field's value.
2976 func (s *ValidityTerm) SetAgreementStartDate(v time.Time) *ValidityTerm {
2977 s.AgreementStartDate = &v
2978 return s
2979 }
2980
2981 // SetType sets the Type field's value.
2982 func (s *ValidityTerm) SetType(v string) *ValidityTerm {
2983 s.Type = &v
2984 return s
2985 }
2986
2987 const (
2988 // AgreementStatusActive is a AgreementStatus enum value
2989 AgreementStatusActive = "ACTIVE"
2990
2991 // AgreementStatusArchived is a AgreementStatus enum value
2992 AgreementStatusArchived = "ARCHIVED"
2993
2994 // AgreementStatusCancelled is a AgreementStatus enum value
2995 AgreementStatusCancelled = "CANCELLED"
2996
2997 // AgreementStatusExpired is a AgreementStatus enum value
2998 AgreementStatusExpired = "EXPIRED"
2999
3000 // AgreementStatusRenewed is a AgreementStatus enum value
3001 AgreementStatusRenewed = "RENEWED"
3002
3003 // AgreementStatusReplaced is a AgreementStatus enum value
3004 AgreementStatusReplaced = "REPLACED"
3005
3006 // AgreementStatusRolledBack is a AgreementStatus enum value
3007 AgreementStatusRolledBack = "ROLLED_BACK"
3008
3009 // AgreementStatusSuperseded is a AgreementStatus enum value
3010 AgreementStatusSuperseded = "SUPERSEDED"
3011
3012 // AgreementStatusTerminated is a AgreementStatus enum value
3013 AgreementStatusTerminated = "TERMINATED"
3014 )
3015
3016 // AgreementStatus_Values returns all elements of the AgreementStatus enum
3017 func AgreementStatus_Values() []string {
3018 return []string{
3019 AgreementStatusActive,
3020 AgreementStatusArchived,
3021 AgreementStatusCancelled,
3022 AgreementStatusExpired,
3023 AgreementStatusRenewed,
3024 AgreementStatusReplaced,
3025 AgreementStatusRolledBack,
3026 AgreementStatusSuperseded,
3027 AgreementStatusTerminated,
3028 }
3029 }
3030
3031 const (
3032 // ResourceTypeAgreement is a ResourceType enum value
3033 ResourceTypeAgreement = "Agreement"
3034 )
3035
3036 // ResourceType_Values returns all elements of the ResourceType enum
3037 func ResourceType_Values() []string {
3038 return []string{
3039 ResourceTypeAgreement,
3040 }
3041 }
3042
3043 const (
3044 // SortOrderAscending is a SortOrder enum value
3045 SortOrderAscending = "ASCENDING"
3046
3047 // SortOrderDescending is a SortOrder enum value
3048 SortOrderDescending = "DESCENDING"
3049 )
3050
3051 // SortOrder_Values returns all elements of the SortOrder enum
3052 func SortOrder_Values() []string {
3053 return []string{
3054 SortOrderAscending,
3055 SortOrderDescending,
3056 }
3057 }
3058
3059 const (
3060 // ValidationExceptionReasonInvalidAgreementId is a ValidationExceptionReason enum value
3061 ValidationExceptionReasonInvalidAgreementId = "INVALID_AGREEMENT_ID"
3062
3063 // ValidationExceptionReasonMissingAgreementId is a ValidationExceptionReason enum value
3064 ValidationExceptionReasonMissingAgreementId = "MISSING_AGREEMENT_ID"
3065
3066 // ValidationExceptionReasonInvalidCatalog is a ValidationExceptionReason enum value
3067 ValidationExceptionReasonInvalidCatalog = "INVALID_CATALOG"
3068
3069 // ValidationExceptionReasonInvalidFilterName is a ValidationExceptionReason enum value
3070 ValidationExceptionReasonInvalidFilterName = "INVALID_FILTER_NAME"
3071
3072 // ValidationExceptionReasonInvalidFilterValues is a ValidationExceptionReason enum value
3073 ValidationExceptionReasonInvalidFilterValues = "INVALID_FILTER_VALUES"
3074
3075 // ValidationExceptionReasonInvalidSortBy is a ValidationExceptionReason enum value
3076 ValidationExceptionReasonInvalidSortBy = "INVALID_SORT_BY"
3077
3078 // ValidationExceptionReasonInvalidSortOrder is a ValidationExceptionReason enum value
3079 ValidationExceptionReasonInvalidSortOrder = "INVALID_SORT_ORDER"
3080
3081 // ValidationExceptionReasonInvalidNextToken is a ValidationExceptionReason enum value
3082 ValidationExceptionReasonInvalidNextToken = "INVALID_NEXT_TOKEN"
3083
3084 // ValidationExceptionReasonInvalidMaxResults is a ValidationExceptionReason enum value
3085 ValidationExceptionReasonInvalidMaxResults = "INVALID_MAX_RESULTS"
3086
3087 // ValidationExceptionReasonUnsupportedFilters is a ValidationExceptionReason enum value
3088 ValidationExceptionReasonUnsupportedFilters = "UNSUPPORTED_FILTERS"
3089
3090 // ValidationExceptionReasonOther is a ValidationExceptionReason enum value
3091 ValidationExceptionReasonOther = "OTHER"
3092 )
3093
3094 // ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum
3095 func ValidationExceptionReason_Values() []string {
3096 return []string{
3097 ValidationExceptionReasonInvalidAgreementId,
3098 ValidationExceptionReasonMissingAgreementId,
3099 ValidationExceptionReasonInvalidCatalog,
3100 ValidationExceptionReasonInvalidFilterName,
3101 ValidationExceptionReasonInvalidFilterValues,
3102 ValidationExceptionReasonInvalidSortBy,
3103 ValidationExceptionReasonInvalidSortOrder,
3104 ValidationExceptionReasonInvalidNextToken,
3105 ValidationExceptionReasonInvalidMaxResults,
3106 ValidationExceptionReasonUnsupportedFilters,
3107 ValidationExceptionReasonOther,
3108 }
3109 }