synthetics-2017-10-11.min.json 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2017-10-11",
  5. "endpointPrefix": "synthetics",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceAbbreviation": "Synthetics",
  9. "serviceFullName": "Synthetics",
  10. "serviceId": "synthetics",
  11. "signatureVersion": "v4",
  12. "signingName": "synthetics",
  13. "uid": "synthetics-2017-10-11"
  14. },
  15. "operations": {
  16. "AssociateResource": {
  17. "http": {
  18. "method": "PATCH",
  19. "requestUri": "/group/{groupIdentifier}/associate"
  20. },
  21. "input": {
  22. "type": "structure",
  23. "required": [
  24. "GroupIdentifier",
  25. "ResourceArn"
  26. ],
  27. "members": {
  28. "GroupIdentifier": {
  29. "location": "uri",
  30. "locationName": "groupIdentifier"
  31. },
  32. "ResourceArn": {}
  33. }
  34. },
  35. "output": {
  36. "type": "structure",
  37. "members": {}
  38. }
  39. },
  40. "CreateCanary": {
  41. "http": {
  42. "requestUri": "/canary"
  43. },
  44. "input": {
  45. "type": "structure",
  46. "required": [
  47. "Name",
  48. "Code",
  49. "ArtifactS3Location",
  50. "ExecutionRoleArn",
  51. "Schedule",
  52. "RuntimeVersion"
  53. ],
  54. "members": {
  55. "Name": {},
  56. "Code": {
  57. "shape": "S7"
  58. },
  59. "ArtifactS3Location": {},
  60. "ExecutionRoleArn": {},
  61. "Schedule": {
  62. "shape": "Sc"
  63. },
  64. "RunConfig": {
  65. "shape": "Se"
  66. },
  67. "SuccessRetentionPeriodInDays": {
  68. "type": "integer"
  69. },
  70. "FailureRetentionPeriodInDays": {
  71. "type": "integer"
  72. },
  73. "RuntimeVersion": {},
  74. "VpcConfig": {
  75. "shape": "Sm"
  76. },
  77. "Tags": {
  78. "shape": "Sr"
  79. },
  80. "ArtifactConfig": {
  81. "shape": "Su"
  82. }
  83. }
  84. },
  85. "output": {
  86. "type": "structure",
  87. "members": {
  88. "Canary": {
  89. "shape": "Sz"
  90. }
  91. }
  92. }
  93. },
  94. "CreateGroup": {
  95. "http": {
  96. "requestUri": "/group"
  97. },
  98. "input": {
  99. "type": "structure",
  100. "required": [
  101. "Name"
  102. ],
  103. "members": {
  104. "Name": {},
  105. "Tags": {
  106. "shape": "Sr"
  107. }
  108. }
  109. },
  110. "output": {
  111. "type": "structure",
  112. "members": {
  113. "Group": {
  114. "shape": "S1l"
  115. }
  116. }
  117. }
  118. },
  119. "DeleteCanary": {
  120. "http": {
  121. "method": "DELETE",
  122. "requestUri": "/canary/{name}"
  123. },
  124. "input": {
  125. "type": "structure",
  126. "required": [
  127. "Name"
  128. ],
  129. "members": {
  130. "Name": {
  131. "location": "uri",
  132. "locationName": "name"
  133. },
  134. "DeleteLambda": {
  135. "location": "querystring",
  136. "locationName": "deleteLambda",
  137. "type": "boolean"
  138. }
  139. }
  140. },
  141. "output": {
  142. "type": "structure",
  143. "members": {}
  144. }
  145. },
  146. "DeleteGroup": {
  147. "http": {
  148. "method": "DELETE",
  149. "requestUri": "/group/{groupIdentifier}"
  150. },
  151. "input": {
  152. "type": "structure",
  153. "required": [
  154. "GroupIdentifier"
  155. ],
  156. "members": {
  157. "GroupIdentifier": {
  158. "location": "uri",
  159. "locationName": "groupIdentifier"
  160. }
  161. }
  162. },
  163. "output": {
  164. "type": "structure",
  165. "members": {}
  166. }
  167. },
  168. "DescribeCanaries": {
  169. "http": {
  170. "requestUri": "/canaries"
  171. },
  172. "input": {
  173. "type": "structure",
  174. "members": {
  175. "NextToken": {},
  176. "MaxResults": {
  177. "type": "integer"
  178. },
  179. "Names": {
  180. "type": "list",
  181. "member": {}
  182. }
  183. }
  184. },
  185. "output": {
  186. "type": "structure",
  187. "members": {
  188. "Canaries": {
  189. "type": "list",
  190. "member": {
  191. "shape": "Sz"
  192. }
  193. },
  194. "NextToken": {}
  195. }
  196. }
  197. },
  198. "DescribeCanariesLastRun": {
  199. "http": {
  200. "requestUri": "/canaries/last-run"
  201. },
  202. "input": {
  203. "type": "structure",
  204. "members": {
  205. "NextToken": {},
  206. "MaxResults": {
  207. "type": "integer"
  208. },
  209. "Names": {
  210. "type": "list",
  211. "member": {}
  212. }
  213. }
  214. },
  215. "output": {
  216. "type": "structure",
  217. "members": {
  218. "CanariesLastRun": {
  219. "type": "list",
  220. "member": {
  221. "type": "structure",
  222. "members": {
  223. "CanaryName": {},
  224. "LastRun": {
  225. "shape": "S24"
  226. }
  227. }
  228. }
  229. },
  230. "NextToken": {}
  231. }
  232. }
  233. },
  234. "DescribeRuntimeVersions": {
  235. "http": {
  236. "requestUri": "/runtime-versions"
  237. },
  238. "input": {
  239. "type": "structure",
  240. "members": {
  241. "NextToken": {},
  242. "MaxResults": {
  243. "type": "integer"
  244. }
  245. }
  246. },
  247. "output": {
  248. "type": "structure",
  249. "members": {
  250. "RuntimeVersions": {
  251. "type": "list",
  252. "member": {
  253. "type": "structure",
  254. "members": {
  255. "VersionName": {},
  256. "Description": {},
  257. "ReleaseDate": {
  258. "type": "timestamp"
  259. },
  260. "DeprecationDate": {
  261. "type": "timestamp"
  262. }
  263. }
  264. }
  265. },
  266. "NextToken": {}
  267. }
  268. }
  269. },
  270. "DisassociateResource": {
  271. "http": {
  272. "method": "PATCH",
  273. "requestUri": "/group/{groupIdentifier}/disassociate"
  274. },
  275. "input": {
  276. "type": "structure",
  277. "required": [
  278. "GroupIdentifier",
  279. "ResourceArn"
  280. ],
  281. "members": {
  282. "GroupIdentifier": {
  283. "location": "uri",
  284. "locationName": "groupIdentifier"
  285. },
  286. "ResourceArn": {}
  287. }
  288. },
  289. "output": {
  290. "type": "structure",
  291. "members": {}
  292. }
  293. },
  294. "GetCanary": {
  295. "http": {
  296. "method": "GET",
  297. "requestUri": "/canary/{name}"
  298. },
  299. "input": {
  300. "type": "structure",
  301. "required": [
  302. "Name"
  303. ],
  304. "members": {
  305. "Name": {
  306. "location": "uri",
  307. "locationName": "name"
  308. }
  309. }
  310. },
  311. "output": {
  312. "type": "structure",
  313. "members": {
  314. "Canary": {
  315. "shape": "Sz"
  316. }
  317. }
  318. }
  319. },
  320. "GetCanaryRuns": {
  321. "http": {
  322. "requestUri": "/canary/{name}/runs"
  323. },
  324. "input": {
  325. "type": "structure",
  326. "required": [
  327. "Name"
  328. ],
  329. "members": {
  330. "Name": {
  331. "location": "uri",
  332. "locationName": "name"
  333. },
  334. "NextToken": {},
  335. "MaxResults": {
  336. "type": "integer"
  337. }
  338. }
  339. },
  340. "output": {
  341. "type": "structure",
  342. "members": {
  343. "CanaryRuns": {
  344. "type": "list",
  345. "member": {
  346. "shape": "S24"
  347. }
  348. },
  349. "NextToken": {}
  350. }
  351. }
  352. },
  353. "GetGroup": {
  354. "http": {
  355. "method": "GET",
  356. "requestUri": "/group/{groupIdentifier}"
  357. },
  358. "input": {
  359. "type": "structure",
  360. "required": [
  361. "GroupIdentifier"
  362. ],
  363. "members": {
  364. "GroupIdentifier": {
  365. "location": "uri",
  366. "locationName": "groupIdentifier"
  367. }
  368. }
  369. },
  370. "output": {
  371. "type": "structure",
  372. "members": {
  373. "Group": {
  374. "shape": "S1l"
  375. }
  376. }
  377. }
  378. },
  379. "ListAssociatedGroups": {
  380. "http": {
  381. "requestUri": "/resource/{resourceArn}/groups"
  382. },
  383. "input": {
  384. "type": "structure",
  385. "required": [
  386. "ResourceArn"
  387. ],
  388. "members": {
  389. "NextToken": {},
  390. "MaxResults": {
  391. "type": "integer"
  392. },
  393. "ResourceArn": {
  394. "location": "uri",
  395. "locationName": "resourceArn"
  396. }
  397. }
  398. },
  399. "output": {
  400. "type": "structure",
  401. "members": {
  402. "Groups": {
  403. "shape": "S2q"
  404. },
  405. "NextToken": {}
  406. }
  407. }
  408. },
  409. "ListGroupResources": {
  410. "http": {
  411. "requestUri": "/group/{groupIdentifier}/resources"
  412. },
  413. "input": {
  414. "type": "structure",
  415. "required": [
  416. "GroupIdentifier"
  417. ],
  418. "members": {
  419. "NextToken": {},
  420. "MaxResults": {
  421. "type": "integer"
  422. },
  423. "GroupIdentifier": {
  424. "location": "uri",
  425. "locationName": "groupIdentifier"
  426. }
  427. }
  428. },
  429. "output": {
  430. "type": "structure",
  431. "members": {
  432. "Resources": {
  433. "type": "list",
  434. "member": {}
  435. },
  436. "NextToken": {}
  437. }
  438. }
  439. },
  440. "ListGroups": {
  441. "http": {
  442. "requestUri": "/groups"
  443. },
  444. "input": {
  445. "type": "structure",
  446. "members": {
  447. "NextToken": {},
  448. "MaxResults": {
  449. "type": "integer"
  450. }
  451. }
  452. },
  453. "output": {
  454. "type": "structure",
  455. "members": {
  456. "Groups": {
  457. "shape": "S2q"
  458. },
  459. "NextToken": {}
  460. }
  461. }
  462. },
  463. "ListTagsForResource": {
  464. "http": {
  465. "method": "GET",
  466. "requestUri": "/tags/{resourceArn}"
  467. },
  468. "input": {
  469. "type": "structure",
  470. "required": [
  471. "ResourceArn"
  472. ],
  473. "members": {
  474. "ResourceArn": {
  475. "location": "uri",
  476. "locationName": "resourceArn"
  477. }
  478. }
  479. },
  480. "output": {
  481. "type": "structure",
  482. "members": {
  483. "Tags": {
  484. "shape": "Sr"
  485. }
  486. }
  487. }
  488. },
  489. "StartCanary": {
  490. "http": {
  491. "requestUri": "/canary/{name}/start"
  492. },
  493. "input": {
  494. "type": "structure",
  495. "required": [
  496. "Name"
  497. ],
  498. "members": {
  499. "Name": {
  500. "location": "uri",
  501. "locationName": "name"
  502. }
  503. }
  504. },
  505. "output": {
  506. "type": "structure",
  507. "members": {}
  508. }
  509. },
  510. "StopCanary": {
  511. "http": {
  512. "requestUri": "/canary/{name}/stop"
  513. },
  514. "input": {
  515. "type": "structure",
  516. "required": [
  517. "Name"
  518. ],
  519. "members": {
  520. "Name": {
  521. "location": "uri",
  522. "locationName": "name"
  523. }
  524. }
  525. },
  526. "output": {
  527. "type": "structure",
  528. "members": {}
  529. }
  530. },
  531. "TagResource": {
  532. "http": {
  533. "requestUri": "/tags/{resourceArn}"
  534. },
  535. "input": {
  536. "type": "structure",
  537. "required": [
  538. "ResourceArn",
  539. "Tags"
  540. ],
  541. "members": {
  542. "ResourceArn": {
  543. "location": "uri",
  544. "locationName": "resourceArn"
  545. },
  546. "Tags": {
  547. "shape": "Sr"
  548. }
  549. }
  550. },
  551. "output": {
  552. "type": "structure",
  553. "members": {}
  554. }
  555. },
  556. "UntagResource": {
  557. "http": {
  558. "method": "DELETE",
  559. "requestUri": "/tags/{resourceArn}"
  560. },
  561. "input": {
  562. "type": "structure",
  563. "required": [
  564. "ResourceArn",
  565. "TagKeys"
  566. ],
  567. "members": {
  568. "ResourceArn": {
  569. "location": "uri",
  570. "locationName": "resourceArn"
  571. },
  572. "TagKeys": {
  573. "location": "querystring",
  574. "locationName": "tagKeys",
  575. "type": "list",
  576. "member": {}
  577. }
  578. }
  579. },
  580. "output": {
  581. "type": "structure",
  582. "members": {}
  583. }
  584. },
  585. "UpdateCanary": {
  586. "http": {
  587. "method": "PATCH",
  588. "requestUri": "/canary/{name}"
  589. },
  590. "input": {
  591. "type": "structure",
  592. "required": [
  593. "Name"
  594. ],
  595. "members": {
  596. "Name": {
  597. "location": "uri",
  598. "locationName": "name"
  599. },
  600. "Code": {
  601. "shape": "S7"
  602. },
  603. "ExecutionRoleArn": {},
  604. "RuntimeVersion": {},
  605. "Schedule": {
  606. "shape": "Sc"
  607. },
  608. "RunConfig": {
  609. "shape": "Se"
  610. },
  611. "SuccessRetentionPeriodInDays": {
  612. "type": "integer"
  613. },
  614. "FailureRetentionPeriodInDays": {
  615. "type": "integer"
  616. },
  617. "VpcConfig": {
  618. "shape": "Sm"
  619. },
  620. "VisualReference": {
  621. "type": "structure",
  622. "required": [
  623. "BaseCanaryRunId"
  624. ],
  625. "members": {
  626. "BaseScreenshots": {
  627. "shape": "S1d"
  628. },
  629. "BaseCanaryRunId": {}
  630. }
  631. },
  632. "ArtifactS3Location": {},
  633. "ArtifactConfig": {
  634. "shape": "Su"
  635. }
  636. }
  637. },
  638. "output": {
  639. "type": "structure",
  640. "members": {}
  641. }
  642. }
  643. },
  644. "shapes": {
  645. "S7": {
  646. "type": "structure",
  647. "required": [
  648. "Handler"
  649. ],
  650. "members": {
  651. "S3Bucket": {},
  652. "S3Key": {},
  653. "S3Version": {},
  654. "ZipFile": {
  655. "type": "blob"
  656. },
  657. "Handler": {}
  658. }
  659. },
  660. "Sc": {
  661. "type": "structure",
  662. "required": [
  663. "Expression"
  664. ],
  665. "members": {
  666. "Expression": {},
  667. "DurationInSeconds": {
  668. "type": "long"
  669. }
  670. }
  671. },
  672. "Se": {
  673. "type": "structure",
  674. "members": {
  675. "TimeoutInSeconds": {
  676. "type": "integer"
  677. },
  678. "MemoryInMB": {
  679. "type": "integer"
  680. },
  681. "ActiveTracing": {
  682. "type": "boolean"
  683. },
  684. "EnvironmentVariables": {
  685. "type": "map",
  686. "key": {},
  687. "value": {}
  688. }
  689. }
  690. },
  691. "Sm": {
  692. "type": "structure",
  693. "members": {
  694. "SubnetIds": {
  695. "shape": "Sn"
  696. },
  697. "SecurityGroupIds": {
  698. "shape": "Sp"
  699. }
  700. }
  701. },
  702. "Sn": {
  703. "type": "list",
  704. "member": {}
  705. },
  706. "Sp": {
  707. "type": "list",
  708. "member": {}
  709. },
  710. "Sr": {
  711. "type": "map",
  712. "key": {},
  713. "value": {}
  714. },
  715. "Su": {
  716. "type": "structure",
  717. "members": {
  718. "S3Encryption": {
  719. "shape": "Sv"
  720. }
  721. }
  722. },
  723. "Sv": {
  724. "type": "structure",
  725. "members": {
  726. "EncryptionMode": {},
  727. "KmsKeyArn": {}
  728. }
  729. },
  730. "Sz": {
  731. "type": "structure",
  732. "members": {
  733. "Id": {},
  734. "Name": {},
  735. "Code": {
  736. "type": "structure",
  737. "members": {
  738. "SourceLocationArn": {},
  739. "Handler": {}
  740. }
  741. },
  742. "ExecutionRoleArn": {},
  743. "Schedule": {
  744. "type": "structure",
  745. "members": {
  746. "Expression": {},
  747. "DurationInSeconds": {
  748. "type": "long"
  749. }
  750. }
  751. },
  752. "RunConfig": {
  753. "type": "structure",
  754. "members": {
  755. "TimeoutInSeconds": {
  756. "type": "integer"
  757. },
  758. "MemoryInMB": {
  759. "type": "integer"
  760. },
  761. "ActiveTracing": {
  762. "type": "boolean"
  763. }
  764. }
  765. },
  766. "SuccessRetentionPeriodInDays": {
  767. "type": "integer"
  768. },
  769. "FailureRetentionPeriodInDays": {
  770. "type": "integer"
  771. },
  772. "Status": {
  773. "type": "structure",
  774. "members": {
  775. "State": {},
  776. "StateReason": {},
  777. "StateReasonCode": {}
  778. }
  779. },
  780. "Timeline": {
  781. "type": "structure",
  782. "members": {
  783. "Created": {
  784. "type": "timestamp"
  785. },
  786. "LastModified": {
  787. "type": "timestamp"
  788. },
  789. "LastStarted": {
  790. "type": "timestamp"
  791. },
  792. "LastStopped": {
  793. "type": "timestamp"
  794. }
  795. }
  796. },
  797. "ArtifactS3Location": {},
  798. "EngineArn": {},
  799. "RuntimeVersion": {},
  800. "VpcConfig": {
  801. "type": "structure",
  802. "members": {
  803. "VpcId": {},
  804. "SubnetIds": {
  805. "shape": "Sn"
  806. },
  807. "SecurityGroupIds": {
  808. "shape": "Sp"
  809. }
  810. }
  811. },
  812. "VisualReference": {
  813. "type": "structure",
  814. "members": {
  815. "BaseScreenshots": {
  816. "shape": "S1d"
  817. },
  818. "BaseCanaryRunId": {}
  819. }
  820. },
  821. "Tags": {
  822. "shape": "Sr"
  823. },
  824. "ArtifactConfig": {
  825. "type": "structure",
  826. "members": {
  827. "S3Encryption": {
  828. "shape": "Sv"
  829. }
  830. }
  831. }
  832. }
  833. },
  834. "S1d": {
  835. "type": "list",
  836. "member": {
  837. "type": "structure",
  838. "required": [
  839. "ScreenshotName"
  840. ],
  841. "members": {
  842. "ScreenshotName": {},
  843. "IgnoreCoordinates": {
  844. "type": "list",
  845. "member": {}
  846. }
  847. }
  848. }
  849. },
  850. "S1l": {
  851. "type": "structure",
  852. "members": {
  853. "Id": {},
  854. "Name": {},
  855. "Arn": {},
  856. "Tags": {
  857. "shape": "Sr"
  858. },
  859. "CreatedTime": {
  860. "type": "timestamp"
  861. },
  862. "LastModifiedTime": {
  863. "type": "timestamp"
  864. }
  865. }
  866. },
  867. "S24": {
  868. "type": "structure",
  869. "members": {
  870. "Id": {},
  871. "Name": {},
  872. "Status": {
  873. "type": "structure",
  874. "members": {
  875. "State": {},
  876. "StateReason": {},
  877. "StateReasonCode": {}
  878. }
  879. },
  880. "Timeline": {
  881. "type": "structure",
  882. "members": {
  883. "Started": {
  884. "type": "timestamp"
  885. },
  886. "Completed": {
  887. "type": "timestamp"
  888. }
  889. }
  890. },
  891. "ArtifactS3Location": {}
  892. }
  893. },
  894. "S2q": {
  895. "type": "list",
  896. "member": {
  897. "type": "structure",
  898. "members": {
  899. "Id": {},
  900. "Name": {},
  901. "Arn": {}
  902. }
  903. }
  904. }
  905. }
  906. }