1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
{
"version": 1.0,
"merge": {
"operations":{
"DeleteBucketNotificationConfiguration":{
"name":"DeleteBucketNotificationConfiguration",
"http":{
"method":"DELETE",
"requestUri":"/{Bucket}?notification",
"responseCode":204
},
"input":{"shape":"DeleteBucketNotificationConfigurationRequest"},
"documentationUrl":"https://docs.ceph.com/docs/master/radosgw/s3/bucketops/#delete-notification",
"documentation":"<p>Deletes the notification configuration from the bucket.</p>"
},
"PostBucketLogging":{
"name":"PostBucketLogging",
"http":{
"method":"POST",
"requestUri":"/{Bucket}?logging",
"responseCode":201
},
"input":{"shape":"PostBucketLoggingRequest"},
"documentationUrl":"https://docs.ceph.com/docs/master/radosgw/s3/bucketops/#post-bucket-logging",
"documentation":"<p>Flushes the logging objects of the buckets.</p>"
},
"GetUsageStats":{
"name":"GetUsageStats",
"http":{
"method":"GET",
"requestUri":"/?usage",
"responseCode":200
},
"output": {"shape": "GetUsageStatsOutput"},
"documentationUrl":"https://docs.ceph.com/docs/master/radosgw/s3/serviceops#get-usage-stats",
"documentation":"<p>Get usage stats for the user</p>"
}
},
"shapes": {
"ListObjectsRequest": {
"members": {
"AllowUnordered": {
"shape":"AllowUnordered",
"documentation":"<p>Allow the listing results to be returned in unsorted order. This may be faster when listing very large buckets.</p>",
"location":"querystring",
"locationName":"allow-unordered"
}
}
},
"ListObjectsV2Request": {
"members": {
"AllowUnordered": {
"shape":"AllowUnordered",
"documentation":"<p>Allow the listing results to be returned in unsorted order. This may be faster when listing very large buckets.</p>",
"location":"querystring",
"locationName":"allow-unordered"
}
}
},
"ReplicationRule":{
"members":{
"Source": {
"shape":"S3RepSource",
"documentation":"<p>A container for information about the replication source.<p>",
"locationName":"Source"
}
}
},
"S3RepSource": {
"type": "structure",
"members": {
"Zones": {
"shape":"ZoneList",
"documentation":"<p>Array of replication source zone names.</p>",
"locationName":"Zone"
}
}
},
"Destination": {
"members": {
"Zones": {
"shape":"ZoneList",
"documentation":"<p>Array of replication destination zone names.</p>",
"locationName":"Zone"
}
}
},
"ZoneList": {
"type":"list",
"member":{"shape":"Zone"},
"flattened":true
},
"Zone":{"type":"string"},
"AllowUnordered":{"type":"boolean"},
"PutObjectRequest": {
"members": {
"AppendPosition": {
"shape":"AppendPosition",
"documentation": "<p>Position to allow appending</p>",
"location": "querystring",
"locationName": "position"
},
"Append": {
"shape":"Append",
"documentation":"<p>Append Object</p>",
"location": "querystring",
"locationName": "append"
}
}
},
"Append": {"type":"boolean"},
"AppendPosition":{"type":"integer"},
"PutObjectOutput": {
"members": {
"AppendPosition": {
"shape":"AppendPosition",
"documentation": "<p>Position to allow appending</p>",
"location": "header",
"locationName": "x-rgw-next-append-position",
"documentationUrl":"https://docs.ceph.com/docs/master/radosgw/s3/objectops/#append-object"
}
}
},
"GetBucketNotificationConfigurationRequest":{
"type":"structure",
"required":["Bucket"],
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"<p>Name of the bucket to get the notifications configuration for.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Notification":{
"shape":"NotificationId",
"documentation":"<p>Id of the specific notification on the bucket for which the configuration should be retrieved.</p>",
"location":"querystring",
"locationName":"notification-id"
}
}
},
"DeleteBucketNotificationConfigurationRequest":{
"type":"structure",
"required":["Bucket"],
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"<p>Name of the bucket to delete the notifications configuration from.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Notification":{
"shape":"NotificationId",
"documentation":"<p>Id of the specific notification on the bucket to be deleted.</p>",
"location":"querystring",
"locationName":"notification-id"
}
}
},
"PostBucketLoggingRequest":{
"type":"structure",
"required":["Bucket"],
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"<p>Name of the bucket to flush its logging objects.</p>",
"location":"uri",
"locationName":"Bucket"
}
}
},
"FilterRule":{
"type":"structure",
"members":{
"Name":{
"shape":"FilterRuleName",
"documentation":"<p>The object key name prefix, suffix or regex identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are supported.</p>"
},
"Value":{
"shape":"FilterRuleValue",
"documentation":"<p>The value that the filter searches for in object key names.</p>"
}
},
"documentation":"<p>Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix, prefix or regex of the key name.</p>"
},
"FilterRuleName":{
"type":"string",
"enum":[
"prefix",
"suffix",
"regex"
]
},
"NotificationConfigurationFilter":{
"type":"structure",
"members":{
"Key":{
"shape":"S3KeyFilter",
"documentation":"<p/>",
"locationName":"S3Key"
},
"Metadata":{
"shape":"S3MetadataFilter",
"documentation":"<p/>",
"locationName":"S3Metadata"
},
"Tags":{
"shape":"S3TagsFilter",
"documentation":"<p/>",
"locationName":"S3Tags"
}
},
"documentation":"<p>Specifies object key name filtering rules. For information about key name filtering, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"S3KeyFilter":{
"type":"structure",
"members":{
"FilterRules":{
"shape":"FilterRuleList",
"documentation":"<p/>",
"locationName":"FilterRule"
}
},
"documentation":"<p>A container for object key name prefix, suffix and regex filtering rules.</p>"
},
"S3MetadataFilter":{
"type":"structure",
"members":{
"FilterRules":{
"shape":"FilterRuleList",
"documentation":"<p/>",
"locationName":"FilterRule"
}
},
"documentation":"<p>A container for metadata filtering rules.</p>"
},
"S3TagsFilter":{
"type":"structure",
"members":{
"FilterRules":{
"shape":"FilterRuleList",
"documentation":"<p/>",
"locationName":"FilterRule"
}
},
"documentation":"<p>A container for object tags filtering rules.</p>"
},
"GetUsageStatsOutput": {
"type": "structure",
"members": {
"Summary": {
"shape":"UsageStatsSummary",
"documentation": "<p/>"
}
}
},
"UsageStatsSummary": {
"type": "structure",
"members": {
"QuotaMaxBytes":{"shape":"QuotaMaxBytes"},
"QuotaMaxBuckets":{"shape": "QuotaMaxBuckets"},
"QuotaMaxObjCount":{"shape":"QuotaMaxObjCount"},
"QuotaMaxBytesPerBucket":{"shape":"QuotaMaxBytesPerBucket"},
"QuotaMaxObjCountPerBucket":{"shape":"QuotaMaxObjCountPerBucket"},
"TotalBytes":{"shape":"TotalBytes"},
"TotalBytesRounded":{"shape":"TotalBytesRounded"},
"TotalEntries":{"shape":"TotalEntries"}
}
},
"QuotaMaxBytes":{"type":"integer"},
"QuotaMaxBuckets":{"type": "integer"},
"QuotaMaxObjCount":{"type":"integer"},
"QuotaMaxBytesPerBucket":{"type":"integer"},
"QuotaMaxObjCountPerBucket":{"type":"integer"},
"TotalBytesRounded":{"type":"integer"},
"TotalBytes":{"type":"integer"},
"TotalEntries":{"type":"integer"},
"LoggingEnabled":{
"type":"structure",
"required":[
"TargetBucket",
"TargetPrefix"
],
"members":{
"TargetBucket":{
"shape":"TargetBucket",
"documentation":"<p>Specifies the bucket where you want to store server access logs. You can have your logs delivered to any bucket that you own. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different <code>TargetPrefix</code> for each source bucket so that the delivered log files can be distinguished by key.</p>"
},
"TargetGrants":{
"shape":"TargetGrants",
"documentation":"<p>Container for granting information.</p> <p>Should be used when the write permissions to the tagert bucket should eb different than the permissions of the user performing the operation thta needs to be logged. This is usually used in cased of batched logging. see: <code>RecordBatchSize</code>.</p>"
},
"TargetPrefix":{
"shape":"TargetPrefix",
"documentation":"<p>A prefix for all log object keys. If you store log files from multiple buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.</p>"
},
"TargetObjectKeyFormat":{
"shape":"TargetObjectKeyFormat",
"documentation":"<p>key format for log objects.</p>"
},
"ObjectRollTime":{
"shape":"ObjectRollTime",
"documentation":"<p>time in seconds to move the log object to the target bucket and start another log object.</p>"
},
"LoggingType":{
"shape":"LoggingType",
"documentation":"<p>use Standard log type to log all bucket operations i nthe standard format. use Journal log type to log only creations and deletion of objects in more compact format.</p>"
},
"RecordsBatchSize":{
"shape":"RecordsBatchSize",
"documentation":"indicates how many records to batch in memory before writing to the object. if set to zero, records are written syncronously to the object. if <code>ObjectRollTime</code>e is reached, the batch of records will be written to the object regardless of the number of records. </p>"
},
"Filter":{
"shape":"LoggingConfigurationFilter",
"documentation":"<p>A filter for all log object. Filter for the object by its key (prefix, suffix and regex).</p>"
}
},
"documentation":"<p>Describes where logs are stored the prefix assigned to all log object keys for a bucket, and their format. also, the level the delivery guarantee of the records.</p>"
},
"TargetObjectKeyFormat":{
"type":"structure",
"members":{
"SimplePrefix":{
"shape":"SimplePrefix",
"documentation":"<p>To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.</p>",
"locationName":"SimplePrefix"
},
"PartitionedPrefix":{
"shape":"PartitionedPrefix",
"documentation":"<p>Partitioned S3 key for log objects.</p>",
"locationName":"PartitionedPrefix"
}
},
"documentation":"<p>Key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.</p>"
},
"SimplePrefix":{
"type":"structure",
"members":{
},
"documentation":"<p>To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.</p> <p> <code>[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]</code> </p>",
"locationName":"SimplePrefix"
},
"PartitionDateSource":{
"type":"string",
"enum":[
"EventTime",
"DeliveryTime"
]
},
"PartitionedPrefix":{
"type":"structure",
"members":{
"PartitionDateSource":{
"shape":"PartitionDateSource",
"documentation":"<p>Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.</p>"
}
},
"documentation":"<p>Amazon S3 keys for log objects are partitioned in the following format:</p> <p> <code>[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]</code> </p> <p>PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.</p>",
"locationName":"PartitionedPrefix"
},
"ObjectRollTime":{"type":"integer"},
"RecordsBatchSize":{"type":"integer"},
"LoggingType":{
"type":"string",
"enum": [
"Standard",
"Journal"
]
},
"LoggingConfigurationFilter":{
"type":"structure",
"members":{
"Key":{
"shape":"S3KeyFilter",
"documentation":"<p/>",
"locationName":"S3Key"
}
},
"documentation":"<p>A filter for all log object. Filter for the object by its key (prefix, suffix and regex).</p>",
"locationName":"Filter"
},
"HeadBucketRequest": {
"members": {
"ReadStats":{
"shape":"ReadStats",
"documentation":"<p>Read additional usage statistics for <code>ObjectCount</code> and <code>BytesUsed</code> in the response.</p> <note> <p>This request parameter is a Ceph RGW extension.</p> </note>",
"location":"querystring",
"locationName":"read-stats"
}
}
},
"HeadBucketOutput":{
"members":{
"ObjectCount":{
"shape":"ObjectCount",
"documentation": "<p>Total number of objects/versions in the bucket.</p>",
"location": "header",
"locationName": "x-rgw-object-count"
},
"BytesUsed":{
"shape":"BytesUsed",
"documentation": "<p>Total size in bytes of all objects/versions in the bucket.</p>",
"location": "header",
"locationName": "x-rgw-bytes-used"
}
}
},
"ReadStats":{"type":"boolean"},
"ObjectCount":{"type":"integer"},
"BytesUsed":{"type":"integer"}
},
"documentation":"<p/>"
}
}
|
