iam-2010-05-08.examples.json 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577
  1. {
  2. "version": "1.0",
  3. "examples": {
  4. "AddClientIDToOpenIDConnectProvider": [
  5. {
  6. "input": {
  7. "ClientID": "my-application-ID",
  8. "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com"
  9. },
  10. "comments": {
  11. "input": {
  12. },
  13. "output": {
  14. }
  15. },
  16. "description": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:",
  17. "id": "028e91f4-e2a6-4d59-9e3b-4965a3fb19be",
  18. "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider"
  19. }
  20. ],
  21. "AddRoleToInstanceProfile": [
  22. {
  23. "input": {
  24. "InstanceProfileName": "Webserver",
  25. "RoleName": "S3Access"
  26. },
  27. "comments": {
  28. "input": {
  29. },
  30. "output": {
  31. }
  32. },
  33. "description": "The following command adds the role named S3Access to the instance profile named Webserver:",
  34. "id": "c107fac3-edb6-4827-8a71-8863ec91c81f",
  35. "title": "To add a role to an instance profile"
  36. }
  37. ],
  38. "AddUserToGroup": [
  39. {
  40. "input": {
  41. "GroupName": "Admins",
  42. "UserName": "Bob"
  43. },
  44. "comments": {
  45. "input": {
  46. },
  47. "output": {
  48. }
  49. },
  50. "description": "The following command adds an IAM user named Bob to the IAM group named Admins:",
  51. "id": "619c7e6b-09f8-4036-857b-51a6ea5027ca",
  52. "title": "To add a user to an IAM group"
  53. }
  54. ],
  55. "AttachGroupPolicy": [
  56. {
  57. "input": {
  58. "GroupName": "Finance",
  59. "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess"
  60. },
  61. "comments": {
  62. "input": {
  63. },
  64. "output": {
  65. }
  66. },
  67. "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.",
  68. "id": "87551489-86f0-45db-9889-759936778f2b",
  69. "title": "To attach a managed policy to an IAM group"
  70. }
  71. ],
  72. "AttachRolePolicy": [
  73. {
  74. "input": {
  75. "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess",
  76. "RoleName": "ReadOnlyRole"
  77. },
  78. "comments": {
  79. "input": {
  80. },
  81. "output": {
  82. }
  83. },
  84. "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.",
  85. "id": "3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e",
  86. "title": "To attach a managed policy to an IAM role"
  87. }
  88. ],
  89. "AttachUserPolicy": [
  90. {
  91. "input": {
  92. "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess",
  93. "UserName": "Alice"
  94. },
  95. "comments": {
  96. "input": {
  97. },
  98. "output": {
  99. }
  100. },
  101. "description": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.",
  102. "id": "1372ebd8-9475-4b1a-a479-23b6fd4b8b3e",
  103. "title": "To attach a managed policy to an IAM user"
  104. }
  105. ],
  106. "ChangePassword": [
  107. {
  108. "input": {
  109. "NewPassword": "]35d/{pB9Fo9wJ",
  110. "OldPassword": "3s0K_;xh4~8XXI"
  111. },
  112. "comments": {
  113. "input": {
  114. },
  115. "output": {
  116. }
  117. },
  118. "description": "The following command changes the password for the current IAM user.",
  119. "id": "3a80c66f-bffb-46df-947c-1e8fa583b470",
  120. "title": "To change the password for your IAM user"
  121. }
  122. ],
  123. "CreateAccessKey": [
  124. {
  125. "input": {
  126. "UserName": "Bob"
  127. },
  128. "output": {
  129. "AccessKey": {
  130. "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
  131. "CreateDate": "2015-03-09T18:39:23.411Z",
  132. "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
  133. "Status": "Active",
  134. "UserName": "Bob"
  135. }
  136. },
  137. "comments": {
  138. "input": {
  139. },
  140. "output": {
  141. }
  142. },
  143. "description": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.",
  144. "id": "1fbb3211-4cf2-41db-8c20-ba58d9f5802d",
  145. "title": "To create an access key for an IAM user"
  146. }
  147. ],
  148. "CreateAccountAlias": [
  149. {
  150. "input": {
  151. "AccountAlias": "examplecorp"
  152. },
  153. "comments": {
  154. "input": {
  155. },
  156. "output": {
  157. }
  158. },
  159. "description": "The following command associates the alias examplecorp to your AWS account.",
  160. "id": "5adaf6fb-94fc-4ca2-b825-2fbc2062add1",
  161. "title": "To create an account alias"
  162. }
  163. ],
  164. "CreateGroup": [
  165. {
  166. "input": {
  167. "GroupName": "Admins"
  168. },
  169. "output": {
  170. "Group": {
  171. "Arn": "arn:aws:iam::123456789012:group/Admins",
  172. "CreateDate": "2015-03-09T20:30:24.940Z",
  173. "GroupId": "AIDGPMS9RO4H3FEXAMPLE",
  174. "GroupName": "Admins",
  175. "Path": "/"
  176. }
  177. },
  178. "comments": {
  179. "input": {
  180. },
  181. "output": {
  182. }
  183. },
  184. "description": "The following command creates an IAM group named Admins.",
  185. "id": "d5da2a90-5e69-4ef7-8ae8-4c33dc21fd21",
  186. "title": "To create an IAM group"
  187. }
  188. ],
  189. "CreateInstanceProfile": [
  190. {
  191. "input": {
  192. "InstanceProfileName": "Webserver"
  193. },
  194. "output": {
  195. "InstanceProfile": {
  196. "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver",
  197. "CreateDate": "2015-03-09T20:33:19.626Z",
  198. "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE",
  199. "InstanceProfileName": "Webserver",
  200. "Path": "/",
  201. "Roles": [
  202. ]
  203. }
  204. },
  205. "comments": {
  206. "input": {
  207. },
  208. "output": {
  209. }
  210. },
  211. "description": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.",
  212. "id": "5d84e6ae-5921-4e39-8454-10232cd9ff9a",
  213. "title": "To create an instance profile"
  214. }
  215. ],
  216. "CreateLoginProfile": [
  217. {
  218. "input": {
  219. "Password": "h]6EszR}vJ*m",
  220. "PasswordResetRequired": true,
  221. "UserName": "Bob"
  222. },
  223. "output": {
  224. "LoginProfile": {
  225. "CreateDate": "2015-03-10T20:55:40.274Z",
  226. "PasswordResetRequired": true,
  227. "UserName": "Bob"
  228. }
  229. },
  230. "comments": {
  231. "input": {
  232. },
  233. "output": {
  234. }
  235. },
  236. "description": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.",
  237. "id": "c63795bc-3444-40b3-89df-83c474ef88be",
  238. "title": "To create an instance profile"
  239. }
  240. ],
  241. "CreateOpenIDConnectProvider": [
  242. {
  243. "input": {
  244. "ClientIDList": [
  245. "my-application-id"
  246. ],
  247. "ThumbprintList": [
  248. "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE"
  249. ],
  250. "Url": "https://server.example.com"
  251. },
  252. "output": {
  253. "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com"
  254. },
  255. "comments": {
  256. "input": {
  257. },
  258. "output": {
  259. }
  260. },
  261. "description": "The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.",
  262. "id": "4e4a6bff-cc97-4406-922e-0ab4a82cdb63",
  263. "title": "To create an instance profile"
  264. }
  265. ],
  266. "CreateRole": [
  267. {
  268. "input": {
  269. "AssumeRolePolicyDocument": "<Stringified-JSON>",
  270. "Path": "/",
  271. "RoleName": "Test-Role"
  272. },
  273. "output": {
  274. "Role": {
  275. "Arn": "arn:aws:iam::123456789012:role/Test-Role",
  276. "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
  277. "CreateDate": "2013-06-07T20:43:32.821Z",
  278. "Path": "/",
  279. "RoleId": "AKIAIOSFODNN7EXAMPLE",
  280. "RoleName": "Test-Role"
  281. }
  282. },
  283. "comments": {
  284. "input": {
  285. },
  286. "output": {
  287. }
  288. },
  289. "description": "The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.",
  290. "id": "eaaa4b5f-51f1-4f73-b0d3-30127040eff8",
  291. "title": "To create an IAM role"
  292. }
  293. ],
  294. "CreateUser": [
  295. {
  296. "input": {
  297. "UserName": "Bob"
  298. },
  299. "output": {
  300. "User": {
  301. "Arn": "arn:aws:iam::123456789012:user/Bob",
  302. "CreateDate": "2013-06-08T03:20:41.270Z",
  303. "Path": "/",
  304. "UserId": "AKIAIOSFODNN7EXAMPLE",
  305. "UserName": "Bob"
  306. }
  307. },
  308. "comments": {
  309. "input": {
  310. },
  311. "output": {
  312. }
  313. },
  314. "description": "The following create-user command creates an IAM user named Bob in the current account.",
  315. "id": "eb15f90b-e5f5-4af8-a594-e4e82b181a62",
  316. "title": "To create an IAM user"
  317. }
  318. ],
  319. "DeleteAccessKey": [
  320. {
  321. "input": {
  322. "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE",
  323. "UserName": "Bob"
  324. },
  325. "comments": {
  326. "input": {
  327. },
  328. "output": {
  329. }
  330. },
  331. "description": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.",
  332. "id": "61a785a7-d30a-415a-ae18-ab9236e56871",
  333. "title": "To delete an access key for an IAM user"
  334. }
  335. ],
  336. "DeleteAccountAlias": [
  337. {
  338. "input": {
  339. "AccountAlias": "mycompany"
  340. },
  341. "comments": {
  342. "input": {
  343. },
  344. "output": {
  345. }
  346. },
  347. "description": "The following command removes the alias mycompany from the current AWS account:",
  348. "id": "7abeca65-04a8-4500-a890-47f1092bf766",
  349. "title": "To delete an account alias"
  350. }
  351. ],
  352. "DeleteAccountPasswordPolicy": [
  353. {
  354. "comments": {
  355. "input": {
  356. },
  357. "output": {
  358. }
  359. },
  360. "description": "The following command removes the password policy from the current AWS account:",
  361. "id": "9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf",
  362. "title": "To delete the current account password policy"
  363. }
  364. ],
  365. "DeleteGroupPolicy": [
  366. {
  367. "input": {
  368. "GroupName": "Admins",
  369. "PolicyName": "ExamplePolicy"
  370. },
  371. "comments": {
  372. "input": {
  373. },
  374. "output": {
  375. }
  376. },
  377. "description": "The following command deletes the policy named ExamplePolicy from the group named Admins:",
  378. "id": "e683f2bd-98a4-4fe0-bb66-33169c692d4a",
  379. "title": "To delete a policy from an IAM group"
  380. }
  381. ],
  382. "DeleteInstanceProfile": [
  383. {
  384. "input": {
  385. "InstanceProfileName": "ExampleInstanceProfile"
  386. },
  387. "comments": {
  388. "input": {
  389. },
  390. "output": {
  391. }
  392. },
  393. "description": "The following command deletes the instance profile named ExampleInstanceProfile",
  394. "id": "12d74fb8-3433-49db-8171-a1fc764e354d",
  395. "title": "To delete an instance profile"
  396. }
  397. ],
  398. "DeleteLoginProfile": [
  399. {
  400. "input": {
  401. "UserName": "Bob"
  402. },
  403. "comments": {
  404. "input": {
  405. },
  406. "output": {
  407. }
  408. },
  409. "description": "The following command deletes the password for the IAM user named Bob.",
  410. "id": "1fe57059-fc73-42e2-b992-517b7d573b5c",
  411. "title": "To delete a password for an IAM user"
  412. }
  413. ],
  414. "DeleteRole": [
  415. {
  416. "input": {
  417. "RoleName": "Test-Role"
  418. },
  419. "comments": {
  420. "input": {
  421. },
  422. "output": {
  423. }
  424. },
  425. "description": "The following command removes the role named Test-Role.",
  426. "id": "053cdf74-9bda-44b8-bdbb-140fd5a32603",
  427. "title": "To delete an IAM role"
  428. }
  429. ],
  430. "DeleteRolePolicy": [
  431. {
  432. "input": {
  433. "PolicyName": "ExamplePolicy",
  434. "RoleName": "Test-Role"
  435. },
  436. "comments": {
  437. "input": {
  438. },
  439. "output": {
  440. }
  441. },
  442. "description": "The following command removes the policy named ExamplePolicy from the role named Test-Role.",
  443. "id": "9c667336-fde3-462c-b8f3-950800821e27",
  444. "title": "To remove a policy from an IAM role"
  445. }
  446. ],
  447. "DeleteSigningCertificate": [
  448. {
  449. "input": {
  450. "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
  451. "UserName": "Anika"
  452. },
  453. "comments": {
  454. "input": {
  455. },
  456. "output": {
  457. }
  458. },
  459. "description": "The following command deletes the specified signing certificate for the IAM user named Anika.",
  460. "id": "e3357586-ba9c-4070-b35b-d1a899b71987",
  461. "title": "To delete a signing certificate for an IAM user"
  462. }
  463. ],
  464. "DeleteUser": [
  465. {
  466. "input": {
  467. "UserName": "Bob"
  468. },
  469. "comments": {
  470. "input": {
  471. },
  472. "output": {
  473. }
  474. },
  475. "description": "The following command removes the IAM user named Bob from the current account.",
  476. "id": "a13dc3f9-59fe-42d9-abbb-fb98b204fdf0",
  477. "title": "To delete an IAM user"
  478. }
  479. ],
  480. "DeleteUserPolicy": [
  481. {
  482. "input": {
  483. "PolicyName": "ExamplePolicy",
  484. "UserName": "Juan"
  485. },
  486. "comments": {
  487. "input": {
  488. },
  489. "output": {
  490. }
  491. },
  492. "description": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:",
  493. "id": "34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8",
  494. "title": "To remove a policy from an IAM user"
  495. }
  496. ],
  497. "DeleteVirtualMFADevice": [
  498. {
  499. "input": {
  500. "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName"
  501. },
  502. "comments": {
  503. "input": {
  504. },
  505. "output": {
  506. }
  507. },
  508. "description": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.",
  509. "id": "2933b08b-dbe7-4b89-b8c1-fdf75feea1ee",
  510. "title": "To remove a virtual MFA device"
  511. }
  512. ],
  513. "GenerateOrganizationsAccessReport": [
  514. {
  515. "input": {
  516. "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example"
  517. },
  518. "output": {
  519. "JobId": "examplea-1234-b567-cde8-90fg123abcd4"
  520. },
  521. "comments": {
  522. "input": {
  523. },
  524. "output": {
  525. }
  526. },
  527. "description": "The following operation generates a report for the organizational unit ou-rge0-awexample",
  528. "id": "generateorganizationsaccessreport-ou",
  529. "title": "To generate a service last accessed data report for an organizational unit"
  530. }
  531. ],
  532. "GenerateServiceLastAccessedDetails": [
  533. {
  534. "input": {
  535. "Arn": "arn:aws:iam::123456789012:policy/ExamplePolicy1"
  536. },
  537. "output": {
  538. "JobId": "examplef-1305-c245-eba4-71fe298bcda7"
  539. },
  540. "comments": {
  541. "input": {
  542. },
  543. "output": {
  544. }
  545. },
  546. "description": "The following operation generates a report for the policy: ExamplePolicy1",
  547. "id": "generateaccessdata-policy-1541695178514",
  548. "title": "To generate a service last accessed data report for a policy"
  549. }
  550. ],
  551. "GetAccountPasswordPolicy": [
  552. {
  553. "output": {
  554. "PasswordPolicy": {
  555. "AllowUsersToChangePassword": false,
  556. "ExpirePasswords": false,
  557. "HardExpiry": false,
  558. "MaxPasswordAge": 90,
  559. "MinimumPasswordLength": 8,
  560. "PasswordReusePrevention": 12,
  561. "RequireLowercaseCharacters": false,
  562. "RequireNumbers": true,
  563. "RequireSymbols": true,
  564. "RequireUppercaseCharacters": false
  565. }
  566. },
  567. "comments": {
  568. "input": {
  569. },
  570. "output": {
  571. }
  572. },
  573. "description": "The following command displays details about the password policy for the current AWS account.",
  574. "id": "5e4598c7-c425-431f-8af1-19073b3c4a5f",
  575. "title": "To see the current account password policy"
  576. }
  577. ],
  578. "GetAccountSummary": [
  579. {
  580. "output": {
  581. "SummaryMap": {
  582. "AccessKeysPerUserQuota": 2,
  583. "AccountAccessKeysPresent": 1,
  584. "AccountMFAEnabled": 0,
  585. "AccountSigningCertificatesPresent": 0,
  586. "AttachedPoliciesPerGroupQuota": 10,
  587. "AttachedPoliciesPerRoleQuota": 10,
  588. "AttachedPoliciesPerUserQuota": 10,
  589. "GlobalEndpointTokenVersion": 2,
  590. "GroupPolicySizeQuota": 5120,
  591. "Groups": 15,
  592. "GroupsPerUserQuota": 10,
  593. "GroupsQuota": 100,
  594. "MFADevices": 6,
  595. "MFADevicesInUse": 3,
  596. "Policies": 8,
  597. "PoliciesQuota": 1000,
  598. "PolicySizeQuota": 5120,
  599. "PolicyVersionsInUse": 22,
  600. "PolicyVersionsInUseQuota": 10000,
  601. "ServerCertificates": 1,
  602. "ServerCertificatesQuota": 20,
  603. "SigningCertificatesPerUserQuota": 2,
  604. "UserPolicySizeQuota": 2048,
  605. "Users": 27,
  606. "UsersQuota": 5000,
  607. "VersionsPerPolicyQuota": 5
  608. }
  609. },
  610. "comments": {
  611. "input": {
  612. },
  613. "output": {
  614. }
  615. },
  616. "description": "The following command returns information about the IAM entity quotas and usage in the current AWS account.",
  617. "id": "9d8447af-f344-45de-8219-2cebc3cce7f2",
  618. "title": "To get information about IAM entity quotas and usage in the current account"
  619. }
  620. ],
  621. "GetInstanceProfile": [
  622. {
  623. "input": {
  624. "InstanceProfileName": "ExampleInstanceProfile"
  625. },
  626. "output": {
  627. "InstanceProfile": {
  628. "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile",
  629. "CreateDate": "2013-06-12T23:52:02Z",
  630. "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE",
  631. "InstanceProfileName": "ExampleInstanceProfile",
  632. "Path": "/",
  633. "Roles": [
  634. {
  635. "Arn": "arn:aws:iam::336924118301:role/Test-Role",
  636. "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
  637. "CreateDate": "2013-01-09T06:33:26Z",
  638. "Path": "/",
  639. "RoleId": "AIDGPMS9RO4H3FEXAMPLE",
  640. "RoleName": "Test-Role"
  641. }
  642. ]
  643. }
  644. },
  645. "comments": {
  646. "input": {
  647. },
  648. "output": {
  649. }
  650. },
  651. "description": "The following command gets information about the instance profile named ExampleInstanceProfile.",
  652. "id": "463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7",
  653. "title": "To get information about an instance profile"
  654. }
  655. ],
  656. "GetLoginProfile": [
  657. {
  658. "input": {
  659. "UserName": "Anika"
  660. },
  661. "output": {
  662. "LoginProfile": {
  663. "CreateDate": "2012-09-21T23:03:39Z",
  664. "UserName": "Anika"
  665. }
  666. },
  667. "comments": {
  668. "input": {
  669. },
  670. "output": {
  671. }
  672. },
  673. "description": "The following command gets information about the password for the IAM user named Anika.",
  674. "id": "d6b580cc-909f-4925-9caa-d425cbc1ad47",
  675. "title": "To get password information for an IAM user"
  676. }
  677. ],
  678. "GetOrganizationsAccessReport": [
  679. {
  680. "input": {
  681. "JobId": "examplea-1234-b567-cde8-90fg123abcd4"
  682. },
  683. "output": {
  684. "AccessDetails": [
  685. {
  686. "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333",
  687. "LastAuthenticatedTime": "2019-05-25T16:29:52Z",
  688. "Region": "us-east-1",
  689. "ServiceName": "Amazon DynamoDB",
  690. "ServiceNamespace": "dynamodb",
  691. "TotalAuthenticatedEntities": 2
  692. },
  693. {
  694. "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012",
  695. "LastAuthenticatedTime": "2019-06-15T13:12:06Z",
  696. "Region": "us-east-1",
  697. "ServiceName": "AWS Identity and Access Management",
  698. "ServiceNamespace": "iam",
  699. "TotalAuthenticatedEntities": 4
  700. },
  701. {
  702. "ServiceName": "Amazon Simple Storage Service",
  703. "ServiceNamespace": "s3",
  704. "TotalAuthenticatedEntities": 0
  705. }
  706. ],
  707. "IsTruncated": false,
  708. "JobCompletionDate": "2019-06-18T19:47:35.241Z",
  709. "JobCreationDate": "2019-06-18T19:47:31.466Z",
  710. "JobStatus": "COMPLETED",
  711. "NumberOfServicesAccessible": 3,
  712. "NumberOfServicesNotAccessed": 1
  713. },
  714. "comments": {
  715. "input": {
  716. },
  717. "output": {
  718. }
  719. },
  720. "description": "The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4",
  721. "id": "getorganizationsaccessreport-ou",
  722. "title": "To get details from a previously generated organizational unit report"
  723. }
  724. ],
  725. "GetRole": [
  726. {
  727. "input": {
  728. "RoleName": "Test-Role"
  729. },
  730. "output": {
  731. "Role": {
  732. "Arn": "arn:aws:iam::123456789012:role/Test-Role",
  733. "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
  734. "CreateDate": "2013-04-18T05:01:58Z",
  735. "MaxSessionDuration": 3600,
  736. "Path": "/",
  737. "RoleId": "AROADBQP57FF2AEXAMPLE",
  738. "RoleLastUsed": {
  739. "LastUsedDate": "2019-11-18T05:01:58Z",
  740. "Region": "us-east-1"
  741. },
  742. "RoleName": "Test-Role"
  743. }
  744. },
  745. "comments": {
  746. "input": {
  747. },
  748. "output": {
  749. }
  750. },
  751. "description": "The following command gets information about the role named Test-Role.",
  752. "id": "5b7d03a6-340c-472d-aa77-56425950d8b0",
  753. "title": "To get information about an IAM role"
  754. }
  755. ],
  756. "GetServiceLastAccessedDetails": [
  757. {
  758. "input": {
  759. "JobId": "examplef-1305-c245-eba4-71fe298bcda7"
  760. },
  761. "output": {
  762. "IsTruncated": false,
  763. "JobCompletionDate": "2018-10-24T19:47:35.241Z",
  764. "JobCreationDate": "2018-10-24T19:47:31.466Z",
  765. "JobStatus": "COMPLETED",
  766. "ServicesLastAccessed": [
  767. {
  768. "LastAuthenticated": "2018-10-24T19:11:00Z",
  769. "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01",
  770. "ServiceName": "AWS Identity and Access Management",
  771. "ServiceNamespace": "iam",
  772. "TotalAuthenticatedEntities": 2
  773. },
  774. {
  775. "ServiceName": "Amazon Simple Storage Service",
  776. "ServiceNamespace": "s3",
  777. "TotalAuthenticatedEntities": 0
  778. }
  779. ]
  780. },
  781. "comments": {
  782. "input": {
  783. },
  784. "output": {
  785. }
  786. },
  787. "description": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7",
  788. "id": "getserviceaccessdetails-policy-1541696298085",
  789. "title": "To get details from a previously-generated report"
  790. }
  791. ],
  792. "GetServiceLastAccessedDetailsWithEntities": [
  793. {
  794. "input": {
  795. "JobId": "examplef-1305-c245-eba4-71fe298bcda7",
  796. "ServiceNamespace": "iam"
  797. },
  798. "output": {
  799. "EntityDetailsList": [
  800. {
  801. "EntityInfo": {
  802. "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01",
  803. "Id": "AIDAEX2EXAMPLEB6IGCDC",
  804. "Name": "AWSExampleUser01",
  805. "Path": "/",
  806. "Type": "USER"
  807. },
  808. "LastAuthenticated": "2018-10-24T19:10:00Z"
  809. },
  810. {
  811. "EntityInfo": {
  812. "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01",
  813. "Id": "AROAEAEXAMPLEIANXSIU4",
  814. "Name": "AWSExampleRole01",
  815. "Path": "/",
  816. "Type": "ROLE"
  817. }
  818. }
  819. ],
  820. "IsTruncated": false,
  821. "JobCompletionDate": "2018-10-24T19:47:35.241Z",
  822. "JobCreationDate": "2018-10-24T19:47:31.466Z",
  823. "JobStatus": "COMPLETED"
  824. },
  825. "comments": {
  826. "input": {
  827. },
  828. "output": {
  829. }
  830. },
  831. "description": "The following operation returns details about the entities that attempted to access the IAM service.",
  832. "id": "getserviceaccessdetailsentity-policy-1541697621384",
  833. "title": "To get sntity details from a previously-generated report"
  834. }
  835. ],
  836. "GetUser": [
  837. {
  838. "input": {
  839. "UserName": "Bob"
  840. },
  841. "output": {
  842. "User": {
  843. "Arn": "arn:aws:iam::123456789012:user/Bob",
  844. "CreateDate": "2012-09-21T23:03:13Z",
  845. "Path": "/",
  846. "UserId": "AKIAIOSFODNN7EXAMPLE",
  847. "UserName": "Bob"
  848. }
  849. },
  850. "comments": {
  851. "input": {
  852. },
  853. "output": {
  854. }
  855. },
  856. "description": "The following command gets information about the IAM user named Bob.",
  857. "id": "ede000a1-9e4c-40db-bd0a-d4f95e41a6ab",
  858. "title": "To get information about an IAM user"
  859. }
  860. ],
  861. "ListAccessKeys": [
  862. {
  863. "input": {
  864. "UserName": "Alice"
  865. },
  866. "output": {
  867. "AccessKeyMetadata": [
  868. {
  869. "AccessKeyId": "AKIA111111111EXAMPLE",
  870. "CreateDate": "2016-12-01T22:19:58Z",
  871. "Status": "Active",
  872. "UserName": "Alice"
  873. },
  874. {
  875. "AccessKeyId": "AKIA222222222EXAMPLE",
  876. "CreateDate": "2016-12-01T22:20:01Z",
  877. "Status": "Active",
  878. "UserName": "Alice"
  879. }
  880. ]
  881. },
  882. "comments": {
  883. "input": {
  884. },
  885. "output": {
  886. }
  887. },
  888. "description": "The following command lists the access keys IDs for the IAM user named Alice.",
  889. "id": "15571463-ebea-411a-a021-1c76bd2a3625",
  890. "title": "To list the access key IDs for an IAM user"
  891. }
  892. ],
  893. "ListAccountAliases": [
  894. {
  895. "input": {
  896. },
  897. "output": {
  898. "AccountAliases": [
  899. "exmaple-corporation"
  900. ]
  901. },
  902. "comments": {
  903. "input": {
  904. },
  905. "output": {
  906. }
  907. },
  908. "description": "The following command lists the aliases for the current account.",
  909. "id": "e27b457a-16f9-4e05-a006-3df7b3472741",
  910. "title": "To list account aliases"
  911. }
  912. ],
  913. "ListGroupPolicies": [
  914. {
  915. "input": {
  916. "GroupName": "Admins"
  917. },
  918. "output": {
  919. "PolicyNames": [
  920. "AdminRoot",
  921. "KeyPolicy"
  922. ]
  923. },
  924. "comments": {
  925. "input": {
  926. },
  927. "output": {
  928. }
  929. },
  930. "description": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.",
  931. "id": "02de5095-2410-4d3a-ac1b-cc40234af68f",
  932. "title": "To list the in-line policies for an IAM group"
  933. }
  934. ],
  935. "ListGroups": [
  936. {
  937. "input": {
  938. },
  939. "output": {
  940. "Groups": [
  941. {
  942. "Arn": "arn:aws:iam::123456789012:group/Admins",
  943. "CreateDate": "2016-12-15T21:40:08.121Z",
  944. "GroupId": "AGPA1111111111EXAMPLE",
  945. "GroupName": "Admins",
  946. "Path": "/division_abc/subdivision_xyz/"
  947. },
  948. {
  949. "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
  950. "CreateDate": "2016-11-30T14:10:01.156Z",
  951. "GroupId": "AGP22222222222EXAMPLE",
  952. "GroupName": "Test",
  953. "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
  954. },
  955. {
  956. "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
  957. "CreateDate": "2016-06-12T20:14:52.032Z",
  958. "GroupId": "AGPI3333333333EXAMPLE",
  959. "GroupName": "Managers",
  960. "Path": "/division_abc/subdivision_xyz/product_1234/"
  961. }
  962. ]
  963. },
  964. "comments": {
  965. "input": {
  966. },
  967. "output": {
  968. }
  969. },
  970. "description": "The following command lists the IAM groups in the current account:",
  971. "id": "b3ab1380-2a21-42fb-8e85-503f65512c66",
  972. "title": "To list the IAM groups for the current account"
  973. }
  974. ],
  975. "ListGroupsForUser": [
  976. {
  977. "input": {
  978. "UserName": "Bob"
  979. },
  980. "output": {
  981. "Groups": [
  982. {
  983. "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
  984. "CreateDate": "2016-11-30T14:10:01.156Z",
  985. "GroupId": "AGP2111111111EXAMPLE",
  986. "GroupName": "Test",
  987. "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
  988. },
  989. {
  990. "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
  991. "CreateDate": "2016-06-12T20:14:52.032Z",
  992. "GroupId": "AGPI222222222SEXAMPLE",
  993. "GroupName": "Managers",
  994. "Path": "/division_abc/subdivision_xyz/product_1234/"
  995. }
  996. ]
  997. },
  998. "comments": {
  999. "input": {
  1000. },
  1001. "output": {
  1002. }
  1003. },
  1004. "description": "The following command displays the groups that the IAM user named Bob belongs to.",
  1005. "id": "278ec2ee-fc28-4136-83fb-433af0ae46a2",
  1006. "title": "To list the groups that an IAM user belongs to"
  1007. }
  1008. ],
  1009. "ListPoliciesGrantingServiceAccess": [
  1010. {
  1011. "input": {
  1012. "Arn": "arn:aws:iam::123456789012:user/ExampleUser01",
  1013. "ServiceNamespaces": [
  1014. "iam",
  1015. "ec2"
  1016. ]
  1017. },
  1018. "output": {
  1019. "IsTruncated": false,
  1020. "PoliciesGrantingServiceAccess": [
  1021. {
  1022. "Policies": [
  1023. {
  1024. "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy",
  1025. "PolicyName": "ExampleIamPolicy",
  1026. "PolicyType": "MANAGED"
  1027. },
  1028. {
  1029. "EntityName": "AWSExampleGroup1",
  1030. "EntityType": "GROUP",
  1031. "PolicyName": "ExampleGroup1Policy",
  1032. "PolicyType": "INLINE"
  1033. }
  1034. ],
  1035. "ServiceNamespace": "iam"
  1036. },
  1037. {
  1038. "Policies": [
  1039. {
  1040. "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy",
  1041. "PolicyName": "ExampleEc2Policy",
  1042. "PolicyType": "MANAGED"
  1043. }
  1044. ],
  1045. "ServiceNamespace": "ec2"
  1046. }
  1047. ]
  1048. },
  1049. "comments": {
  1050. "input": {
  1051. },
  1052. "output": {
  1053. }
  1054. },
  1055. "description": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.",
  1056. "id": "listpoliciesaccess-user-1541698749508",
  1057. "title": "To list policies that allow access to a service"
  1058. }
  1059. ],
  1060. "ListRoleTags": [
  1061. {
  1062. "input": {
  1063. "RoleName": "taggedrole1"
  1064. },
  1065. "output": {
  1066. "IsTruncated": false,
  1067. "Tags": [
  1068. {
  1069. "Key": "Dept",
  1070. "Value": "12345"
  1071. },
  1072. {
  1073. "Key": "Team",
  1074. "Value": "Accounting"
  1075. }
  1076. ]
  1077. },
  1078. "comments": {
  1079. "input": {
  1080. },
  1081. "output": {
  1082. }
  1083. },
  1084. "description": "The following example shows how to list the tags attached to a role.",
  1085. "id": "to-list-the-tags-attached-to-an-iam-role-1506719238376",
  1086. "title": "To list the tags attached to an IAM role"
  1087. }
  1088. ],
  1089. "ListSigningCertificates": [
  1090. {
  1091. "input": {
  1092. "UserName": "Bob"
  1093. },
  1094. "output": {
  1095. "Certificates": [
  1096. {
  1097. "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
  1098. "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
  1099. "Status": "Active",
  1100. "UploadDate": "2013-06-06T21:40:08Z",
  1101. "UserName": "Bob"
  1102. }
  1103. ]
  1104. },
  1105. "comments": {
  1106. "input": {
  1107. },
  1108. "output": {
  1109. }
  1110. },
  1111. "description": "The following command lists the signing certificates for the IAM user named Bob.",
  1112. "id": "b4c10256-4fc9-457e-b3fd-4a110d4d73dc",
  1113. "title": "To list the signing certificates for an IAM user"
  1114. }
  1115. ],
  1116. "ListUserTags": [
  1117. {
  1118. "input": {
  1119. "UserName": "anika"
  1120. },
  1121. "output": {
  1122. "IsTruncated": false,
  1123. "Tags": [
  1124. {
  1125. "Key": "Dept",
  1126. "Value": "12345"
  1127. },
  1128. {
  1129. "Key": "Team",
  1130. "Value": "Accounting"
  1131. }
  1132. ]
  1133. },
  1134. "comments": {
  1135. "input": {
  1136. },
  1137. "output": {
  1138. }
  1139. },
  1140. "description": "The following example shows how to list the tags attached to a user.",
  1141. "id": "to-list-the-tags-attached-to-an-iam-user-1506719473186",
  1142. "title": "To list the tags attached to an IAM user"
  1143. }
  1144. ],
  1145. "ListUsers": [
  1146. {
  1147. "input": {
  1148. },
  1149. "output": {
  1150. "Users": [
  1151. {
  1152. "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan",
  1153. "CreateDate": "2012-09-05T19:38:48Z",
  1154. "PasswordLastUsed": "2016-09-08T21:47:36Z",
  1155. "Path": "/division_abc/subdivision_xyz/engineering/",
  1156. "UserId": "AID2MAB8DPLSRHEXAMPLE",
  1157. "UserName": "Juan"
  1158. },
  1159. {
  1160. "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika",
  1161. "CreateDate": "2014-04-09T15:43:45Z",
  1162. "PasswordLastUsed": "2016-09-24T16:18:07Z",
  1163. "Path": "/division_abc/subdivision_xyz/engineering/",
  1164. "UserId": "AIDIODR4TAW7CSEXAMPLE",
  1165. "UserName": "Anika"
  1166. }
  1167. ]
  1168. },
  1169. "comments": {
  1170. "input": {
  1171. },
  1172. "output": {
  1173. }
  1174. },
  1175. "description": "The following command lists the IAM users in the current account.",
  1176. "id": "9edfbd73-03d8-4d8a-9a79-76c85e8c8298",
  1177. "title": "To list IAM users"
  1178. }
  1179. ],
  1180. "ListVirtualMFADevices": [
  1181. {
  1182. "input": {
  1183. },
  1184. "output": {
  1185. "VirtualMFADevices": [
  1186. {
  1187. "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice"
  1188. },
  1189. {
  1190. "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan"
  1191. }
  1192. ]
  1193. },
  1194. "comments": {
  1195. "input": {
  1196. },
  1197. "output": {
  1198. }
  1199. },
  1200. "description": "The following command lists the virtual MFA devices that have been configured for the current account.",
  1201. "id": "54f9ac18-5100-4070-bec4-fe5f612710d5",
  1202. "title": "To list virtual MFA devices"
  1203. }
  1204. ],
  1205. "PutGroupPolicy": [
  1206. {
  1207. "input": {
  1208. "GroupName": "Admins",
  1209. "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
  1210. "PolicyName": "AllPerms"
  1211. },
  1212. "comments": {
  1213. "input": {
  1214. },
  1215. "output": {
  1216. }
  1217. },
  1218. "description": "The following command adds a policy named AllPerms to the IAM group named Admins.",
  1219. "id": "4bc17418-758f-4d0f-ab0c-4d00265fec2e",
  1220. "title": "To add a policy to a group"
  1221. }
  1222. ],
  1223. "PutRolePolicy": [
  1224. {
  1225. "input": {
  1226. "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}",
  1227. "PolicyName": "S3AccessPolicy",
  1228. "RoleName": "S3Access"
  1229. },
  1230. "comments": {
  1231. "input": {
  1232. },
  1233. "output": {
  1234. }
  1235. },
  1236. "description": "The following command adds a permissions policy to the role named Test-Role.",
  1237. "id": "de62fd00-46c7-4601-9e0d-71d5fbb11ecb",
  1238. "title": "To attach a permissions policy to an IAM role"
  1239. }
  1240. ],
  1241. "PutUserPolicy": [
  1242. {
  1243. "input": {
  1244. "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
  1245. "PolicyName": "AllAccessPolicy",
  1246. "UserName": "Bob"
  1247. },
  1248. "comments": {
  1249. "input": {
  1250. },
  1251. "output": {
  1252. }
  1253. },
  1254. "description": "The following command attaches a policy to the IAM user named Bob.",
  1255. "id": "2551ffc6-3576-4d39-823f-30b60bffc2c7",
  1256. "title": "To attach a policy to an IAM user"
  1257. }
  1258. ],
  1259. "RemoveRoleFromInstanceProfile": [
  1260. {
  1261. "input": {
  1262. "InstanceProfileName": "ExampleInstanceProfile",
  1263. "RoleName": "Test-Role"
  1264. },
  1265. "comments": {
  1266. "input": {
  1267. },
  1268. "output": {
  1269. }
  1270. },
  1271. "description": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.",
  1272. "id": "6d9f46f1-9f4a-4873-b403-51a85c5c627c",
  1273. "title": "To remove a role from an instance profile"
  1274. }
  1275. ],
  1276. "RemoveUserFromGroup": [
  1277. {
  1278. "input": {
  1279. "GroupName": "Admins",
  1280. "UserName": "Bob"
  1281. },
  1282. "comments": {
  1283. "input": {
  1284. },
  1285. "output": {
  1286. }
  1287. },
  1288. "description": "The following command removes the user named Bob from the IAM group named Admins.",
  1289. "id": "fb54d5b4-0caf-41d8-af0e-10a84413f174",
  1290. "title": "To remove a user from an IAM group"
  1291. }
  1292. ],
  1293. "SetSecurityTokenServicePreferences": [
  1294. {
  1295. "input": {
  1296. "GlobalEndpointTokenVersion": "v2Token"
  1297. },
  1298. "comments": {
  1299. "input": {
  1300. },
  1301. "output": {
  1302. }
  1303. },
  1304. "description": "The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.",
  1305. "id": "61a785a7-d30a-415a-ae18-ab9236e56871",
  1306. "title": "To delete an access key for an IAM user"
  1307. }
  1308. ],
  1309. "TagRole": [
  1310. {
  1311. "input": {
  1312. "RoleName": "taggedrole",
  1313. "Tags": [
  1314. {
  1315. "Key": "Dept",
  1316. "Value": "Accounting"
  1317. },
  1318. {
  1319. "Key": "CostCenter",
  1320. "Value": "12345"
  1321. }
  1322. ]
  1323. },
  1324. "comments": {
  1325. "input": {
  1326. },
  1327. "output": {
  1328. }
  1329. },
  1330. "description": "The following example shows how to add tags to an existing role.",
  1331. "id": "to-add-a-tag-key-and-value-to-an-iam-role-1506718791513",
  1332. "title": "To add a tag key and value to an IAM role"
  1333. }
  1334. ],
  1335. "TagUser": [
  1336. {
  1337. "input": {
  1338. "Tags": [
  1339. {
  1340. "Key": "Dept",
  1341. "Value": "Accounting"
  1342. },
  1343. {
  1344. "Key": "CostCenter",
  1345. "Value": "12345"
  1346. }
  1347. ],
  1348. "UserName": "anika"
  1349. },
  1350. "comments": {
  1351. "input": {
  1352. },
  1353. "output": {
  1354. }
  1355. },
  1356. "description": "The following example shows how to add tags to an existing user.",
  1357. "id": "to-add-a-tag-key-and-value-to-an-iam-user-1506719044227",
  1358. "title": "To add a tag key and value to an IAM user"
  1359. }
  1360. ],
  1361. "UntagRole": [
  1362. {
  1363. "input": {
  1364. "RoleName": "taggedrole",
  1365. "TagKeys": [
  1366. "Dept"
  1367. ]
  1368. },
  1369. "comments": {
  1370. "input": {
  1371. },
  1372. "output": {
  1373. }
  1374. },
  1375. "description": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.",
  1376. "id": "to-remove-a-tag-from-an-iam-role-1506719589943",
  1377. "title": "To remove a tag from an IAM role"
  1378. }
  1379. ],
  1380. "UntagUser": [
  1381. {
  1382. "input": {
  1383. "TagKeys": [
  1384. "Dept"
  1385. ],
  1386. "UserName": "anika"
  1387. },
  1388. "comments": {
  1389. "input": {
  1390. },
  1391. "output": {
  1392. }
  1393. },
  1394. "description": "The following example shows how to remove tags that are attached to a user named 'anika'.",
  1395. "id": "to-remove-a-tag-from-an-iam-user-1506719725554",
  1396. "title": "To remove a tag from an IAM user"
  1397. }
  1398. ],
  1399. "UpdateAccessKey": [
  1400. {
  1401. "input": {
  1402. "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
  1403. "Status": "Inactive",
  1404. "UserName": "Bob"
  1405. },
  1406. "comments": {
  1407. "input": {
  1408. },
  1409. "output": {
  1410. }
  1411. },
  1412. "description": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.",
  1413. "id": "02b556fd-e673-49b7-ab6b-f2f9035967d0",
  1414. "title": "To activate or deactivate an access key for an IAM user"
  1415. }
  1416. ],
  1417. "UpdateAccountPasswordPolicy": [
  1418. {
  1419. "input": {
  1420. "MinimumPasswordLength": 8,
  1421. "RequireNumbers": true
  1422. },
  1423. "comments": {
  1424. "input": {
  1425. },
  1426. "output": {
  1427. }
  1428. },
  1429. "description": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:",
  1430. "id": "c263a1af-37dc-4423-8dba-9790284ef5e0",
  1431. "title": "To set or change the current account password policy"
  1432. }
  1433. ],
  1434. "UpdateAssumeRolePolicy": [
  1435. {
  1436. "input": {
  1437. "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}",
  1438. "RoleName": "S3AccessForEC2Instances"
  1439. },
  1440. "comments": {
  1441. "input": {
  1442. },
  1443. "output": {
  1444. }
  1445. },
  1446. "description": "The following command updates the role trust policy for the role named Test-Role:",
  1447. "id": "c9150063-d953-4e99-9576-9685872006c6",
  1448. "title": "To update the trust policy for an IAM role"
  1449. }
  1450. ],
  1451. "UpdateGroup": [
  1452. {
  1453. "input": {
  1454. "GroupName": "Test",
  1455. "NewGroupName": "Test-1"
  1456. },
  1457. "comments": {
  1458. "input": {
  1459. },
  1460. "output": {
  1461. }
  1462. },
  1463. "description": "The following command changes the name of the IAM group Test to Test-1.",
  1464. "id": "f0cf1662-91ae-4278-a80e-7db54256ccba",
  1465. "title": "To rename an IAM group"
  1466. }
  1467. ],
  1468. "UpdateLoginProfile": [
  1469. {
  1470. "input": {
  1471. "Password": "SomeKindOfPassword123!@#",
  1472. "UserName": "Bob"
  1473. },
  1474. "comments": {
  1475. "input": {
  1476. },
  1477. "output": {
  1478. }
  1479. },
  1480. "description": "The following command creates or changes the password for the IAM user named Bob.",
  1481. "id": "036d9498-ecdb-4ed6-a8d8-366c383d1487",
  1482. "title": "To change the password for an IAM user"
  1483. }
  1484. ],
  1485. "UpdateSigningCertificate": [
  1486. {
  1487. "input": {
  1488. "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
  1489. "Status": "Inactive",
  1490. "UserName": "Bob"
  1491. },
  1492. "comments": {
  1493. "input": {
  1494. },
  1495. "output": {
  1496. }
  1497. },
  1498. "description": "The following command changes the status of a signing certificate for a user named Bob to Inactive.",
  1499. "id": "829aee7b-efc5-4b3b-84a5-7f899b38018d",
  1500. "title": "To change the active status of a signing certificate for an IAM user"
  1501. }
  1502. ],
  1503. "UpdateUser": [
  1504. {
  1505. "input": {
  1506. "NewUserName": "Robert",
  1507. "UserName": "Bob"
  1508. },
  1509. "comments": {
  1510. "input": {
  1511. },
  1512. "output": {
  1513. }
  1514. },
  1515. "description": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.",
  1516. "id": "275d53ed-347a-44e6-b7d0-a96276154352",
  1517. "title": "To change an IAM user's name"
  1518. }
  1519. ],
  1520. "UploadServerCertificate": [
  1521. {
  1522. "input": {
  1523. "CertificateBody": "-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----",
  1524. "Path": "/company/servercerts/",
  1525. "PrivateKey": "-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----",
  1526. "ServerCertificateName": "ProdServerCert"
  1527. },
  1528. "output": {
  1529. "ServerCertificateMetadata": {
  1530. "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert",
  1531. "Expiration": "2012-05-08T01:02:03.004Z",
  1532. "Path": "/company/servercerts/",
  1533. "ServerCertificateId": "ASCA1111111111EXAMPLE",
  1534. "ServerCertificateName": "ProdServerCert",
  1535. "UploadDate": "2010-05-08T01:02:03.004Z"
  1536. }
  1537. },
  1538. "comments": {
  1539. "input": {
  1540. },
  1541. "output": {
  1542. }
  1543. },
  1544. "description": "The following upload-server-certificate command uploads a server certificate to your AWS account:",
  1545. "id": "06eab6d1-ebf2-4bd9-839d-f7508b9a38b6",
  1546. "title": "To upload a server certificate to your AWS account"
  1547. }
  1548. ],
  1549. "UploadSigningCertificate": [
  1550. {
  1551. "input": {
  1552. "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
  1553. "UserName": "Bob"
  1554. },
  1555. "output": {
  1556. "Certificate": {
  1557. "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
  1558. "CertificateId": "ID123456789012345EXAMPLE",
  1559. "Status": "Active",
  1560. "UploadDate": "2015-06-06T21:40:08.121Z",
  1561. "UserName": "Bob"
  1562. }
  1563. },
  1564. "comments": {
  1565. "input": {
  1566. },
  1567. "output": {
  1568. }
  1569. },
  1570. "description": "The following command uploads a signing certificate for the IAM user named Bob.",
  1571. "id": "e67489b6-7b73-4e30-9ed3-9a9e0231e458",
  1572. "title": "To upload a signing certificate for an IAM user"
  1573. }
  1574. ]
  1575. }
  1576. }