|
| 1 | +{ |
| 2 | + "version":"2.0", |
| 3 | + "metadata":{ |
| 4 | + "apiVersion":"2021-11-11", |
| 5 | + "endpointPrefix":"appconfigdata", |
| 6 | + "jsonVersion":"1.0", |
| 7 | + "protocol":"rest-json", |
| 8 | + "serviceFullName":"AWS AppConfig Data", |
| 9 | + "serviceId":"AppConfigData", |
| 10 | + "signatureVersion":"v4", |
| 11 | + "signingName":"appconfig", |
| 12 | + "uid":"appconfigdata-2021-11-11" |
| 13 | + }, |
| 14 | + "operations":{ |
| 15 | + "GetLatestConfiguration":{ |
| 16 | + "name":"GetLatestConfiguration", |
| 17 | + "http":{ |
| 18 | + "method":"GET", |
| 19 | + "requestUri":"/configuration", |
| 20 | + "responseCode":200 |
| 21 | + }, |
| 22 | + "input":{"shape":"GetLatestConfigurationRequest"}, |
| 23 | + "output":{"shape":"GetLatestConfigurationResponse"}, |
| 24 | + "errors":[ |
| 25 | + {"shape":"ThrottlingException"}, |
| 26 | + {"shape":"ResourceNotFoundException"}, |
| 27 | + {"shape":"BadRequestException"}, |
| 28 | + {"shape":"InternalServerException"} |
| 29 | + ], |
| 30 | + "documentation":"<p>Retrieves the latest deployed configuration. This API may return empty Configuration data if the client already has the latest version. See StartConfigurationSession to obtain an InitialConfigurationToken to call this API.</p> <important> <p>Each call to GetLatestConfiguration returns a new ConfigurationToken (NextPollConfigurationToken in the response). This new token MUST be provided to the next call to GetLatestConfiguration when polling for configuration updates.</p> <p>To avoid excess charges, we recommend that you include the <code>ClientConfigurationVersion</code> value with every call to <code>GetConfiguration</code>. This value must be saved on your client. Subsequent calls to <code>GetConfiguration</code> must pass this value by using the <code>ClientConfigurationVersion</code> parameter. </p> </important>" |
| 31 | + }, |
| 32 | + "StartConfigurationSession":{ |
| 33 | + "name":"StartConfigurationSession", |
| 34 | + "http":{ |
| 35 | + "method":"POST", |
| 36 | + "requestUri":"/configurationsessions", |
| 37 | + "responseCode":201 |
| 38 | + }, |
| 39 | + "input":{"shape":"StartConfigurationSessionRequest"}, |
| 40 | + "output":{"shape":"StartConfigurationSessionResponse"}, |
| 41 | + "errors":[ |
| 42 | + {"shape":"ThrottlingException"}, |
| 43 | + {"shape":"ResourceNotFoundException"}, |
| 44 | + {"shape":"BadRequestException"}, |
| 45 | + {"shape":"InternalServerException"} |
| 46 | + ], |
| 47 | + "documentation":"<p>Starts a configuration session used to retrieve a deployed configuration. See the GetLatestConfiguration API for more details.</p>" |
| 48 | + } |
| 49 | + }, |
| 50 | + "shapes":{ |
| 51 | + "BadRequestDetails":{ |
| 52 | + "type":"structure", |
| 53 | + "members":{ |
| 54 | + "InvalidParameters":{ |
| 55 | + "shape":"InvalidParameterMap", |
| 56 | + "documentation":"<p>Present if the Reason for the bad request was 'InvalidParameters'</p>" |
| 57 | + } |
| 58 | + }, |
| 59 | + "documentation":"<p>Details describing why the request was invalid</p>", |
| 60 | + "union":true |
| 61 | + }, |
| 62 | + "BadRequestException":{ |
| 63 | + "type":"structure", |
| 64 | + "members":{ |
| 65 | + "Details":{ |
| 66 | + "shape":"BadRequestDetails", |
| 67 | + "documentation":"<p>Details describing why the request was invalid</p>" |
| 68 | + }, |
| 69 | + "Message":{"shape":"String"}, |
| 70 | + "Reason":{ |
| 71 | + "shape":"BadRequestReason", |
| 72 | + "documentation":"<p>Code indicating the reason the request was invalid.</p>" |
| 73 | + } |
| 74 | + }, |
| 75 | + "documentation":"<p>The input fails to satisfy the constraints specified by the service.</p>", |
| 76 | + "error":{ |
| 77 | + "httpStatusCode":400, |
| 78 | + "senderFault":true |
| 79 | + }, |
| 80 | + "exception":true |
| 81 | + }, |
| 82 | + "BadRequestReason":{ |
| 83 | + "type":"string", |
| 84 | + "enum":["InvalidParameters"] |
| 85 | + }, |
| 86 | + "GetLatestConfigurationRequest":{ |
| 87 | + "type":"structure", |
| 88 | + "required":["ConfigurationToken"], |
| 89 | + "members":{ |
| 90 | + "ConfigurationToken":{ |
| 91 | + "shape":"Token", |
| 92 | + "documentation":"<p>Token describing the current state of the configuration session. To obtain a token, first call the StartConfigurationSession API. Note that every call to GetLatestConfiguration will return a new ConfigurationToken (NextPollConfigurationToken in the response) and MUST be provided to subsequent GetLatestConfiguration API calls.</p>", |
| 93 | + "location":"querystring", |
| 94 | + "locationName":"configuration_token" |
| 95 | + } |
| 96 | + }, |
| 97 | + "documentation":"<p>Request parameters for the GetLatestConfiguration API</p>" |
| 98 | + }, |
| 99 | + "GetLatestConfigurationResponse":{ |
| 100 | + "type":"structure", |
| 101 | + "members":{ |
| 102 | + "Configuration":{ |
| 103 | + "shape":"SyntheticGetLatestConfigurationResponseBlob", |
| 104 | + "documentation":"<p>The data of the configuration. Note that this may be empty if the client already has the latest version of configuration.</p>" |
| 105 | + }, |
| 106 | + "ContentType":{ |
| 107 | + "shape":"String", |
| 108 | + "documentation":"<p>A standard MIME type describing the format of the configuration content.</p>", |
| 109 | + "location":"header", |
| 110 | + "locationName":"Content-Type" |
| 111 | + }, |
| 112 | + "NextPollConfigurationToken":{ |
| 113 | + "shape":"Token", |
| 114 | + "documentation":"<p>The latest token describing the current state of the configuration session. This MUST be provided to the next call to GetLatestConfiguration.</p>", |
| 115 | + "location":"header", |
| 116 | + "locationName":"Next-Poll-Configuration-Token" |
| 117 | + }, |
| 118 | + "NextPollIntervalInSeconds":{ |
| 119 | + "shape":"Integer", |
| 120 | + "documentation":"<p>The amount of time the client should wait before polling for configuration updates again. See RequiredMinimumPollIntervalInSeconds to set the desired poll interval.</p>", |
| 121 | + "location":"header", |
| 122 | + "locationName":"Next-Poll-Interval-In-Seconds" |
| 123 | + } |
| 124 | + }, |
| 125 | + "documentation":"<p>Response parameters for the GetLatestConfiguration API</p>", |
| 126 | + "payload":"Configuration" |
| 127 | + }, |
| 128 | + "Identifier":{ |
| 129 | + "type":"string", |
| 130 | + "max":64, |
| 131 | + "min":1 |
| 132 | + }, |
| 133 | + "Integer":{"type":"integer"}, |
| 134 | + "InternalServerException":{ |
| 135 | + "type":"structure", |
| 136 | + "members":{ |
| 137 | + "Message":{"shape":"String"} |
| 138 | + }, |
| 139 | + "documentation":"<p>There was an internal failure in the service.</p>", |
| 140 | + "error":{"httpStatusCode":500}, |
| 141 | + "exception":true, |
| 142 | + "fault":true |
| 143 | + }, |
| 144 | + "InvalidParameterDetail":{ |
| 145 | + "type":"structure", |
| 146 | + "members":{ |
| 147 | + "Problem":{ |
| 148 | + "shape":"InvalidParameterProblem", |
| 149 | + "documentation":"<p>Detail describing why an individual parameter did not satisfy the constraints specified by the service</p>" |
| 150 | + } |
| 151 | + }, |
| 152 | + "documentation":"<p>Contains details about an invalid parameter.</p>" |
| 153 | + }, |
| 154 | + "InvalidParameterMap":{ |
| 155 | + "type":"map", |
| 156 | + "key":{"shape":"String"}, |
| 157 | + "value":{"shape":"InvalidParameterDetail"} |
| 158 | + }, |
| 159 | + "InvalidParameterProblem":{ |
| 160 | + "type":"string", |
| 161 | + "enum":[ |
| 162 | + "Corrupted", |
| 163 | + "Expired", |
| 164 | + "PollIntervalNotSatisfied" |
| 165 | + ] |
| 166 | + }, |
| 167 | + "OptionalPollSeconds":{ |
| 168 | + "type":"integer", |
| 169 | + "box":true, |
| 170 | + "max":86400, |
| 171 | + "min":15 |
| 172 | + }, |
| 173 | + "ResourceNotFoundException":{ |
| 174 | + "type":"structure", |
| 175 | + "members":{ |
| 176 | + "Message":{"shape":"String"}, |
| 177 | + "ReferencedBy":{ |
| 178 | + "shape":"StringMap", |
| 179 | + "documentation":"<p>A map indicating which parameters in the request reference the resource that was not found.</p>" |
| 180 | + }, |
| 181 | + "ResourceType":{ |
| 182 | + "shape":"ResourceType", |
| 183 | + "documentation":"<p>The type of resource that was not found.</p>" |
| 184 | + } |
| 185 | + }, |
| 186 | + "documentation":"<p>The requested resource could not be found.</p>", |
| 187 | + "error":{ |
| 188 | + "httpStatusCode":404, |
| 189 | + "senderFault":true |
| 190 | + }, |
| 191 | + "exception":true |
| 192 | + }, |
| 193 | + "ResourceType":{ |
| 194 | + "type":"string", |
| 195 | + "enum":[ |
| 196 | + "Application", |
| 197 | + "ConfigurationProfile", |
| 198 | + "Deployment", |
| 199 | + "Environment", |
| 200 | + "Configuration" |
| 201 | + ] |
| 202 | + }, |
| 203 | + "StartConfigurationSessionRequest":{ |
| 204 | + "type":"structure", |
| 205 | + "required":[ |
| 206 | + "ApplicationIdentifier", |
| 207 | + "ConfigurationProfileIdentifier", |
| 208 | + "EnvironmentIdentifier" |
| 209 | + ], |
| 210 | + "members":{ |
| 211 | + "ApplicationIdentifier":{ |
| 212 | + "shape":"Identifier", |
| 213 | + "documentation":"<p>The application ID or the application name.</p>" |
| 214 | + }, |
| 215 | + "ConfigurationProfileIdentifier":{ |
| 216 | + "shape":"Identifier", |
| 217 | + "documentation":"<p>The configuration profile ID or the configuration profile name.</p>" |
| 218 | + }, |
| 219 | + "EnvironmentIdentifier":{ |
| 220 | + "shape":"Identifier", |
| 221 | + "documentation":"<p>The environment ID or the environment name.</p>" |
| 222 | + }, |
| 223 | + "RequiredMinimumPollIntervalInSeconds":{ |
| 224 | + "shape":"OptionalPollSeconds", |
| 225 | + "documentation":"<p>The interval at which your client will poll for configuration. If provided, the service will throw a BadRequestException if the client polls before the specified poll interval. By default, client poll intervals are not enforced.</p>" |
| 226 | + } |
| 227 | + }, |
| 228 | + "documentation":"<p>Request parameters for the StartConfigurationSession API.</p>" |
| 229 | + }, |
| 230 | + "StartConfigurationSessionResponse":{ |
| 231 | + "type":"structure", |
| 232 | + "members":{ |
| 233 | + "InitialConfigurationToken":{ |
| 234 | + "shape":"Token", |
| 235 | + "documentation":"<p>Token encapsulating state about the configuration session. Provide this token to the GetLatestConfiguration API to retrieve configuration data.</p> <important> <p>This token should only be used once in your first call to GetLatestConfiguration. You MUST use the new token in the GetConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.</p> </important>" |
| 236 | + } |
| 237 | + }, |
| 238 | + "documentation":"<p>Response parameters for the StartConfigurationSession API.</p>" |
| 239 | + }, |
| 240 | + "String":{"type":"string"}, |
| 241 | + "StringMap":{ |
| 242 | + "type":"map", |
| 243 | + "key":{"shape":"String"}, |
| 244 | + "value":{"shape":"String"} |
| 245 | + }, |
| 246 | + "SyntheticGetLatestConfigurationResponseBlob":{ |
| 247 | + "type":"blob", |
| 248 | + "sensitive":true |
| 249 | + }, |
| 250 | + "ThrottlingException":{ |
| 251 | + "type":"structure", |
| 252 | + "members":{ |
| 253 | + "Message":{"shape":"String"} |
| 254 | + }, |
| 255 | + "documentation":"<p>The request was denied due to request throttling.</p>", |
| 256 | + "error":{ |
| 257 | + "httpStatusCode":429, |
| 258 | + "senderFault":true |
| 259 | + }, |
| 260 | + "exception":true |
| 261 | + }, |
| 262 | + "Token":{ |
| 263 | + "type":"string", |
| 264 | + "pattern":"\\S{1,8192}" |
| 265 | + } |
| 266 | + }, |
| 267 | + "documentation":"<p>Use the AppConfigData API, a capability of AWS AppConfig, to retrieve deployed configuration.</p>" |
| 268 | +} |
0 commit comments