sns-2010-03-31.min.json (13284B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2010-03-31", 5 "endpointPrefix": "sns", 6 "protocol": "query", 7 "serviceAbbreviation": "Amazon SNS", 8 "serviceFullName": "Amazon Simple Notification Service", 9 "signatureVersion": "v4", 10 "xmlNamespace": "http://sns.amazonaws.com/doc/2010-03-31/" 11 }, 12 "operations": { 13 "AddPermission": { 14 "input": { 15 "type": "structure", 16 "required": [ 17 "TopicArn", 18 "Label", 19 "AWSAccountId", 20 "ActionName" 21 ], 22 "members": { 23 "TopicArn": {}, 24 "Label": {}, 25 "AWSAccountId": { 26 "type": "list", 27 "member": {} 28 }, 29 "ActionName": { 30 "type": "list", 31 "member": {} 32 } 33 } 34 } 35 }, 36 "CheckIfPhoneNumberIsOptedOut": { 37 "input": { 38 "type": "structure", 39 "required": [ 40 "phoneNumber" 41 ], 42 "members": { 43 "phoneNumber": {} 44 } 45 }, 46 "output": { 47 "resultWrapper": "CheckIfPhoneNumberIsOptedOutResult", 48 "type": "structure", 49 "members": { 50 "isOptedOut": { 51 "type": "boolean" 52 } 53 } 54 } 55 }, 56 "ConfirmSubscription": { 57 "input": { 58 "type": "structure", 59 "required": [ 60 "TopicArn", 61 "Token" 62 ], 63 "members": { 64 "TopicArn": {}, 65 "Token": {}, 66 "AuthenticateOnUnsubscribe": {} 67 } 68 }, 69 "output": { 70 "resultWrapper": "ConfirmSubscriptionResult", 71 "type": "structure", 72 "members": { 73 "SubscriptionArn": {} 74 } 75 } 76 }, 77 "CreatePlatformApplication": { 78 "input": { 79 "type": "structure", 80 "required": [ 81 "Name", 82 "Platform", 83 "Attributes" 84 ], 85 "members": { 86 "Name": {}, 87 "Platform": {}, 88 "Attributes": { 89 "shape": "Sj" 90 } 91 } 92 }, 93 "output": { 94 "resultWrapper": "CreatePlatformApplicationResult", 95 "type": "structure", 96 "members": { 97 "PlatformApplicationArn": {} 98 } 99 } 100 }, 101 "CreatePlatformEndpoint": { 102 "input": { 103 "type": "structure", 104 "required": [ 105 "PlatformApplicationArn", 106 "Token" 107 ], 108 "members": { 109 "PlatformApplicationArn": {}, 110 "Token": {}, 111 "CustomUserData": {}, 112 "Attributes": { 113 "shape": "Sj" 114 } 115 } 116 }, 117 "output": { 118 "resultWrapper": "CreatePlatformEndpointResult", 119 "type": "structure", 120 "members": { 121 "EndpointArn": {} 122 } 123 } 124 }, 125 "CreateTopic": { 126 "input": { 127 "type": "structure", 128 "required": [ 129 "Name" 130 ], 131 "members": { 132 "Name": {} 133 } 134 }, 135 "output": { 136 "resultWrapper": "CreateTopicResult", 137 "type": "structure", 138 "members": { 139 "TopicArn": {} 140 } 141 } 142 }, 143 "DeleteEndpoint": { 144 "input": { 145 "type": "structure", 146 "required": [ 147 "EndpointArn" 148 ], 149 "members": { 150 "EndpointArn": {} 151 } 152 } 153 }, 154 "DeletePlatformApplication": { 155 "input": { 156 "type": "structure", 157 "required": [ 158 "PlatformApplicationArn" 159 ], 160 "members": { 161 "PlatformApplicationArn": {} 162 } 163 } 164 }, 165 "DeleteTopic": { 166 "input": { 167 "type": "structure", 168 "required": [ 169 "TopicArn" 170 ], 171 "members": { 172 "TopicArn": {} 173 } 174 } 175 }, 176 "GetEndpointAttributes": { 177 "input": { 178 "type": "structure", 179 "required": [ 180 "EndpointArn" 181 ], 182 "members": { 183 "EndpointArn": {} 184 } 185 }, 186 "output": { 187 "resultWrapper": "GetEndpointAttributesResult", 188 "type": "structure", 189 "members": { 190 "Attributes": { 191 "shape": "Sj" 192 } 193 } 194 } 195 }, 196 "GetPlatformApplicationAttributes": { 197 "input": { 198 "type": "structure", 199 "required": [ 200 "PlatformApplicationArn" 201 ], 202 "members": { 203 "PlatformApplicationArn": {} 204 } 205 }, 206 "output": { 207 "resultWrapper": "GetPlatformApplicationAttributesResult", 208 "type": "structure", 209 "members": { 210 "Attributes": { 211 "shape": "Sj" 212 } 213 } 214 } 215 }, 216 "GetSMSAttributes": { 217 "input": { 218 "type": "structure", 219 "members": { 220 "attributes": { 221 "type": "list", 222 "member": {} 223 } 224 } 225 }, 226 "output": { 227 "resultWrapper": "GetSMSAttributesResult", 228 "type": "structure", 229 "members": { 230 "attributes": { 231 "shape": "Sj" 232 } 233 } 234 } 235 }, 236 "GetSubscriptionAttributes": { 237 "input": { 238 "type": "structure", 239 "required": [ 240 "SubscriptionArn" 241 ], 242 "members": { 243 "SubscriptionArn": {} 244 } 245 }, 246 "output": { 247 "resultWrapper": "GetSubscriptionAttributesResult", 248 "type": "structure", 249 "members": { 250 "Attributes": { 251 "type": "map", 252 "key": {}, 253 "value": {} 254 } 255 } 256 } 257 }, 258 "GetTopicAttributes": { 259 "input": { 260 "type": "structure", 261 "required": [ 262 "TopicArn" 263 ], 264 "members": { 265 "TopicArn": {} 266 } 267 }, 268 "output": { 269 "resultWrapper": "GetTopicAttributesResult", 270 "type": "structure", 271 "members": { 272 "Attributes": { 273 "type": "map", 274 "key": {}, 275 "value": {} 276 } 277 } 278 } 279 }, 280 "ListEndpointsByPlatformApplication": { 281 "input": { 282 "type": "structure", 283 "required": [ 284 "PlatformApplicationArn" 285 ], 286 "members": { 287 "PlatformApplicationArn": {}, 288 "NextToken": {} 289 } 290 }, 291 "output": { 292 "resultWrapper": "ListEndpointsByPlatformApplicationResult", 293 "type": "structure", 294 "members": { 295 "Endpoints": { 296 "type": "list", 297 "member": { 298 "type": "structure", 299 "members": { 300 "EndpointArn": {}, 301 "Attributes": { 302 "shape": "Sj" 303 } 304 } 305 } 306 }, 307 "NextToken": {} 308 } 309 } 310 }, 311 "ListPhoneNumbersOptedOut": { 312 "input": { 313 "type": "structure", 314 "members": { 315 "nextToken": {} 316 } 317 }, 318 "output": { 319 "resultWrapper": "ListPhoneNumbersOptedOutResult", 320 "type": "structure", 321 "members": { 322 "phoneNumbers": { 323 "type": "list", 324 "member": {} 325 }, 326 "nextToken": {} 327 } 328 } 329 }, 330 "ListPlatformApplications": { 331 "input": { 332 "type": "structure", 333 "members": { 334 "NextToken": {} 335 } 336 }, 337 "output": { 338 "resultWrapper": "ListPlatformApplicationsResult", 339 "type": "structure", 340 "members": { 341 "PlatformApplications": { 342 "type": "list", 343 "member": { 344 "type": "structure", 345 "members": { 346 "PlatformApplicationArn": {}, 347 "Attributes": { 348 "shape": "Sj" 349 } 350 } 351 } 352 }, 353 "NextToken": {} 354 } 355 } 356 }, 357 "ListSubscriptions": { 358 "input": { 359 "type": "structure", 360 "members": { 361 "NextToken": {} 362 } 363 }, 364 "output": { 365 "resultWrapper": "ListSubscriptionsResult", 366 "type": "structure", 367 "members": { 368 "Subscriptions": { 369 "shape": "S1n" 370 }, 371 "NextToken": {} 372 } 373 } 374 }, 375 "ListSubscriptionsByTopic": { 376 "input": { 377 "type": "structure", 378 "required": [ 379 "TopicArn" 380 ], 381 "members": { 382 "TopicArn": {}, 383 "NextToken": {} 384 } 385 }, 386 "output": { 387 "resultWrapper": "ListSubscriptionsByTopicResult", 388 "type": "structure", 389 "members": { 390 "Subscriptions": { 391 "shape": "S1n" 392 }, 393 "NextToken": {} 394 } 395 } 396 }, 397 "ListTopics": { 398 "input": { 399 "type": "structure", 400 "members": { 401 "NextToken": {} 402 } 403 }, 404 "output": { 405 "resultWrapper": "ListTopicsResult", 406 "type": "structure", 407 "members": { 408 "Topics": { 409 "type": "list", 410 "member": { 411 "type": "structure", 412 "members": { 413 "TopicArn": {} 414 } 415 } 416 }, 417 "NextToken": {} 418 } 419 } 420 }, 421 "OptInPhoneNumber": { 422 "input": { 423 "type": "structure", 424 "required": [ 425 "phoneNumber" 426 ], 427 "members": { 428 "phoneNumber": {} 429 } 430 }, 431 "output": { 432 "resultWrapper": "OptInPhoneNumberResult", 433 "type": "structure", 434 "members": {} 435 } 436 }, 437 "Publish": { 438 "input": { 439 "type": "structure", 440 "required": [ 441 "Message" 442 ], 443 "members": { 444 "TopicArn": {}, 445 "TargetArn": {}, 446 "PhoneNumber": {}, 447 "Message": {}, 448 "Subject": {}, 449 "MessageStructure": {}, 450 "MessageAttributes": { 451 "type": "map", 452 "key": { 453 "locationName": "Name" 454 }, 455 "value": { 456 "locationName": "Value", 457 "type": "structure", 458 "required": [ 459 "DataType" 460 ], 461 "members": { 462 "DataType": {}, 463 "StringValue": {}, 464 "BinaryValue": { 465 "type": "blob" 466 } 467 } 468 } 469 } 470 } 471 }, 472 "output": { 473 "resultWrapper": "PublishResult", 474 "type": "structure", 475 "members": { 476 "MessageId": {} 477 } 478 } 479 }, 480 "RemovePermission": { 481 "input": { 482 "type": "structure", 483 "required": [ 484 "TopicArn", 485 "Label" 486 ], 487 "members": { 488 "TopicArn": {}, 489 "Label": {} 490 } 491 } 492 }, 493 "SetEndpointAttributes": { 494 "input": { 495 "type": "structure", 496 "required": [ 497 "EndpointArn", 498 "Attributes" 499 ], 500 "members": { 501 "EndpointArn": {}, 502 "Attributes": { 503 "shape": "Sj" 504 } 505 } 506 } 507 }, 508 "SetPlatformApplicationAttributes": { 509 "input": { 510 "type": "structure", 511 "required": [ 512 "PlatformApplicationArn", 513 "Attributes" 514 ], 515 "members": { 516 "PlatformApplicationArn": {}, 517 "Attributes": { 518 "shape": "Sj" 519 } 520 } 521 } 522 }, 523 "SetSMSAttributes": { 524 "input": { 525 "type": "structure", 526 "required": [ 527 "attributes" 528 ], 529 "members": { 530 "attributes": { 531 "shape": "Sj" 532 } 533 } 534 }, 535 "output": { 536 "resultWrapper": "SetSMSAttributesResult", 537 "type": "structure", 538 "members": {} 539 } 540 }, 541 "SetSubscriptionAttributes": { 542 "input": { 543 "type": "structure", 544 "required": [ 545 "SubscriptionArn", 546 "AttributeName" 547 ], 548 "members": { 549 "SubscriptionArn": {}, 550 "AttributeName": {}, 551 "AttributeValue": {} 552 } 553 } 554 }, 555 "SetTopicAttributes": { 556 "input": { 557 "type": "structure", 558 "required": [ 559 "TopicArn", 560 "AttributeName" 561 ], 562 "members": { 563 "TopicArn": {}, 564 "AttributeName": {}, 565 "AttributeValue": {} 566 } 567 } 568 }, 569 "Subscribe": { 570 "input": { 571 "type": "structure", 572 "required": [ 573 "TopicArn", 574 "Protocol" 575 ], 576 "members": { 577 "TopicArn": {}, 578 "Protocol": {}, 579 "Endpoint": {} 580 } 581 }, 582 "output": { 583 "resultWrapper": "SubscribeResult", 584 "type": "structure", 585 "members": { 586 "SubscriptionArn": {} 587 } 588 } 589 }, 590 "Unsubscribe": { 591 "input": { 592 "type": "structure", 593 "required": [ 594 "SubscriptionArn" 595 ], 596 "members": { 597 "SubscriptionArn": {} 598 } 599 } 600 } 601 }, 602 "shapes": { 603 "Sj": { 604 "type": "map", 605 "key": {}, 606 "value": {} 607 }, 608 "S1n": { 609 "type": "list", 610 "member": { 611 "type": "structure", 612 "members": { 613 "SubscriptionArn": {}, 614 "Owner": {}, 615 "Protocol": {}, 616 "Endpoint": {}, 617 "TopicArn": {} 618 } 619 } 620 } 621 } 622 }