secretsmanager-2017-10-17.min.json 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2017-10-17",
  5. "endpointPrefix": "secretsmanager",
  6. "jsonVersion": "1.1",
  7. "protocol": "json",
  8. "serviceFullName": "AWS Secrets Manager",
  9. "serviceId": "Secrets Manager",
  10. "signatureVersion": "v4",
  11. "signingName": "secretsmanager",
  12. "targetPrefix": "secretsmanager",
  13. "uid": "secretsmanager-2017-10-17"
  14. },
  15. "operations": {
  16. "BatchGetSecretValue": {
  17. "input": {
  18. "type": "structure",
  19. "members": {
  20. "SecretIdList": {
  21. "type": "list",
  22. "member": {}
  23. },
  24. "Filters": {
  25. "shape": "S4"
  26. },
  27. "MaxResults": {
  28. "type": "integer"
  29. },
  30. "NextToken": {}
  31. }
  32. },
  33. "output": {
  34. "type": "structure",
  35. "members": {
  36. "SecretValues": {
  37. "type": "list",
  38. "member": {
  39. "type": "structure",
  40. "members": {
  41. "ARN": {},
  42. "Name": {},
  43. "VersionId": {},
  44. "SecretBinary": {
  45. "shape": "Sh"
  46. },
  47. "SecretString": {
  48. "shape": "Si"
  49. },
  50. "VersionStages": {
  51. "shape": "Sj"
  52. },
  53. "CreatedDate": {
  54. "type": "timestamp"
  55. }
  56. }
  57. }
  58. },
  59. "NextToken": {},
  60. "Errors": {
  61. "type": "list",
  62. "member": {
  63. "type": "structure",
  64. "members": {
  65. "SecretId": {},
  66. "ErrorCode": {},
  67. "Message": {}
  68. }
  69. }
  70. }
  71. }
  72. }
  73. },
  74. "CancelRotateSecret": {
  75. "input": {
  76. "type": "structure",
  77. "required": [
  78. "SecretId"
  79. ],
  80. "members": {
  81. "SecretId": {}
  82. }
  83. },
  84. "output": {
  85. "type": "structure",
  86. "members": {
  87. "ARN": {},
  88. "Name": {},
  89. "VersionId": {}
  90. }
  91. }
  92. },
  93. "CreateSecret": {
  94. "input": {
  95. "type": "structure",
  96. "required": [
  97. "Name"
  98. ],
  99. "members": {
  100. "Name": {},
  101. "ClientRequestToken": {
  102. "idempotencyToken": true
  103. },
  104. "Description": {},
  105. "KmsKeyId": {},
  106. "SecretBinary": {
  107. "shape": "Sh"
  108. },
  109. "SecretString": {
  110. "shape": "Si"
  111. },
  112. "Tags": {
  113. "shape": "Sx"
  114. },
  115. "AddReplicaRegions": {
  116. "shape": "S11"
  117. },
  118. "ForceOverwriteReplicaSecret": {
  119. "type": "boolean"
  120. }
  121. }
  122. },
  123. "output": {
  124. "type": "structure",
  125. "members": {
  126. "ARN": {},
  127. "Name": {},
  128. "VersionId": {},
  129. "ReplicationStatus": {
  130. "shape": "S16"
  131. }
  132. }
  133. }
  134. },
  135. "DeleteResourcePolicy": {
  136. "input": {
  137. "type": "structure",
  138. "required": [
  139. "SecretId"
  140. ],
  141. "members": {
  142. "SecretId": {}
  143. }
  144. },
  145. "output": {
  146. "type": "structure",
  147. "members": {
  148. "ARN": {},
  149. "Name": {}
  150. }
  151. }
  152. },
  153. "DeleteSecret": {
  154. "input": {
  155. "type": "structure",
  156. "required": [
  157. "SecretId"
  158. ],
  159. "members": {
  160. "SecretId": {},
  161. "RecoveryWindowInDays": {
  162. "type": "long"
  163. },
  164. "ForceDeleteWithoutRecovery": {
  165. "type": "boolean"
  166. }
  167. }
  168. },
  169. "output": {
  170. "type": "structure",
  171. "members": {
  172. "ARN": {},
  173. "Name": {},
  174. "DeletionDate": {
  175. "type": "timestamp"
  176. }
  177. }
  178. }
  179. },
  180. "DescribeSecret": {
  181. "input": {
  182. "type": "structure",
  183. "required": [
  184. "SecretId"
  185. ],
  186. "members": {
  187. "SecretId": {}
  188. }
  189. },
  190. "output": {
  191. "type": "structure",
  192. "members": {
  193. "ARN": {},
  194. "Name": {},
  195. "Description": {},
  196. "KmsKeyId": {},
  197. "RotationEnabled": {
  198. "type": "boolean"
  199. },
  200. "RotationLambdaARN": {},
  201. "RotationRules": {
  202. "shape": "S1l"
  203. },
  204. "LastRotatedDate": {
  205. "type": "timestamp"
  206. },
  207. "LastChangedDate": {
  208. "type": "timestamp"
  209. },
  210. "LastAccessedDate": {
  211. "type": "timestamp"
  212. },
  213. "DeletedDate": {
  214. "type": "timestamp"
  215. },
  216. "NextRotationDate": {
  217. "type": "timestamp"
  218. },
  219. "Tags": {
  220. "shape": "Sx"
  221. },
  222. "VersionIdsToStages": {
  223. "shape": "S1t"
  224. },
  225. "OwningService": {},
  226. "CreatedDate": {
  227. "type": "timestamp"
  228. },
  229. "PrimaryRegion": {},
  230. "ReplicationStatus": {
  231. "shape": "S16"
  232. }
  233. }
  234. }
  235. },
  236. "GetRandomPassword": {
  237. "input": {
  238. "type": "structure",
  239. "members": {
  240. "PasswordLength": {
  241. "type": "long"
  242. },
  243. "ExcludeCharacters": {},
  244. "ExcludeNumbers": {
  245. "type": "boolean"
  246. },
  247. "ExcludePunctuation": {
  248. "type": "boolean"
  249. },
  250. "ExcludeUppercase": {
  251. "type": "boolean"
  252. },
  253. "ExcludeLowercase": {
  254. "type": "boolean"
  255. },
  256. "IncludeSpace": {
  257. "type": "boolean"
  258. },
  259. "RequireEachIncludedType": {
  260. "type": "boolean"
  261. }
  262. }
  263. },
  264. "output": {
  265. "type": "structure",
  266. "members": {
  267. "RandomPassword": {
  268. "type": "string",
  269. "sensitive": true
  270. }
  271. }
  272. }
  273. },
  274. "GetResourcePolicy": {
  275. "input": {
  276. "type": "structure",
  277. "required": [
  278. "SecretId"
  279. ],
  280. "members": {
  281. "SecretId": {}
  282. }
  283. },
  284. "output": {
  285. "type": "structure",
  286. "members": {
  287. "ARN": {},
  288. "Name": {},
  289. "ResourcePolicy": {}
  290. }
  291. }
  292. },
  293. "GetSecretValue": {
  294. "input": {
  295. "type": "structure",
  296. "required": [
  297. "SecretId"
  298. ],
  299. "members": {
  300. "SecretId": {},
  301. "VersionId": {},
  302. "VersionStage": {}
  303. }
  304. },
  305. "output": {
  306. "type": "structure",
  307. "members": {
  308. "ARN": {},
  309. "Name": {},
  310. "VersionId": {},
  311. "SecretBinary": {
  312. "shape": "Sh"
  313. },
  314. "SecretString": {
  315. "shape": "Si"
  316. },
  317. "VersionStages": {
  318. "shape": "Sj"
  319. },
  320. "CreatedDate": {
  321. "type": "timestamp"
  322. }
  323. }
  324. }
  325. },
  326. "ListSecretVersionIds": {
  327. "input": {
  328. "type": "structure",
  329. "required": [
  330. "SecretId"
  331. ],
  332. "members": {
  333. "SecretId": {},
  334. "MaxResults": {
  335. "type": "integer"
  336. },
  337. "NextToken": {},
  338. "IncludeDeprecated": {
  339. "type": "boolean"
  340. }
  341. }
  342. },
  343. "output": {
  344. "type": "structure",
  345. "members": {
  346. "Versions": {
  347. "type": "list",
  348. "member": {
  349. "type": "structure",
  350. "members": {
  351. "VersionId": {},
  352. "VersionStages": {
  353. "shape": "Sj"
  354. },
  355. "LastAccessedDate": {
  356. "type": "timestamp"
  357. },
  358. "CreatedDate": {
  359. "type": "timestamp"
  360. },
  361. "KmsKeyIds": {
  362. "type": "list",
  363. "member": {}
  364. }
  365. }
  366. }
  367. },
  368. "NextToken": {},
  369. "ARN": {},
  370. "Name": {}
  371. }
  372. }
  373. },
  374. "ListSecrets": {
  375. "input": {
  376. "type": "structure",
  377. "members": {
  378. "IncludePlannedDeletion": {
  379. "type": "boolean"
  380. },
  381. "MaxResults": {
  382. "type": "integer"
  383. },
  384. "NextToken": {},
  385. "Filters": {
  386. "shape": "S4"
  387. },
  388. "SortOrder": {}
  389. }
  390. },
  391. "output": {
  392. "type": "structure",
  393. "members": {
  394. "SecretList": {
  395. "type": "list",
  396. "member": {
  397. "type": "structure",
  398. "members": {
  399. "ARN": {},
  400. "Name": {},
  401. "Description": {},
  402. "KmsKeyId": {},
  403. "RotationEnabled": {
  404. "type": "boolean"
  405. },
  406. "RotationLambdaARN": {},
  407. "RotationRules": {
  408. "shape": "S1l"
  409. },
  410. "LastRotatedDate": {
  411. "type": "timestamp"
  412. },
  413. "LastChangedDate": {
  414. "type": "timestamp"
  415. },
  416. "LastAccessedDate": {
  417. "type": "timestamp"
  418. },
  419. "DeletedDate": {
  420. "type": "timestamp"
  421. },
  422. "NextRotationDate": {
  423. "type": "timestamp"
  424. },
  425. "Tags": {
  426. "shape": "Sx"
  427. },
  428. "SecretVersionsToStages": {
  429. "shape": "S1t"
  430. },
  431. "OwningService": {},
  432. "CreatedDate": {
  433. "type": "timestamp"
  434. },
  435. "PrimaryRegion": {}
  436. }
  437. }
  438. },
  439. "NextToken": {}
  440. }
  441. }
  442. },
  443. "PutResourcePolicy": {
  444. "input": {
  445. "type": "structure",
  446. "required": [
  447. "SecretId",
  448. "ResourcePolicy"
  449. ],
  450. "members": {
  451. "SecretId": {},
  452. "ResourcePolicy": {},
  453. "BlockPublicPolicy": {
  454. "type": "boolean"
  455. }
  456. }
  457. },
  458. "output": {
  459. "type": "structure",
  460. "members": {
  461. "ARN": {},
  462. "Name": {}
  463. }
  464. }
  465. },
  466. "PutSecretValue": {
  467. "input": {
  468. "type": "structure",
  469. "required": [
  470. "SecretId"
  471. ],
  472. "members": {
  473. "SecretId": {},
  474. "ClientRequestToken": {
  475. "idempotencyToken": true
  476. },
  477. "SecretBinary": {
  478. "shape": "Sh"
  479. },
  480. "SecretString": {
  481. "shape": "Si"
  482. },
  483. "VersionStages": {
  484. "shape": "Sj"
  485. }
  486. }
  487. },
  488. "output": {
  489. "type": "structure",
  490. "members": {
  491. "ARN": {},
  492. "Name": {},
  493. "VersionId": {},
  494. "VersionStages": {
  495. "shape": "Sj"
  496. }
  497. }
  498. }
  499. },
  500. "RemoveRegionsFromReplication": {
  501. "input": {
  502. "type": "structure",
  503. "required": [
  504. "SecretId",
  505. "RemoveReplicaRegions"
  506. ],
  507. "members": {
  508. "SecretId": {},
  509. "RemoveReplicaRegions": {
  510. "type": "list",
  511. "member": {}
  512. }
  513. }
  514. },
  515. "output": {
  516. "type": "structure",
  517. "members": {
  518. "ARN": {},
  519. "ReplicationStatus": {
  520. "shape": "S16"
  521. }
  522. }
  523. }
  524. },
  525. "ReplicateSecretToRegions": {
  526. "input": {
  527. "type": "structure",
  528. "required": [
  529. "SecretId",
  530. "AddReplicaRegions"
  531. ],
  532. "members": {
  533. "SecretId": {},
  534. "AddReplicaRegions": {
  535. "shape": "S11"
  536. },
  537. "ForceOverwriteReplicaSecret": {
  538. "type": "boolean"
  539. }
  540. }
  541. },
  542. "output": {
  543. "type": "structure",
  544. "members": {
  545. "ARN": {},
  546. "ReplicationStatus": {
  547. "shape": "S16"
  548. }
  549. }
  550. }
  551. },
  552. "RestoreSecret": {
  553. "input": {
  554. "type": "structure",
  555. "required": [
  556. "SecretId"
  557. ],
  558. "members": {
  559. "SecretId": {}
  560. }
  561. },
  562. "output": {
  563. "type": "structure",
  564. "members": {
  565. "ARN": {},
  566. "Name": {}
  567. }
  568. }
  569. },
  570. "RotateSecret": {
  571. "input": {
  572. "type": "structure",
  573. "required": [
  574. "SecretId"
  575. ],
  576. "members": {
  577. "SecretId": {},
  578. "ClientRequestToken": {
  579. "idempotencyToken": true
  580. },
  581. "RotationLambdaARN": {},
  582. "RotationRules": {
  583. "shape": "S1l"
  584. },
  585. "RotateImmediately": {
  586. "type": "boolean"
  587. }
  588. }
  589. },
  590. "output": {
  591. "type": "structure",
  592. "members": {
  593. "ARN": {},
  594. "Name": {},
  595. "VersionId": {}
  596. }
  597. }
  598. },
  599. "StopReplicationToReplica": {
  600. "input": {
  601. "type": "structure",
  602. "required": [
  603. "SecretId"
  604. ],
  605. "members": {
  606. "SecretId": {}
  607. }
  608. },
  609. "output": {
  610. "type": "structure",
  611. "members": {
  612. "ARN": {}
  613. }
  614. }
  615. },
  616. "TagResource": {
  617. "input": {
  618. "type": "structure",
  619. "required": [
  620. "SecretId",
  621. "Tags"
  622. ],
  623. "members": {
  624. "SecretId": {},
  625. "Tags": {
  626. "shape": "Sx"
  627. }
  628. }
  629. }
  630. },
  631. "UntagResource": {
  632. "input": {
  633. "type": "structure",
  634. "required": [
  635. "SecretId",
  636. "TagKeys"
  637. ],
  638. "members": {
  639. "SecretId": {},
  640. "TagKeys": {
  641. "type": "list",
  642. "member": {}
  643. }
  644. }
  645. }
  646. },
  647. "UpdateSecret": {
  648. "input": {
  649. "type": "structure",
  650. "required": [
  651. "SecretId"
  652. ],
  653. "members": {
  654. "SecretId": {},
  655. "ClientRequestToken": {
  656. "idempotencyToken": true
  657. },
  658. "Description": {},
  659. "KmsKeyId": {},
  660. "SecretBinary": {
  661. "shape": "Sh"
  662. },
  663. "SecretString": {
  664. "shape": "Si"
  665. }
  666. }
  667. },
  668. "output": {
  669. "type": "structure",
  670. "members": {
  671. "ARN": {},
  672. "Name": {},
  673. "VersionId": {}
  674. }
  675. }
  676. },
  677. "UpdateSecretVersionStage": {
  678. "input": {
  679. "type": "structure",
  680. "required": [
  681. "SecretId",
  682. "VersionStage"
  683. ],
  684. "members": {
  685. "SecretId": {},
  686. "VersionStage": {},
  687. "RemoveFromVersionId": {},
  688. "MoveToVersionId": {}
  689. }
  690. },
  691. "output": {
  692. "type": "structure",
  693. "members": {
  694. "ARN": {},
  695. "Name": {}
  696. }
  697. }
  698. },
  699. "ValidateResourcePolicy": {
  700. "input": {
  701. "type": "structure",
  702. "required": [
  703. "ResourcePolicy"
  704. ],
  705. "members": {
  706. "SecretId": {},
  707. "ResourcePolicy": {}
  708. }
  709. },
  710. "output": {
  711. "type": "structure",
  712. "members": {
  713. "PolicyValidationPassed": {
  714. "type": "boolean"
  715. },
  716. "ValidationErrors": {
  717. "type": "list",
  718. "member": {
  719. "type": "structure",
  720. "members": {
  721. "CheckName": {},
  722. "ErrorMessage": {}
  723. }
  724. }
  725. }
  726. }
  727. }
  728. }
  729. },
  730. "shapes": {
  731. "S4": {
  732. "type": "list",
  733. "member": {
  734. "type": "structure",
  735. "members": {
  736. "Key": {},
  737. "Values": {
  738. "type": "list",
  739. "member": {}
  740. }
  741. }
  742. }
  743. },
  744. "Sh": {
  745. "type": "blob",
  746. "sensitive": true
  747. },
  748. "Si": {
  749. "type": "string",
  750. "sensitive": true
  751. },
  752. "Sj": {
  753. "type": "list",
  754. "member": {}
  755. },
  756. "Sx": {
  757. "type": "list",
  758. "member": {
  759. "type": "structure",
  760. "members": {
  761. "Key": {},
  762. "Value": {}
  763. }
  764. }
  765. },
  766. "S11": {
  767. "type": "list",
  768. "member": {
  769. "type": "structure",
  770. "members": {
  771. "Region": {},
  772. "KmsKeyId": {}
  773. }
  774. }
  775. },
  776. "S16": {
  777. "type": "list",
  778. "member": {
  779. "type": "structure",
  780. "members": {
  781. "Region": {},
  782. "KmsKeyId": {},
  783. "Status": {},
  784. "StatusMessage": {},
  785. "LastAccessedDate": {
  786. "type": "timestamp"
  787. }
  788. }
  789. }
  790. },
  791. "S1l": {
  792. "type": "structure",
  793. "members": {
  794. "AutomaticallyAfterDays": {
  795. "type": "long"
  796. },
  797. "Duration": {},
  798. "ScheduleExpression": {}
  799. }
  800. },
  801. "S1t": {
  802. "type": "map",
  803. "key": {},
  804. "value": {
  805. "shape": "Sj"
  806. }
  807. }
  808. }
  809. }