Debian Codegraph @

models/apis/marketplace-agreement/2020-03-01/api-2.json

raw
1 {
2 "version":"2.0",
3 "metadata":{
4 "apiVersion":"2020-03-01",
5 "endpointPrefix":"agreement-marketplace",
6 "jsonVersion":"1.0",
7 "protocol":"json",
8 "serviceAbbreviation":"Agreement Service",
9 "serviceFullName":"AWS Marketplace Agreement Service",
10 "serviceId":"Marketplace Agreement",
11 "signatureVersion":"v4",
12 "signingName":"aws-marketplace",
13 "targetPrefix":"AWSMPCommerceService_v20200301",
14 "uid":"marketplace-agreement-2020-03-01"
15 },
16 "operations":{
17 "DescribeAgreement":{
18 "name":"DescribeAgreement",
19 "http":{
20 "method":"POST",
21 "requestUri":"/"
22 },
23 "input":{"shape":"DescribeAgreementInput"},
24 "output":{"shape":"DescribeAgreementOutput"},
25 "errors":[
26 {"shape":"ValidationException"},
27 {"shape":"AccessDeniedException"},
28 {"shape":"ThrottlingException"},
29 {"shape":"ResourceNotFoundException"},
30 {"shape":"InternalServerException"}
31 ]
32 },
33 "GetAgreementTerms":{
34 "name":"GetAgreementTerms",
35 "http":{
36 "method":"POST",
37 "requestUri":"/"
38 },
39 "input":{"shape":"GetAgreementTermsInput"},
40 "output":{"shape":"GetAgreementTermsOutput"},
41 "errors":[
42 {"shape":"ValidationException"},
43 {"shape":"AccessDeniedException"},
44 {"shape":"ThrottlingException"},
45 {"shape":"ResourceNotFoundException"},
46 {"shape":"InternalServerException"}
47 ]
48 },
49 "SearchAgreements":{
50 "name":"SearchAgreements",
51 "http":{
52 "method":"POST",
53 "requestUri":"/"
54 },
55 "input":{"shape":"SearchAgreementsInput"},
56 "output":{"shape":"SearchAgreementsOutput"},
57 "errors":[
58 {"shape":"ValidationException"},
59 {"shape":"AccessDeniedException"},
60 {"shape":"ThrottlingException"},
61 {"shape":"InternalServerException"}
62 ]
63 }
64 },
65 "shapes":{
66 "AWSAccountId":{
67 "type":"string",
68 "max":32,
69 "min":1,
70 "pattern":"^[0-9]+$"
71 },
72 "AcceptedTerm":{
73 "type":"structure",
74 "members":{
75 "byolPricingTerm":{"shape":"ByolPricingTerm"},
76 "configurableUpfrontPricingTerm":{"shape":"ConfigurableUpfrontPricingTerm"},
77 "fixedUpfrontPricingTerm":{"shape":"FixedUpfrontPricingTerm"},
78 "freeTrialPricingTerm":{"shape":"FreeTrialPricingTerm"},
79 "legalTerm":{"shape":"LegalTerm"},
80 "paymentScheduleTerm":{"shape":"PaymentScheduleTerm"},
81 "recurringPaymentTerm":{"shape":"RecurringPaymentTerm"},
82 "renewalTerm":{"shape":"RenewalTerm"},
83 "supportTerm":{"shape":"SupportTerm"},
84 "usageBasedPricingTerm":{"shape":"UsageBasedPricingTerm"},
85 "validityTerm":{"shape":"ValidityTerm"}
86 },
87 "union":true
88 },
89 "AcceptedTermList":{
90 "type":"list",
91 "member":{"shape":"AcceptedTerm"}
92 },
93 "Acceptor":{
94 "type":"structure",
95 "members":{
96 "accountId":{"shape":"AWSAccountId"}
97 }
98 },
99 "AccessDeniedException":{
100 "type":"structure",
101 "members":{
102 "message":{"shape":"ExceptionMessage"},
103 "requestId":{"shape":"RequestId"}
104 },
105 "exception":true
106 },
107 "AgreementResourceType":{
108 "type":"string",
109 "max":64,
110 "min":1,
111 "pattern":"^[a-zA-Z]+$"
112 },
113 "AgreementStatus":{
114 "type":"string",
115 "enum":[
116 "ACTIVE",
117 "ARCHIVED",
118 "CANCELLED",
119 "EXPIRED",
120 "RENEWED",
121 "REPLACED",
122 "ROLLED_BACK",
123 "SUPERSEDED",
124 "TERMINATED"
125 ]
126 },
127 "AgreementType":{
128 "type":"string",
129 "max":64,
130 "min":1,
131 "pattern":"^[A-Za-z]+$"
132 },
133 "AgreementViewSummary":{
134 "type":"structure",
135 "members":{
136 "acceptanceTime":{"shape":"Timestamp"},
137 "acceptor":{"shape":"Acceptor"},
138 "agreementId":{"shape":"ResourceId"},
139 "agreementType":{"shape":"AgreementType"},
140 "endTime":{"shape":"Timestamp"},
141 "proposalSummary":{"shape":"ProposalSummary"},
142 "proposer":{"shape":"Proposer"},
143 "startTime":{"shape":"Timestamp"},
144 "status":{"shape":"AgreementStatus"}
145 }
146 },
147 "AgreementViewSummaryList":{
148 "type":"list",
149 "member":{"shape":"AgreementViewSummary"}
150 },
151 "Boolean":{
152 "type":"boolean",
153 "box":true
154 },
155 "BoundedString":{
156 "type":"string",
157 "max":4096,
158 "min":1,
159 "pattern":"^(.)+$"
160 },
161 "ByolPricingTerm":{
162 "type":"structure",
163 "members":{
164 "type":{"shape":"UnversionedTermType"}
165 }
166 },
167 "Catalog":{
168 "type":"string",
169 "max":64,
170 "min":1,
171 "pattern":"^[a-zA-Z]+$"
172 },
173 "ConfigurableUpfrontPricingTerm":{
174 "type":"structure",
175 "members":{
176 "configuration":{"shape":"ConfigurableUpfrontPricingTermConfiguration"},
177 "currencyCode":{"shape":"CurrencyCode"},
178 "rateCards":{"shape":"ConfigurableUpfrontRateCardList"},
179 "type":{"shape":"UnversionedTermType"}
180 }
181 },
182 "ConfigurableUpfrontPricingTermConfiguration":{
183 "type":"structure",
184 "required":[
185 "dimensions",
186 "selectorValue"
187 ],
188 "members":{
189 "dimensions":{"shape":"DimensionList"},
190 "selectorValue":{"shape":"BoundedString"}
191 }
192 },
193 "ConfigurableUpfrontRateCardItem":{
194 "type":"structure",
195 "members":{
196 "constraints":{"shape":"Constraints"},
197 "rateCard":{"shape":"RateCardList"},
198 "selector":{"shape":"Selector"}
199 }
200 },
201 "ConfigurableUpfrontRateCardList":{
202 "type":"list",
203 "member":{"shape":"ConfigurableUpfrontRateCardItem"}
204 },
205 "Constraints":{
206 "type":"structure",
207 "members":{
208 "multipleDimensionSelection":{"shape":"BoundedString"},
209 "quantityConfiguration":{"shape":"BoundedString"}
210 }
211 },
212 "CurrencyCode":{
213 "type":"string",
214 "max":3,
215 "min":3,
216 "pattern":"^[A-Z]+$"
217 },
218 "DescribeAgreementInput":{
219 "type":"structure",
220 "required":["agreementId"],
221 "members":{
222 "agreementId":{"shape":"ResourceId"}
223 }
224 },
225 "DescribeAgreementOutput":{
226 "type":"structure",
227 "members":{
228 "acceptanceTime":{"shape":"Timestamp"},
229 "acceptor":{"shape":"Acceptor"},
230 "agreementId":{"shape":"ResourceId"},
231 "agreementType":{"shape":"AgreementType"},
232 "endTime":{"shape":"Timestamp"},
233 "estimatedCharges":{"shape":"EstimatedCharges"},
234 "proposalSummary":{"shape":"ProposalSummary"},
235 "proposer":{"shape":"Proposer"},
236 "startTime":{"shape":"Timestamp"},
237 "status":{"shape":"AgreementStatus"}
238 }
239 },
240 "Dimension":{
241 "type":"structure",
242 "required":[
243 "dimensionKey",
244 "dimensionValue"
245 ],
246 "members":{
247 "dimensionKey":{"shape":"BoundedString"},
248 "dimensionValue":{"shape":"ZeroValueInteger"}
249 }
250 },
251 "DimensionList":{
252 "type":"list",
253 "member":{"shape":"Dimension"},
254 "min":1
255 },
256 "DocumentItem":{
257 "type":"structure",
258 "members":{
259 "type":{"shape":"BoundedString"},
260 "url":{"shape":"BoundedString"},
261 "version":{"shape":"BoundedString"}
262 }
263 },
264 "DocumentList":{
265 "type":"list",
266 "member":{"shape":"DocumentItem"}
267 },
268 "EstimatedCharges":{
269 "type":"structure",
270 "members":{
271 "agreementValue":{"shape":"BoundedString"},
272 "currencyCode":{"shape":"CurrencyCode"}
273 }
274 },
275 "ExceptionMessage":{
276 "type":"string",
277 "max":1024,
278 "min":1
279 },
280 "Filter":{
281 "type":"structure",
282 "members":{
283 "name":{"shape":"FilterName"},
284 "values":{"shape":"FilterValueList"}
285 }
286 },
287 "FilterList":{
288 "type":"list",
289 "member":{"shape":"Filter"},
290 "max":10,
291 "min":1
292 },
293 "FilterName":{
294 "type":"string",
295 "max":32,
296 "min":1,
297 "pattern":"^[A-Za-z_]+$"
298 },
299 "FilterValue":{
300 "type":"string",
301 "max":64,
302 "min":1,
303 "pattern":"^[A-Za-z0-9+:_-]+$"
304 },
305 "FilterValueList":{
306 "type":"list",
307 "member":{"shape":"FilterValue"},
308 "max":1,
309 "min":1
310 },
311 "FixedUpfrontPricingTerm":{
312 "type":"structure",
313 "members":{
314 "currencyCode":{"shape":"CurrencyCode"},
315 "duration":{"shape":"BoundedString"},
316 "grants":{"shape":"GrantList"},
317 "price":{"shape":"BoundedString"},
318 "type":{"shape":"UnversionedTermType"}
319 }
320 },
321 "FreeTrialPricingTerm":{
322 "type":"structure",
323 "members":{
324 "duration":{"shape":"BoundedString"},
325 "grants":{"shape":"GrantList"},
326 "type":{"shape":"UnversionedTermType"}
327 }
328 },
329 "GetAgreementTermsInput":{
330 "type":"structure",
331 "required":["agreementId"],
332 "members":{
333 "agreementId":{"shape":"ResourceId"},
334 "maxResults":{"shape":"MaxResults"},
335 "nextToken":{"shape":"NextToken"}
336 }
337 },
338 "GetAgreementTermsOutput":{
339 "type":"structure",
340 "members":{
341 "acceptedTerms":{"shape":"AcceptedTermList"},
342 "nextToken":{"shape":"NextToken"}
343 }
344 },
345 "GrantItem":{
346 "type":"structure",
347 "members":{
348 "dimensionKey":{"shape":"BoundedString"},
349 "maxQuantity":{"shape":"PositiveIntegerWithDefaultValueOne"}
350 }
351 },
352 "GrantList":{
353 "type":"list",
354 "member":{"shape":"GrantItem"}
355 },
356 "InternalServerException":{
357 "type":"structure",
358 "members":{
359 "message":{"shape":"ExceptionMessage"},
360 "requestId":{"shape":"RequestId"}
361 },
362 "exception":true,
363 "fault":true
364 },
365 "LegalTerm":{
366 "type":"structure",
367 "members":{
368 "documents":{"shape":"DocumentList"},
369 "type":{"shape":"UnversionedTermType"}
370 }
371 },
372 "MaxResults":{
373 "type":"integer",
374 "box":true,
375 "max":50,
376 "min":1
377 },
378 "NextToken":{
379 "type":"string",
380 "max":8192,
381 "min":0,
382 "pattern":"^[a-zA-Z0-9+/=]+$"
383 },
384 "OfferId":{
385 "type":"string",
386 "max":64,
387 "min":1,
388 "pattern":"^\\S{1,64}$"
389 },
390 "PaymentScheduleTerm":{
391 "type":"structure",
392 "members":{
393 "currencyCode":{"shape":"CurrencyCode"},
394 "schedule":{"shape":"ScheduleList"},
395 "type":{"shape":"UnversionedTermType"}
396 }
397 },
398 "PositiveIntegerWithDefaultValueOne":{
399 "type":"integer",
400 "box":true,
401 "min":1
402 },
403 "ProposalSummary":{
404 "type":"structure",
405 "members":{
406 "offerId":{"shape":"OfferId"},
407 "resources":{"shape":"Resources"}
408 }
409 },
410 "Proposer":{
411 "type":"structure",
412 "members":{
413 "accountId":{"shape":"AWSAccountId"}
414 }
415 },
416 "RateCardItem":{
417 "type":"structure",
418 "members":{
419 "dimensionKey":{"shape":"BoundedString"},
420 "price":{"shape":"BoundedString"}
421 }
422 },
423 "RateCardList":{
424 "type":"list",
425 "member":{"shape":"RateCardItem"}
426 },
427 "RecurringPaymentTerm":{
428 "type":"structure",
429 "members":{
430 "billingPeriod":{"shape":"BoundedString"},
431 "currencyCode":{"shape":"CurrencyCode"},
432 "price":{"shape":"BoundedString"},
433 "type":{"shape":"UnversionedTermType"}
434 }
435 },
436 "RenewalTerm":{
437 "type":"structure",
438 "members":{
439 "configuration":{"shape":"RenewalTermConfiguration"},
440 "type":{"shape":"UnversionedTermType"}
441 }
442 },
443 "RenewalTermConfiguration":{
444 "type":"structure",
445 "required":["enableAutoRenew"],
446 "members":{
447 "enableAutoRenew":{"shape":"Boolean"}
448 }
449 },
450 "RequestId":{
451 "type":"string",
452 "max":128,
453 "min":1,
454 "pattern":"^[A-Za-z0-9-]+$"
455 },
456 "Resource":{
457 "type":"structure",
458 "members":{
459 "id":{"shape":"ResourceId"},
460 "type":{"shape":"AgreementResourceType"}
461 }
462 },
463 "ResourceId":{
464 "type":"string",
465 "max":64,
466 "min":1,
467 "pattern":"^[A-Za-z0-9_/-]+$"
468 },
469 "ResourceNotFoundException":{
470 "type":"structure",
471 "members":{
472 "message":{"shape":"ExceptionMessage"},
473 "requestId":{"shape":"RequestId"},
474 "resourceId":{"shape":"ResourceId"},
475 "resourceType":{"shape":"ResourceType"}
476 },
477 "exception":true
478 },
479 "ResourceType":{
480 "type":"string",
481 "enum":["Agreement"]
482 },
483 "Resources":{
484 "type":"list",
485 "member":{"shape":"Resource"}
486 },
487 "ScheduleItem":{
488 "type":"structure",
489 "members":{
490 "chargeAmount":{"shape":"BoundedString"},
491 "chargeDate":{"shape":"Timestamp"}
492 }
493 },
494 "ScheduleList":{
495 "type":"list",
496 "member":{"shape":"ScheduleItem"}
497 },
498 "SearchAgreementsInput":{
499 "type":"structure",
500 "members":{
501 "catalog":{"shape":"Catalog"},
502 "filters":{"shape":"FilterList"},
503 "maxResults":{"shape":"MaxResults"},
504 "nextToken":{"shape":"NextToken"},
505 "sort":{"shape":"Sort"}
506 }
507 },
508 "SearchAgreementsOutput":{
509 "type":"structure",
510 "members":{
511 "agreementViewSummaries":{"shape":"AgreementViewSummaryList"},
512 "nextToken":{"shape":"NextToken"}
513 }
514 },
515 "Selector":{
516 "type":"structure",
517 "members":{
518 "type":{"shape":"BoundedString"},
519 "value":{"shape":"BoundedString"}
520 }
521 },
522 "Sort":{
523 "type":"structure",
524 "members":{
525 "sortBy":{"shape":"SortBy"},
526 "sortOrder":{"shape":"SortOrder"}
527 }
528 },
529 "SortBy":{
530 "type":"string",
531 "max":255,
532 "min":1,
533 "pattern":"^[A-Za-z_]+$"
534 },
535 "SortOrder":{
536 "type":"string",
537 "enum":[
538 "ASCENDING",
539 "DESCENDING"
540 ]
541 },
542 "SupportTerm":{
543 "type":"structure",
544 "members":{
545 "refundPolicy":{"shape":"BoundedString"},
546 "type":{"shape":"UnversionedTermType"}
547 }
548 },
549 "ThrottlingException":{
550 "type":"structure",
551 "members":{
552 "message":{"shape":"ExceptionMessage"},
553 "requestId":{"shape":"RequestId"}
554 },
555 "exception":true
556 },
557 "Timestamp":{"type":"timestamp"},
558 "UnversionedTermType":{
559 "type":"string",
560 "max":4096,
561 "min":1,
562 "pattern":"^[A-Za-z]+$"
563 },
564 "UsageBasedPricingTerm":{
565 "type":"structure",
566 "members":{
567 "currencyCode":{"shape":"CurrencyCode"},
568 "rateCards":{"shape":"UsageBasedRateCardList"},
569 "type":{"shape":"UnversionedTermType"}
570 }
571 },
572 "UsageBasedRateCardItem":{
573 "type":"structure",
574 "members":{
575 "rateCard":{"shape":"RateCardList"}
576 }
577 },
578 "UsageBasedRateCardList":{
579 "type":"list",
580 "member":{"shape":"UsageBasedRateCardItem"}
581 },
582 "ValidationException":{
583 "type":"structure",
584 "members":{
585 "fields":{"shape":"ValidationExceptionFieldList"},
586 "message":{"shape":"ExceptionMessage"},
587 "reason":{"shape":"ValidationExceptionReason"},
588 "requestId":{"shape":"RequestId"}
589 },
590 "exception":true
591 },
592 "ValidationExceptionField":{
593 "type":"structure",
594 "required":[
595 "message",
596 "name"
597 ],
598 "members":{
599 "message":{"shape":"BoundedString"},
600 "name":{"shape":"BoundedString"}
601 }
602 },
603 "ValidationExceptionFieldList":{
604 "type":"list",
605 "member":{"shape":"ValidationExceptionField"}
606 },
607 "ValidationExceptionReason":{
608 "type":"string",
609 "enum":[
610 "INVALID_AGREEMENT_ID",
611 "MISSING_AGREEMENT_ID",
612 "INVALID_CATALOG",
613 "INVALID_FILTER_NAME",
614 "INVALID_FILTER_VALUES",
615 "INVALID_SORT_BY",
616 "INVALID_SORT_ORDER",
617 "INVALID_NEXT_TOKEN",
618 "INVALID_MAX_RESULTS",
619 "UNSUPPORTED_FILTERS",
620 "OTHER"
621 ]
622 },
623 "ValidityTerm":{
624 "type":"structure",
625 "members":{
626 "agreementDuration":{"shape":"BoundedString"},
627 "agreementEndDate":{"shape":"Timestamp"},
628 "agreementStartDate":{"shape":"Timestamp"},
629 "type":{"shape":"UnversionedTermType"}
630 }
631 },
632 "ZeroValueInteger":{
633 "type":"integer",
634 "min":0
635 }
636 }
637 }