|
| 1 | +{ |
| 2 | + "version":"2.0", |
| 3 | + "metadata":{ |
| 4 | + "apiVersion":"2021-02-01", |
| 5 | + "endpointPrefix":"account", |
| 6 | + "jsonVersion":"1.1", |
| 7 | + "protocol":"rest-json", |
| 8 | + "serviceFullName":"AWS Account", |
| 9 | + "serviceId":"Account", |
| 10 | + "signatureVersion":"v4", |
| 11 | + "signingName":"account", |
| 12 | + "uid":"account-2021-02-01" |
| 13 | + }, |
| 14 | + "operations":{ |
| 15 | + "DeleteAlternateContact":{ |
| 16 | + "name":"DeleteAlternateContact", |
| 17 | + "http":{ |
| 18 | + "method":"POST", |
| 19 | + "requestUri":"/deleteAlternateContact", |
| 20 | + "responseCode":200 |
| 21 | + }, |
| 22 | + "input":{"shape":"DeleteAlternateContactRequest"}, |
| 23 | + "errors":[ |
| 24 | + {"shape":"ResourceNotFoundException"}, |
| 25 | + {"shape":"ValidationException"}, |
| 26 | + {"shape":"AccessDeniedException"}, |
| 27 | + {"shape":"TooManyRequestsException"}, |
| 28 | + {"shape":"InternalServerException"} |
| 29 | + ], |
| 30 | + "documentation":"<p>Deletes the specified alternate contact from an Amazon Web Services account.</p> <p>For complete details about how to use the alternate contact operations, see <a href=\"https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html\">Access or updating the alternate contacts</a>.</p>", |
| 31 | + "idempotent":true |
| 32 | + }, |
| 33 | + "GetAlternateContact":{ |
| 34 | + "name":"GetAlternateContact", |
| 35 | + "http":{ |
| 36 | + "method":"POST", |
| 37 | + "requestUri":"/getAlternateContact", |
| 38 | + "responseCode":200 |
| 39 | + }, |
| 40 | + "input":{"shape":"GetAlternateContactRequest"}, |
| 41 | + "output":{"shape":"GetAlternateContactResponse"}, |
| 42 | + "errors":[ |
| 43 | + {"shape":"ResourceNotFoundException"}, |
| 44 | + {"shape":"ValidationException"}, |
| 45 | + {"shape":"AccessDeniedException"}, |
| 46 | + {"shape":"TooManyRequestsException"}, |
| 47 | + {"shape":"InternalServerException"} |
| 48 | + ], |
| 49 | + "documentation":"<p>Retrieves the specified alternate contact attached to an Amazon Web Services account.</p> <p>For complete details about how to use the alternate contact operations, see <a href=\"https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html\">Access or updating the alternate contacts</a>.</p>" |
| 50 | + }, |
| 51 | + "PutAlternateContact":{ |
| 52 | + "name":"PutAlternateContact", |
| 53 | + "http":{ |
| 54 | + "method":"POST", |
| 55 | + "requestUri":"/putAlternateContact", |
| 56 | + "responseCode":200 |
| 57 | + }, |
| 58 | + "input":{"shape":"PutAlternateContactRequest"}, |
| 59 | + "errors":[ |
| 60 | + {"shape":"ValidationException"}, |
| 61 | + {"shape":"AccessDeniedException"}, |
| 62 | + {"shape":"TooManyRequestsException"}, |
| 63 | + {"shape":"InternalServerException"} |
| 64 | + ], |
| 65 | + "documentation":"<p>Modifies the specified alternate contact attached to an Amazon Web Services account.</p> <p>For complete details about how to use the alternate contact operations, see <a href=\"https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html\">Access or updating the alternate contacts</a>.</p>", |
| 66 | + "idempotent":true |
| 67 | + } |
| 68 | + }, |
| 69 | + "shapes":{ |
| 70 | + "AccessDeniedException":{ |
| 71 | + "type":"structure", |
| 72 | + "required":["message"], |
| 73 | + "members":{ |
| 74 | + "message":{"shape":"String"} |
| 75 | + }, |
| 76 | + "documentation":"<p>The operation failed because the calling identity doesn't have the minimum required permissions.</p>", |
| 77 | + "error":{ |
| 78 | + "httpStatusCode":403, |
| 79 | + "senderFault":true |
| 80 | + }, |
| 81 | + "exception":true |
| 82 | + }, |
| 83 | + "AccountId":{ |
| 84 | + "type":"string", |
| 85 | + "pattern":"^\\d{12}$" |
| 86 | + }, |
| 87 | + "AlternateContact":{ |
| 88 | + "type":"structure", |
| 89 | + "members":{ |
| 90 | + "AlternateContactType":{ |
| 91 | + "shape":"AlternateContactType", |
| 92 | + "documentation":"<p>The type of alternate contact.</p>" |
| 93 | + }, |
| 94 | + "EmailAddress":{ |
| 95 | + "shape":"EmailAddress", |
| 96 | + "documentation":"<p>The email address associated with this alternate contact.</p>" |
| 97 | + }, |
| 98 | + "Name":{ |
| 99 | + "shape":"Name", |
| 100 | + "documentation":"<p>The name associated with this alternate contact.</p>" |
| 101 | + }, |
| 102 | + "PhoneNumber":{ |
| 103 | + "shape":"PhoneNumber", |
| 104 | + "documentation":"<p>The phone number associated with this alternate contact.</p>" |
| 105 | + }, |
| 106 | + "Title":{ |
| 107 | + "shape":"Title", |
| 108 | + "documentation":"<p>The title associated with this alternate contact.</p>" |
| 109 | + } |
| 110 | + }, |
| 111 | + "documentation":"<p>A structure that contains the details of an alternate contact associated with an Amazon Web Services account</p>" |
| 112 | + }, |
| 113 | + "AlternateContactType":{ |
| 114 | + "type":"string", |
| 115 | + "enum":[ |
| 116 | + "BILLING", |
| 117 | + "OPERATIONS", |
| 118 | + "SECURITY" |
| 119 | + ] |
| 120 | + }, |
| 121 | + "DeleteAlternateContactRequest":{ |
| 122 | + "type":"structure", |
| 123 | + "required":["AlternateContactType"], |
| 124 | + "members":{ |
| 125 | + "AccountId":{ |
| 126 | + "shape":"AccountId", |
| 127 | + "documentation":"<p>Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.</p> <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.</p> <p>To use this parameter, the caller must be an identity in the <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account\">organization's management account</a> or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features enabled</a>, and the organization must have <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html\">trusted access</a> enabled for the Account Management service, and optionally a <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html\">delegated admin</a> account assigned.</p> <note> <p>The management account can't specify its own <code>AccountId</code>; it must call the operation in standalone context by not including the <code>AccountId</code> parameter.</p> </note> <p>To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.</p>" |
| 128 | + }, |
| 129 | + "AlternateContactType":{ |
| 130 | + "shape":"AlternateContactType", |
| 131 | + "documentation":"<p>Specifies which of the alternate contacts to delete. </p>" |
| 132 | + } |
| 133 | + } |
| 134 | + }, |
| 135 | + "EmailAddress":{ |
| 136 | + "type":"string", |
| 137 | + "max":64, |
| 138 | + "min":1, |
| 139 | + "pattern":"[\\w+=,.-]+@[\\w.-]+\\.[\\w]+", |
| 140 | + "sensitive":true |
| 141 | + }, |
| 142 | + "GetAlternateContactRequest":{ |
| 143 | + "type":"structure", |
| 144 | + "required":["AlternateContactType"], |
| 145 | + "members":{ |
| 146 | + "AccountId":{ |
| 147 | + "shape":"AccountId", |
| 148 | + "documentation":"<p>Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.</p> <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.</p> <p>To use this parameter, the caller must be an identity in the <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account\">organization's management account</a> or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features enabled</a>, and the organization must have <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html\">trusted access</a> enabled for the Account Management service, and optionally a <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html\">delegated admin</a> account assigned.</p> <note> <p>The management account can't specify its own <code>AccountId</code>; it must call the operation in standalone context by not including the <code>AccountId</code> parameter.</p> </note> <p>To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.</p>" |
| 149 | + }, |
| 150 | + "AlternateContactType":{ |
| 151 | + "shape":"AlternateContactType", |
| 152 | + "documentation":"<p>Specifies which alternate contact you want to retrieve.</p>" |
| 153 | + } |
| 154 | + } |
| 155 | + }, |
| 156 | + "GetAlternateContactResponse":{ |
| 157 | + "type":"structure", |
| 158 | + "members":{ |
| 159 | + "AlternateContact":{ |
| 160 | + "shape":"AlternateContact", |
| 161 | + "documentation":"<p>A structure that contains the details for the specified alternate contact.</p>" |
| 162 | + } |
| 163 | + } |
| 164 | + }, |
| 165 | + "InternalServerException":{ |
| 166 | + "type":"structure", |
| 167 | + "required":["message"], |
| 168 | + "members":{ |
| 169 | + "message":{"shape":"String"} |
| 170 | + }, |
| 171 | + "documentation":"<p>The operation failed because of an error internal to Amazon Web Services. Try your operation again later.</p>", |
| 172 | + "error":{"httpStatusCode":500}, |
| 173 | + "exception":true, |
| 174 | + "fault":true, |
| 175 | + "retryable":{"throttling":false} |
| 176 | + }, |
| 177 | + "Name":{ |
| 178 | + "type":"string", |
| 179 | + "max":64, |
| 180 | + "min":1, |
| 181 | + "sensitive":true |
| 182 | + }, |
| 183 | + "PhoneNumber":{ |
| 184 | + "type":"string", |
| 185 | + "max":25, |
| 186 | + "min":1, |
| 187 | + "pattern":"^[\\s0-9()+-]+$", |
| 188 | + "sensitive":true |
| 189 | + }, |
| 190 | + "PutAlternateContactRequest":{ |
| 191 | + "type":"structure", |
| 192 | + "required":[ |
| 193 | + "AlternateContactType", |
| 194 | + "EmailAddress", |
| 195 | + "Name", |
| 196 | + "PhoneNumber", |
| 197 | + "Title" |
| 198 | + ], |
| 199 | + "members":{ |
| 200 | + "AccountId":{ |
| 201 | + "shape":"AccountId", |
| 202 | + "documentation":"<p>Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.</p> <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.</p> <p>To use this parameter, the caller must be an identity in the <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account\">organization's management account</a> or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features enabled</a>, and the organization must have <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html\">trusted access</a> enabled for the Account Management service, and optionally a <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html\">delegated admin</a> account assigned.</p> <note> <p>The management account can't specify its own <code>AccountId</code>; it must call the operation in standalone context by not including the <code>AccountId</code> parameter.</p> </note> <p>To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.</p>" |
| 203 | + }, |
| 204 | + "AlternateContactType":{ |
| 205 | + "shape":"AlternateContactType", |
| 206 | + "documentation":"<p>Specifies which alternate contact you want to create or update.</p>" |
| 207 | + }, |
| 208 | + "EmailAddress":{ |
| 209 | + "shape":"EmailAddress", |
| 210 | + "documentation":"<p>Specifies an email address for the alternate contact. </p>" |
| 211 | + }, |
| 212 | + "Name":{ |
| 213 | + "shape":"Name", |
| 214 | + "documentation":"<p>Specifies a name for the alternate contact.</p>" |
| 215 | + }, |
| 216 | + "PhoneNumber":{ |
| 217 | + "shape":"PhoneNumber", |
| 218 | + "documentation":"<p>Specifies a phone number for the alternate contact.</p>" |
| 219 | + }, |
| 220 | + "Title":{ |
| 221 | + "shape":"Title", |
| 222 | + "documentation":"<p>Specifies a title for the alternate contact.</p>" |
| 223 | + } |
| 224 | + } |
| 225 | + }, |
| 226 | + "ResourceNotFoundException":{ |
| 227 | + "type":"structure", |
| 228 | + "required":["message"], |
| 229 | + "members":{ |
| 230 | + "message":{"shape":"String"} |
| 231 | + }, |
| 232 | + "documentation":"<p>The operation failed because it specified a resource that can't be found.</p>", |
| 233 | + "error":{ |
| 234 | + "httpStatusCode":404, |
| 235 | + "senderFault":true |
| 236 | + }, |
| 237 | + "exception":true |
| 238 | + }, |
| 239 | + "String":{"type":"string"}, |
| 240 | + "Title":{ |
| 241 | + "type":"string", |
| 242 | + "max":50, |
| 243 | + "min":1, |
| 244 | + "sensitive":true |
| 245 | + }, |
| 246 | + "TooManyRequestsException":{ |
| 247 | + "type":"structure", |
| 248 | + "required":["message"], |
| 249 | + "members":{ |
| 250 | + "message":{"shape":"String"} |
| 251 | + }, |
| 252 | + "documentation":"<p>The operation failed because it was called too frequently and exceeded a throttle limit.</p>", |
| 253 | + "error":{ |
| 254 | + "httpStatusCode":429, |
| 255 | + "senderFault":true |
| 256 | + }, |
| 257 | + "exception":true, |
| 258 | + "retryable":{"throttling":true} |
| 259 | + }, |
| 260 | + "ValidationException":{ |
| 261 | + "type":"structure", |
| 262 | + "required":["message"], |
| 263 | + "members":{ |
| 264 | + "message":{"shape":"String"} |
| 265 | + }, |
| 266 | + "documentation":"<p>The operation failed because one of the input parameters was invalid.</p>", |
| 267 | + "error":{ |
| 268 | + "httpStatusCode":400, |
| 269 | + "senderFault":true |
| 270 | + }, |
| 271 | + "exception":true |
| 272 | + } |
| 273 | + }, |
| 274 | + "documentation":"<p>Operations for Amazon Web Services Account Management</p>" |
| 275 | +} |
0 commit comments