{ "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":"
Deletes the notification configuration from the bucket.
" }, "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":"Flushes the logging objects of the buckets.
" }, "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":"Get usage stats for the user
" } }, "shapes": { "ListObjectsRequest": { "members": { "AllowUnordered": { "shape":"AllowUnordered", "documentation":"Allow the listing results to be returned in unsorted order. This may be faster when listing very large buckets.
", "location":"querystring", "locationName":"allow-unordered" } } }, "ListObjectsV2Request": { "members": { "AllowUnordered": { "shape":"AllowUnordered", "documentation":"Allow the listing results to be returned in unsorted order. This may be faster when listing very large buckets.
", "location":"querystring", "locationName":"allow-unordered" } } }, "ReplicationRule":{ "members":{ "Source": { "shape":"S3RepSource", "documentation":"A container for information about the replication source.
", "locationName":"Source" } } }, "S3RepSource": { "type": "structure", "members": { "Zones": { "shape":"ZoneList", "documentation":"
Array of replication source zone names.
", "locationName":"Zone" } } }, "Destination": { "members": { "Zones": { "shape":"ZoneList", "documentation":"Array of replication destination zone names.
", "locationName":"Zone" } } }, "ZoneList": { "type":"list", "member":{"shape":"Zone"}, "flattened":true }, "Zone":{"type":"string"}, "AllowUnordered":{"type":"boolean"}, "PutObjectRequest": { "members": { "AppendPosition": { "shape":"AppendPosition", "documentation": "Position to allow appending
", "location": "querystring", "locationName": "position" }, "Append": { "shape":"Append", "documentation":"Append Object
", "location": "querystring", "locationName": "append" } } }, "Append": {"type":"boolean"}, "AppendPosition":{"type":"integer"}, "PutObjectOutput": { "members": { "AppendPosition": { "shape":"AppendPosition", "documentation": "Position to allow appending
", "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":"Name of the bucket to get the notifications configuration for.
", "location":"uri", "locationName":"Bucket" }, "Notification":{ "shape":"NotificationId", "documentation":"Id of the specific notification on the bucket for which the configuration should be retrieved.
", "location":"querystring", "locationName":"notification-id" } } }, "DeleteBucketNotificationConfigurationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to delete the notifications configuration from.
", "location":"uri", "locationName":"Bucket" }, "Notification":{ "shape":"NotificationId", "documentation":"Id of the specific notification on the bucket to be deleted.
", "location":"querystring", "locationName":"notification-id" } } }, "PostBucketLoggingRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to flush its logging objects.
", "location":"uri", "locationName":"Bucket" } } }, "FilterRule":{ "type":"structure", "members":{ "Name":{ "shape":"FilterRuleName", "documentation":"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.
" }, "Value":{ "shape":"FilterRuleValue", "documentation":"The value that the filter searches for in object key names.
" } }, "documentation":"Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix, prefix or regex of the key name.
" }, "FilterRuleName":{ "type":"string", "enum":[ "prefix", "suffix", "regex" ] }, "NotificationConfigurationFilter":{ "type":"structure", "members":{ "Key":{ "shape":"S3KeyFilter", "documentation":"", "locationName":"S3Key" }, "Metadata":{ "shape":"S3MetadataFilter", "documentation":"", "locationName":"S3Metadata" }, "Tags":{ "shape":"S3TagsFilter", "documentation":"", "locationName":"S3Tags" } }, "documentation":"Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
" }, "S3KeyFilter":{ "type":"structure", "members":{ "FilterRules":{ "shape":"FilterRuleList", "documentation":"", "locationName":"FilterRule" } }, "documentation":"A container for object key name prefix, suffix and regex filtering rules.
" }, "S3MetadataFilter":{ "type":"structure", "members":{ "FilterRules":{ "shape":"FilterRuleList", "documentation":"", "locationName":"FilterRule" } }, "documentation":"A container for metadata filtering rules.
" }, "S3TagsFilter":{ "type":"structure", "members":{ "FilterRules":{ "shape":"FilterRuleList", "documentation":"", "locationName":"FilterRule" } }, "documentation":"A container for object tags filtering rules.
" }, "GetUsageStatsOutput": { "type": "structure", "members": { "Summary": { "shape":"UsageStatsSummary", "documentation": "" } } }, "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":"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 TargetPrefix
for each source bucket so that the delivered log files can be distinguished by key.
Container for granting information.
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: RecordBatchSize
.
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.
" }, "TargetObjectKeyFormat":{ "shape":"TargetObjectKeyFormat", "documentation":"key format for log objects.
" }, "ObjectRollTime":{ "shape":"ObjectRollTime", "documentation":"time in seconds to move the log object to the target bucket and start another log object.
" }, "LoggingType":{ "shape":"LoggingType", "documentation":"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.
" }, "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. ifObjectRollTime
e is reached, the batch of records will be written to the object regardless of the number of records. "
},
"Filter":{
"shape":"LoggingConfigurationFilter",
"documentation":"A filter for all log object. Filter for the object by its key (prefix, suffix and regex).
" } }, "documentation":"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.
" }, "TargetObjectKeyFormat":{ "type":"structure", "members":{ "SimplePrefix":{ "shape":"SimplePrefix", "documentation":"To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.
", "locationName":"SimplePrefix" }, "PartitionedPrefix":{ "shape":"PartitionedPrefix", "documentation":"Partitioned S3 key for log objects.
", "locationName":"PartitionedPrefix" } }, "documentation":"Key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.
" }, "SimplePrefix":{ "type":"structure", "members":{ }, "documentation":"To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.
" } }, "documentation":"Amazon S3 keys for log objects are partitioned in the following format:
[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.
", "locationName":"PartitionedPrefix" }, "ObjectRollTime":{"type":"integer"}, "RecordsBatchSize":{"type":"integer"}, "LoggingType":{ "type":"string", "enum": [ "Standard", "Journal" ] }, "LoggingConfigurationFilter":{ "type":"structure", "members":{ "Key":{ "shape":"S3KeyFilter", "documentation":"", "locationName":"S3Key" } }, "documentation":"A filter for all log object. Filter for the object by its key (prefix, suffix and regex).
", "locationName":"Filter" } }, "documentation":"" } }