summaryrefslogtreecommitdiffstats
path: root/examples/boto3/service-2.sdk-extras.json
blob: 9ee66730e8522ec07a7337fa4e2a5309b2716469 (plain)
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
{
"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>"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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"}
    },
    "documentation":"<p/>"
}
}