• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2022-07-26",
5    "endpointPrefix":"cloudfront-keyvaluestore",
6    "jsonVersion":"1.1",
7    "protocol":"rest-json",
8    "serviceFullName":"Amazon CloudFront KeyValueStore",
9    "serviceId":"CloudFront KeyValueStore",
10    "signatureVersion":"v4",
11    "signingName":"cloudfront-keyvaluestore",
12    "uid":"cloudfront-keyvaluestore-2022-07-26"
13  },
14  "operations":{
15    "DeleteKey":{
16      "name":"DeleteKey",
17      "http":{
18        "method":"DELETE",
19        "requestUri":"/key-value-stores/{KvsARN}/keys/{Key}",
20        "responseCode":200
21      },
22      "input":{"shape":"DeleteKeyRequest"},
23      "output":{"shape":"DeleteKeyResponse"},
24      "errors":[
25        {"shape":"ConflictException"},
26        {"shape":"ValidationException"},
27        {"shape":"InternalServerException"},
28        {"shape":"ServiceQuotaExceededException"},
29        {"shape":"ResourceNotFoundException"},
30        {"shape":"AccessDeniedException"}
31      ],
32      "documentation":"<p>Deletes the key value pair specified by the key.</p>",
33      "idempotent":true
34    },
35    "DescribeKeyValueStore":{
36      "name":"DescribeKeyValueStore",
37      "http":{
38        "method":"GET",
39        "requestUri":"/key-value-stores/{KvsARN}",
40        "responseCode":200
41      },
42      "input":{"shape":"DescribeKeyValueStoreRequest"},
43      "output":{"shape":"DescribeKeyValueStoreResponse"},
44      "errors":[
45        {"shape":"ConflictException"},
46        {"shape":"InternalServerException"},
47        {"shape":"ResourceNotFoundException"},
48        {"shape":"AccessDeniedException"}
49      ],
50      "documentation":"<p>Returns metadata information about Key Value Store.</p>"
51    },
52    "GetKey":{
53      "name":"GetKey",
54      "http":{
55        "method":"GET",
56        "requestUri":"/key-value-stores/{KvsARN}/keys/{Key}",
57        "responseCode":200
58      },
59      "input":{"shape":"GetKeyRequest"},
60      "output":{"shape":"GetKeyResponse"},
61      "errors":[
62        {"shape":"ConflictException"},
63        {"shape":"InternalServerException"},
64        {"shape":"ResourceNotFoundException"},
65        {"shape":"AccessDeniedException"}
66      ],
67      "documentation":"<p>Returns a key value pair.</p>"
68    },
69    "ListKeys":{
70      "name":"ListKeys",
71      "http":{
72        "method":"GET",
73        "requestUri":"/key-value-stores/{KvsARN}/keys",
74        "responseCode":200
75      },
76      "input":{"shape":"ListKeysRequest"},
77      "output":{"shape":"ListKeysResponse"},
78      "errors":[
79        {"shape":"ConflictException"},
80        {"shape":"ValidationException"},
81        {"shape":"InternalServerException"},
82        {"shape":"ResourceNotFoundException"},
83        {"shape":"AccessDeniedException"}
84      ],
85      "documentation":"<p>Returns a list of key value pairs.</p>"
86    },
87    "PutKey":{
88      "name":"PutKey",
89      "http":{
90        "method":"PUT",
91        "requestUri":"/key-value-stores/{KvsARN}/keys/{Key}",
92        "responseCode":200
93      },
94      "input":{"shape":"PutKeyRequest"},
95      "output":{"shape":"PutKeyResponse"},
96      "errors":[
97        {"shape":"ConflictException"},
98        {"shape":"ValidationException"},
99        {"shape":"InternalServerException"},
100        {"shape":"ServiceQuotaExceededException"},
101        {"shape":"ResourceNotFoundException"},
102        {"shape":"AccessDeniedException"}
103      ],
104      "documentation":"<p>Creates a new key value pair or replaces the value of an existing key.</p>",
105      "idempotent":true
106    },
107    "UpdateKeys":{
108      "name":"UpdateKeys",
109      "http":{
110        "method":"POST",
111        "requestUri":"/key-value-stores/{KvsARN}/keys",
112        "responseCode":200
113      },
114      "input":{"shape":"UpdateKeysRequest"},
115      "output":{"shape":"UpdateKeysResponse"},
116      "errors":[
117        {"shape":"ConflictException"},
118        {"shape":"ValidationException"},
119        {"shape":"InternalServerException"},
120        {"shape":"ServiceQuotaExceededException"},
121        {"shape":"ResourceNotFoundException"},
122        {"shape":"AccessDeniedException"}
123      ],
124      "documentation":"<p>Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.</p>",
125      "idempotent":true
126    }
127  },
128  "shapes":{
129    "AccessDeniedException":{
130      "type":"structure",
131      "members":{
132        "Message":{"shape":"String"}
133      },
134      "documentation":"<p>Access denied.</p>",
135      "error":{
136        "httpStatusCode":403,
137        "senderFault":true
138      },
139      "exception":true
140    },
141    "ConflictException":{
142      "type":"structure",
143      "members":{
144        "Message":{"shape":"String"}
145      },
146      "documentation":"<p>Resource is not in expected state.</p>",
147      "error":{
148        "httpStatusCode":409,
149        "senderFault":true
150      },
151      "exception":true
152    },
153    "DeleteKeyRequest":{
154      "type":"structure",
155      "required":[
156        "KvsARN",
157        "Key",
158        "IfMatch"
159      ],
160      "members":{
161        "KvsARN":{
162          "shape":"KvsARN",
163          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>",
164          "contextParam":{"name":"KvsARN"},
165          "location":"uri",
166          "locationName":"KvsARN"
167        },
168        "Key":{
169          "shape":"Key",
170          "documentation":"<p>The key to delete.</p>",
171          "location":"uri",
172          "locationName":"Key"
173        },
174        "IfMatch":{
175          "shape":"Etag",
176          "documentation":"<p>The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.</p>",
177          "location":"header",
178          "locationName":"If-Match"
179        }
180      }
181    },
182    "DeleteKeyRequestListItem":{
183      "type":"structure",
184      "required":["Key"],
185      "members":{
186        "Key":{
187          "shape":"Key",
188          "documentation":"<p>The key of the key value pair to be deleted.</p>"
189        }
190      },
191      "documentation":"<p>List item for keys to delete.</p>"
192    },
193    "DeleteKeyRequestsList":{
194      "type":"list",
195      "member":{"shape":"DeleteKeyRequestListItem"}
196    },
197    "DeleteKeyResponse":{
198      "type":"structure",
199      "required":[
200        "ItemCount",
201        "TotalSizeInBytes",
202        "ETag"
203      ],
204      "members":{
205        "ItemCount":{
206          "shape":"Integer",
207          "documentation":"<p>Number of key value pairs in the Key Value Store after the successful delete.</p>"
208        },
209        "TotalSizeInBytes":{
210          "shape":"Long",
211          "documentation":"<p>Total size of the Key Value Store after the successful delete, in bytes.</p>"
212        },
213        "ETag":{
214          "shape":"Etag",
215          "documentation":"<p>The current version identifier of the Key Value Store after the successful delete.</p>",
216          "location":"header",
217          "locationName":"ETag"
218        }
219      },
220      "documentation":"<p>Metadata information about a Key Value Store.</p>"
221    },
222    "DescribeKeyValueStoreRequest":{
223      "type":"structure",
224      "required":["KvsARN"],
225      "members":{
226        "KvsARN":{
227          "shape":"KvsARN",
228          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>",
229          "contextParam":{"name":"KvsARN"},
230          "location":"uri",
231          "locationName":"KvsARN"
232        }
233      }
234    },
235    "DescribeKeyValueStoreResponse":{
236      "type":"structure",
237      "required":[
238        "ItemCount",
239        "TotalSizeInBytes",
240        "KvsARN",
241        "Created",
242        "ETag"
243      ],
244      "members":{
245        "ItemCount":{
246          "shape":"Integer",
247          "documentation":"<p>Number of key value pairs in the Key Value Store.</p>"
248        },
249        "TotalSizeInBytes":{
250          "shape":"Long",
251          "documentation":"<p>Total size of the Key Value Store in bytes.</p>"
252        },
253        "KvsARN":{
254          "shape":"KvsARN",
255          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>"
256        },
257        "Created":{
258          "shape":"Timestamp",
259          "documentation":"<p>Date and time when the Key Value Store was created.</p>"
260        },
261        "ETag":{
262          "shape":"Etag",
263          "documentation":"<p>The version identifier for the current version of the Key Value Store.</p>",
264          "location":"header",
265          "locationName":"ETag"
266        },
267        "LastModified":{
268          "shape":"Timestamp",
269          "documentation":"<p>Date and time when the key value pairs in the Key Value Store was last modified.</p>"
270        },
271        "Status":{
272          "shape":"String",
273          "documentation":"<p>The current status of the Key Value Store.</p>"
274        },
275        "FailureReason":{
276          "shape":"String",
277          "documentation":"<p>The reason for Key Value Store creation failure.</p>"
278        }
279      },
280      "documentation":"<p>Metadata information about a Key Value Store.</p>"
281    },
282    "Etag":{"type":"string"},
283    "GetKeyRequest":{
284      "type":"structure",
285      "required":[
286        "KvsARN",
287        "Key"
288      ],
289      "members":{
290        "KvsARN":{
291          "shape":"KvsARN",
292          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>",
293          "contextParam":{"name":"KvsARN"},
294          "location":"uri",
295          "locationName":"KvsARN"
296        },
297        "Key":{
298          "shape":"Key",
299          "documentation":"<p>The key to get.</p>",
300          "location":"uri",
301          "locationName":"Key"
302        }
303      }
304    },
305    "GetKeyResponse":{
306      "type":"structure",
307      "required":[
308        "Key",
309        "Value",
310        "ItemCount",
311        "TotalSizeInBytes"
312      ],
313      "members":{
314        "Key":{
315          "shape":"Key",
316          "documentation":"<p>The key of the key value pair.</p>"
317        },
318        "Value":{
319          "shape":"Value",
320          "documentation":"<p>The value of the key value pair.</p>"
321        },
322        "ItemCount":{
323          "shape":"Integer",
324          "documentation":"<p>Number of key value pairs in the Key Value Store.</p>"
325        },
326        "TotalSizeInBytes":{
327          "shape":"Long",
328          "documentation":"<p>Total size of the Key Value Store in bytes.</p>"
329        }
330      },
331      "documentation":"<p>A key value pair.</p>"
332    },
333    "Integer":{
334      "type":"integer",
335      "box":true
336    },
337    "InternalServerException":{
338      "type":"structure",
339      "members":{
340        "Message":{"shape":"String"}
341      },
342      "documentation":"<p>Internal server error.</p>",
343      "error":{"httpStatusCode":500},
344      "exception":true,
345      "fault":true
346    },
347    "Key":{
348      "type":"string",
349      "max":1024,
350      "min":1
351    },
352    "KvsARN":{
353      "type":"string",
354      "max":2048,
355      "min":1
356    },
357    "ListKeysRequest":{
358      "type":"structure",
359      "required":["KvsARN"],
360      "members":{
361        "KvsARN":{
362          "shape":"KvsARN",
363          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>",
364          "contextParam":{"name":"KvsARN"},
365          "location":"uri",
366          "locationName":"KvsARN"
367        },
368        "NextToken":{
369          "shape":"String",
370          "documentation":"<p>If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.</p>",
371          "location":"querystring",
372          "locationName":"NextToken"
373        },
374        "MaxResults":{
375          "shape":"ListKeysRequestMaxResultsInteger",
376          "documentation":"<p>Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.</p>",
377          "location":"querystring",
378          "locationName":"MaxResults"
379        }
380      }
381    },
382    "ListKeysRequestMaxResultsInteger":{
383      "type":"integer",
384      "box":true,
385      "max":50,
386      "min":1
387    },
388    "ListKeysResponse":{
389      "type":"structure",
390      "members":{
391        "NextToken":{
392          "shape":"String",
393          "documentation":"<p>If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.</p>"
394        },
395        "Items":{
396          "shape":"ListKeysResponseList",
397          "documentation":"<p>Key value pairs</p>"
398        }
399      }
400    },
401    "ListKeysResponseList":{
402      "type":"list",
403      "member":{"shape":"ListKeysResponseListItem"}
404    },
405    "ListKeysResponseListItem":{
406      "type":"structure",
407      "required":[
408        "Key",
409        "Value"
410      ],
411      "members":{
412        "Key":{
413          "shape":"Key",
414          "documentation":"<p>The key of the key value pair.</p>"
415        },
416        "Value":{
417          "shape":"Value",
418          "documentation":"<p>The value of the key value pair.</p>"
419        }
420      },
421      "documentation":"<p>A key value pair.</p>"
422    },
423    "Long":{
424      "type":"long",
425      "box":true
426    },
427    "PutKeyRequest":{
428      "type":"structure",
429      "required":[
430        "Key",
431        "Value",
432        "KvsARN",
433        "IfMatch"
434      ],
435      "members":{
436        "Key":{
437          "shape":"Key",
438          "documentation":"<p>The key to put.</p>",
439          "location":"uri",
440          "locationName":"Key"
441        },
442        "Value":{
443          "shape":"Value",
444          "documentation":"<p>The value to put.</p>"
445        },
446        "KvsARN":{
447          "shape":"KvsARN",
448          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>",
449          "contextParam":{"name":"KvsARN"},
450          "location":"uri",
451          "locationName":"KvsARN"
452        },
453        "IfMatch":{
454          "shape":"Etag",
455          "documentation":"<p>The current version (ETag) of the Key Value Store that you are putting keys into, which you can get using DescribeKeyValueStore.</p>",
456          "location":"header",
457          "locationName":"If-Match"
458        }
459      },
460      "documentation":"<p>A key value pair.</p>"
461    },
462    "PutKeyRequestListItem":{
463      "type":"structure",
464      "required":[
465        "Key",
466        "Value"
467      ],
468      "members":{
469        "Key":{
470          "shape":"Key",
471          "documentation":"<p>The key of the key value pair list item to put.</p>"
472        },
473        "Value":{
474          "shape":"Value",
475          "documentation":"<p>The value for the key value pair to put.</p>"
476        }
477      },
478      "documentation":"<p>List item for key value pair to put.</p>"
479    },
480    "PutKeyRequestsList":{
481      "type":"list",
482      "member":{"shape":"PutKeyRequestListItem"}
483    },
484    "PutKeyResponse":{
485      "type":"structure",
486      "required":[
487        "ItemCount",
488        "TotalSizeInBytes",
489        "ETag"
490      ],
491      "members":{
492        "ItemCount":{
493          "shape":"Integer",
494          "documentation":"<p>Number of key value pairs in the Key Value Store after the successful put.</p>"
495        },
496        "TotalSizeInBytes":{
497          "shape":"Long",
498          "documentation":"<p>Total size of the Key Value Store after the successful put, in bytes.</p>"
499        },
500        "ETag":{
501          "shape":"Etag",
502          "documentation":"<p>The current version identifier of the Key Value Store after the successful put.</p>",
503          "location":"header",
504          "locationName":"ETag"
505        }
506      },
507      "documentation":"<p>Metadata information about a Key Value Store.</p>"
508    },
509    "ResourceNotFoundException":{
510      "type":"structure",
511      "members":{
512        "Message":{"shape":"String"}
513      },
514      "documentation":"<p>Resource was not found.</p>",
515      "error":{
516        "httpStatusCode":404,
517        "senderFault":true
518      },
519      "exception":true
520    },
521    "ServiceQuotaExceededException":{
522      "type":"structure",
523      "members":{
524        "Message":{"shape":"String"}
525      },
526      "documentation":"<p>Limit exceeded.</p>",
527      "error":{
528        "httpStatusCode":402,
529        "senderFault":true
530      },
531      "exception":true
532    },
533    "String":{"type":"string"},
534    "Timestamp":{"type":"timestamp"},
535    "UpdateKeysRequest":{
536      "type":"structure",
537      "required":[
538        "KvsARN",
539        "IfMatch"
540      ],
541      "members":{
542        "KvsARN":{
543          "shape":"KvsARN",
544          "documentation":"<p>The Amazon Resource Name (ARN) of the Key Value Store.</p>",
545          "contextParam":{"name":"KvsARN"},
546          "location":"uri",
547          "locationName":"KvsARN"
548        },
549        "IfMatch":{
550          "shape":"Etag",
551          "documentation":"<p>The current version (ETag) of the Key Value Store that you are updating keys of, which you can get using DescribeKeyValueStore.</p>",
552          "location":"header",
553          "locationName":"If-Match"
554        },
555        "Puts":{
556          "shape":"PutKeyRequestsList",
557          "documentation":"<p>List of key value pairs to put.</p>"
558        },
559        "Deletes":{
560          "shape":"DeleteKeyRequestsList",
561          "documentation":"<p>List of keys to delete.</p>"
562        }
563      }
564    },
565    "UpdateKeysResponse":{
566      "type":"structure",
567      "required":[
568        "ItemCount",
569        "TotalSizeInBytes",
570        "ETag"
571      ],
572      "members":{
573        "ItemCount":{
574          "shape":"Integer",
575          "documentation":"<p>Number of key value pairs in the Key Value Store after the successful update.</p>"
576        },
577        "TotalSizeInBytes":{
578          "shape":"Long",
579          "documentation":"<p>Total size of the Key Value Store after the successful update, in bytes.</p>"
580        },
581        "ETag":{
582          "shape":"Etag",
583          "documentation":"<p>The current version identifier of the Key Value Store after the successful update.</p>",
584          "location":"header",
585          "locationName":"ETag"
586        }
587      },
588      "documentation":"<p>Metadata information about a Key Value Store.</p>"
589    },
590    "ValidationException":{
591      "type":"structure",
592      "members":{
593        "Message":{"shape":"String"}
594      },
595      "documentation":"<p>Validation failed.</p>",
596      "error":{
597        "httpStatusCode":400,
598        "senderFault":true
599      },
600      "exception":true
601    },
602    "Value":{
603      "type":"string",
604      "sensitive":true
605    }
606  },
607  "documentation":"<p>Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS Resource</p>"
608}
609