12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577 |
- {
- "version": "1.0",
- "examples": {
- "AddClientIDToOpenIDConnectProvider": [
- {
- "input": {
- "ClientID": "my-application-ID",
- "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "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:",
- "id": "028e91f4-e2a6-4d59-9e3b-4965a3fb19be",
- "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider"
- }
- ],
- "AddRoleToInstanceProfile": [
- {
- "input": {
- "InstanceProfileName": "Webserver",
- "RoleName": "S3Access"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command adds the role named S3Access to the instance profile named Webserver:",
- "id": "c107fac3-edb6-4827-8a71-8863ec91c81f",
- "title": "To add a role to an instance profile"
- }
- ],
- "AddUserToGroup": [
- {
- "input": {
- "GroupName": "Admins",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command adds an IAM user named Bob to the IAM group named Admins:",
- "id": "619c7e6b-09f8-4036-857b-51a6ea5027ca",
- "title": "To add a user to an IAM group"
- }
- ],
- "AttachGroupPolicy": [
- {
- "input": {
- "GroupName": "Finance",
- "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.",
- "id": "87551489-86f0-45db-9889-759936778f2b",
- "title": "To attach a managed policy to an IAM group"
- }
- ],
- "AttachRolePolicy": [
- {
- "input": {
- "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess",
- "RoleName": "ReadOnlyRole"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.",
- "id": "3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e",
- "title": "To attach a managed policy to an IAM role"
- }
- ],
- "AttachUserPolicy": [
- {
- "input": {
- "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess",
- "UserName": "Alice"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.",
- "id": "1372ebd8-9475-4b1a-a479-23b6fd4b8b3e",
- "title": "To attach a managed policy to an IAM user"
- }
- ],
- "ChangePassword": [
- {
- "input": {
- "NewPassword": "]35d/{pB9Fo9wJ",
- "OldPassword": "3s0K_;xh4~8XXI"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command changes the password for the current IAM user.",
- "id": "3a80c66f-bffb-46df-947c-1e8fa583b470",
- "title": "To change the password for your IAM user"
- }
- ],
- "CreateAccessKey": [
- {
- "input": {
- "UserName": "Bob"
- },
- "output": {
- "AccessKey": {
- "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
- "CreateDate": "2015-03-09T18:39:23.411Z",
- "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
- "Status": "Active",
- "UserName": "Bob"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.",
- "id": "1fbb3211-4cf2-41db-8c20-ba58d9f5802d",
- "title": "To create an access key for an IAM user"
- }
- ],
- "CreateAccountAlias": [
- {
- "input": {
- "AccountAlias": "examplecorp"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command associates the alias examplecorp to your AWS account.",
- "id": "5adaf6fb-94fc-4ca2-b825-2fbc2062add1",
- "title": "To create an account alias"
- }
- ],
- "CreateGroup": [
- {
- "input": {
- "GroupName": "Admins"
- },
- "output": {
- "Group": {
- "Arn": "arn:aws:iam::123456789012:group/Admins",
- "CreateDate": "2015-03-09T20:30:24.940Z",
- "GroupId": "AIDGPMS9RO4H3FEXAMPLE",
- "GroupName": "Admins",
- "Path": "/"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command creates an IAM group named Admins.",
- "id": "d5da2a90-5e69-4ef7-8ae8-4c33dc21fd21",
- "title": "To create an IAM group"
- }
- ],
- "CreateInstanceProfile": [
- {
- "input": {
- "InstanceProfileName": "Webserver"
- },
- "output": {
- "InstanceProfile": {
- "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver",
- "CreateDate": "2015-03-09T20:33:19.626Z",
- "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE",
- "InstanceProfileName": "Webserver",
- "Path": "/",
- "Roles": [
- ]
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "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.",
- "id": "5d84e6ae-5921-4e39-8454-10232cd9ff9a",
- "title": "To create an instance profile"
- }
- ],
- "CreateLoginProfile": [
- {
- "input": {
- "Password": "h]6EszR}vJ*m",
- "PasswordResetRequired": true,
- "UserName": "Bob"
- },
- "output": {
- "LoginProfile": {
- "CreateDate": "2015-03-10T20:55:40.274Z",
- "PasswordResetRequired": true,
- "UserName": "Bob"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "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.",
- "id": "c63795bc-3444-40b3-89df-83c474ef88be",
- "title": "To create an instance profile"
- }
- ],
- "CreateOpenIDConnectProvider": [
- {
- "input": {
- "ClientIDList": [
- "my-application-id"
- ],
- "ThumbprintList": [
- "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE"
- ],
- "Url": "https://server.example.com"
- },
- "output": {
- "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "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.",
- "id": "4e4a6bff-cc97-4406-922e-0ab4a82cdb63",
- "title": "To create an instance profile"
- }
- ],
- "CreateRole": [
- {
- "input": {
- "AssumeRolePolicyDocument": "<Stringified-JSON>",
- "Path": "/",
- "RoleName": "Test-Role"
- },
- "output": {
- "Role": {
- "Arn": "arn:aws:iam::123456789012:role/Test-Role",
- "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
- "CreateDate": "2013-06-07T20:43:32.821Z",
- "Path": "/",
- "RoleId": "AKIAIOSFODNN7EXAMPLE",
- "RoleName": "Test-Role"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "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.",
- "id": "eaaa4b5f-51f1-4f73-b0d3-30127040eff8",
- "title": "To create an IAM role"
- }
- ],
- "CreateUser": [
- {
- "input": {
- "UserName": "Bob"
- },
- "output": {
- "User": {
- "Arn": "arn:aws:iam::123456789012:user/Bob",
- "CreateDate": "2013-06-08T03:20:41.270Z",
- "Path": "/",
- "UserId": "AKIAIOSFODNN7EXAMPLE",
- "UserName": "Bob"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following create-user command creates an IAM user named Bob in the current account.",
- "id": "eb15f90b-e5f5-4af8-a594-e4e82b181a62",
- "title": "To create an IAM user"
- }
- ],
- "DeleteAccessKey": [
- {
- "input": {
- "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.",
- "id": "61a785a7-d30a-415a-ae18-ab9236e56871",
- "title": "To delete an access key for an IAM user"
- }
- ],
- "DeleteAccountAlias": [
- {
- "input": {
- "AccountAlias": "mycompany"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the alias mycompany from the current AWS account:",
- "id": "7abeca65-04a8-4500-a890-47f1092bf766",
- "title": "To delete an account alias"
- }
- ],
- "DeleteAccountPasswordPolicy": [
- {
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the password policy from the current AWS account:",
- "id": "9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf",
- "title": "To delete the current account password policy"
- }
- ],
- "DeleteGroupPolicy": [
- {
- "input": {
- "GroupName": "Admins",
- "PolicyName": "ExamplePolicy"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command deletes the policy named ExamplePolicy from the group named Admins:",
- "id": "e683f2bd-98a4-4fe0-bb66-33169c692d4a",
- "title": "To delete a policy from an IAM group"
- }
- ],
- "DeleteInstanceProfile": [
- {
- "input": {
- "InstanceProfileName": "ExampleInstanceProfile"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command deletes the instance profile named ExampleInstanceProfile",
- "id": "12d74fb8-3433-49db-8171-a1fc764e354d",
- "title": "To delete an instance profile"
- }
- ],
- "DeleteLoginProfile": [
- {
- "input": {
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command deletes the password for the IAM user named Bob.",
- "id": "1fe57059-fc73-42e2-b992-517b7d573b5c",
- "title": "To delete a password for an IAM user"
- }
- ],
- "DeleteRole": [
- {
- "input": {
- "RoleName": "Test-Role"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the role named Test-Role.",
- "id": "053cdf74-9bda-44b8-bdbb-140fd5a32603",
- "title": "To delete an IAM role"
- }
- ],
- "DeleteRolePolicy": [
- {
- "input": {
- "PolicyName": "ExamplePolicy",
- "RoleName": "Test-Role"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the policy named ExamplePolicy from the role named Test-Role.",
- "id": "9c667336-fde3-462c-b8f3-950800821e27",
- "title": "To remove a policy from an IAM role"
- }
- ],
- "DeleteSigningCertificate": [
- {
- "input": {
- "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
- "UserName": "Anika"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command deletes the specified signing certificate for the IAM user named Anika.",
- "id": "e3357586-ba9c-4070-b35b-d1a899b71987",
- "title": "To delete a signing certificate for an IAM user"
- }
- ],
- "DeleteUser": [
- {
- "input": {
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the IAM user named Bob from the current account.",
- "id": "a13dc3f9-59fe-42d9-abbb-fb98b204fdf0",
- "title": "To delete an IAM user"
- }
- ],
- "DeleteUserPolicy": [
- {
- "input": {
- "PolicyName": "ExamplePolicy",
- "UserName": "Juan"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:",
- "id": "34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8",
- "title": "To remove a policy from an IAM user"
- }
- ],
- "DeleteVirtualMFADevice": [
- {
- "input": {
- "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.",
- "id": "2933b08b-dbe7-4b89-b8c1-fdf75feea1ee",
- "title": "To remove a virtual MFA device"
- }
- ],
- "GenerateOrganizationsAccessReport": [
- {
- "input": {
- "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example"
- },
- "output": {
- "JobId": "examplea-1234-b567-cde8-90fg123abcd4"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following operation generates a report for the organizational unit ou-rge0-awexample",
- "id": "generateorganizationsaccessreport-ou",
- "title": "To generate a service last accessed data report for an organizational unit"
- }
- ],
- "GenerateServiceLastAccessedDetails": [
- {
- "input": {
- "Arn": "arn:aws:iam::123456789012:policy/ExamplePolicy1"
- },
- "output": {
- "JobId": "examplef-1305-c245-eba4-71fe298bcda7"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following operation generates a report for the policy: ExamplePolicy1",
- "id": "generateaccessdata-policy-1541695178514",
- "title": "To generate a service last accessed data report for a policy"
- }
- ],
- "GetAccountPasswordPolicy": [
- {
- "output": {
- "PasswordPolicy": {
- "AllowUsersToChangePassword": false,
- "ExpirePasswords": false,
- "HardExpiry": false,
- "MaxPasswordAge": 90,
- "MinimumPasswordLength": 8,
- "PasswordReusePrevention": 12,
- "RequireLowercaseCharacters": false,
- "RequireNumbers": true,
- "RequireSymbols": true,
- "RequireUppercaseCharacters": false
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command displays details about the password policy for the current AWS account.",
- "id": "5e4598c7-c425-431f-8af1-19073b3c4a5f",
- "title": "To see the current account password policy"
- }
- ],
- "GetAccountSummary": [
- {
- "output": {
- "SummaryMap": {
- "AccessKeysPerUserQuota": 2,
- "AccountAccessKeysPresent": 1,
- "AccountMFAEnabled": 0,
- "AccountSigningCertificatesPresent": 0,
- "AttachedPoliciesPerGroupQuota": 10,
- "AttachedPoliciesPerRoleQuota": 10,
- "AttachedPoliciesPerUserQuota": 10,
- "GlobalEndpointTokenVersion": 2,
- "GroupPolicySizeQuota": 5120,
- "Groups": 15,
- "GroupsPerUserQuota": 10,
- "GroupsQuota": 100,
- "MFADevices": 6,
- "MFADevicesInUse": 3,
- "Policies": 8,
- "PoliciesQuota": 1000,
- "PolicySizeQuota": 5120,
- "PolicyVersionsInUse": 22,
- "PolicyVersionsInUseQuota": 10000,
- "ServerCertificates": 1,
- "ServerCertificatesQuota": 20,
- "SigningCertificatesPerUserQuota": 2,
- "UserPolicySizeQuota": 2048,
- "Users": 27,
- "UsersQuota": 5000,
- "VersionsPerPolicyQuota": 5
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command returns information about the IAM entity quotas and usage in the current AWS account.",
- "id": "9d8447af-f344-45de-8219-2cebc3cce7f2",
- "title": "To get information about IAM entity quotas and usage in the current account"
- }
- ],
- "GetInstanceProfile": [
- {
- "input": {
- "InstanceProfileName": "ExampleInstanceProfile"
- },
- "output": {
- "InstanceProfile": {
- "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile",
- "CreateDate": "2013-06-12T23:52:02Z",
- "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE",
- "InstanceProfileName": "ExampleInstanceProfile",
- "Path": "/",
- "Roles": [
- {
- "Arn": "arn:aws:iam::336924118301:role/Test-Role",
- "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
- "CreateDate": "2013-01-09T06:33:26Z",
- "Path": "/",
- "RoleId": "AIDGPMS9RO4H3FEXAMPLE",
- "RoleName": "Test-Role"
- }
- ]
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command gets information about the instance profile named ExampleInstanceProfile.",
- "id": "463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7",
- "title": "To get information about an instance profile"
- }
- ],
- "GetLoginProfile": [
- {
- "input": {
- "UserName": "Anika"
- },
- "output": {
- "LoginProfile": {
- "CreateDate": "2012-09-21T23:03:39Z",
- "UserName": "Anika"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command gets information about the password for the IAM user named Anika.",
- "id": "d6b580cc-909f-4925-9caa-d425cbc1ad47",
- "title": "To get password information for an IAM user"
- }
- ],
- "GetOrganizationsAccessReport": [
- {
- "input": {
- "JobId": "examplea-1234-b567-cde8-90fg123abcd4"
- },
- "output": {
- "AccessDetails": [
- {
- "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333",
- "LastAuthenticatedTime": "2019-05-25T16:29:52Z",
- "Region": "us-east-1",
- "ServiceName": "Amazon DynamoDB",
- "ServiceNamespace": "dynamodb",
- "TotalAuthenticatedEntities": 2
- },
- {
- "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012",
- "LastAuthenticatedTime": "2019-06-15T13:12:06Z",
- "Region": "us-east-1",
- "ServiceName": "AWS Identity and Access Management",
- "ServiceNamespace": "iam",
- "TotalAuthenticatedEntities": 4
- },
- {
- "ServiceName": "Amazon Simple Storage Service",
- "ServiceNamespace": "s3",
- "TotalAuthenticatedEntities": 0
- }
- ],
- "IsTruncated": false,
- "JobCompletionDate": "2019-06-18T19:47:35.241Z",
- "JobCreationDate": "2019-06-18T19:47:31.466Z",
- "JobStatus": "COMPLETED",
- "NumberOfServicesAccessible": 3,
- "NumberOfServicesNotAccessed": 1
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4",
- "id": "getorganizationsaccessreport-ou",
- "title": "To get details from a previously generated organizational unit report"
- }
- ],
- "GetRole": [
- {
- "input": {
- "RoleName": "Test-Role"
- },
- "output": {
- "Role": {
- "Arn": "arn:aws:iam::123456789012:role/Test-Role",
- "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
- "CreateDate": "2013-04-18T05:01:58Z",
- "MaxSessionDuration": 3600,
- "Path": "/",
- "RoleId": "AROADBQP57FF2AEXAMPLE",
- "RoleLastUsed": {
- "LastUsedDate": "2019-11-18T05:01:58Z",
- "Region": "us-east-1"
- },
- "RoleName": "Test-Role"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command gets information about the role named Test-Role.",
- "id": "5b7d03a6-340c-472d-aa77-56425950d8b0",
- "title": "To get information about an IAM role"
- }
- ],
- "GetServiceLastAccessedDetails": [
- {
- "input": {
- "JobId": "examplef-1305-c245-eba4-71fe298bcda7"
- },
- "output": {
- "IsTruncated": false,
- "JobCompletionDate": "2018-10-24T19:47:35.241Z",
- "JobCreationDate": "2018-10-24T19:47:31.466Z",
- "JobStatus": "COMPLETED",
- "ServicesLastAccessed": [
- {
- "LastAuthenticated": "2018-10-24T19:11:00Z",
- "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01",
- "ServiceName": "AWS Identity and Access Management",
- "ServiceNamespace": "iam",
- "TotalAuthenticatedEntities": 2
- },
- {
- "ServiceName": "Amazon Simple Storage Service",
- "ServiceNamespace": "s3",
- "TotalAuthenticatedEntities": 0
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7",
- "id": "getserviceaccessdetails-policy-1541696298085",
- "title": "To get details from a previously-generated report"
- }
- ],
- "GetServiceLastAccessedDetailsWithEntities": [
- {
- "input": {
- "JobId": "examplef-1305-c245-eba4-71fe298bcda7",
- "ServiceNamespace": "iam"
- },
- "output": {
- "EntityDetailsList": [
- {
- "EntityInfo": {
- "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01",
- "Id": "AIDAEX2EXAMPLEB6IGCDC",
- "Name": "AWSExampleUser01",
- "Path": "/",
- "Type": "USER"
- },
- "LastAuthenticated": "2018-10-24T19:10:00Z"
- },
- {
- "EntityInfo": {
- "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01",
- "Id": "AROAEAEXAMPLEIANXSIU4",
- "Name": "AWSExampleRole01",
- "Path": "/",
- "Type": "ROLE"
- }
- }
- ],
- "IsTruncated": false,
- "JobCompletionDate": "2018-10-24T19:47:35.241Z",
- "JobCreationDate": "2018-10-24T19:47:31.466Z",
- "JobStatus": "COMPLETED"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following operation returns details about the entities that attempted to access the IAM service.",
- "id": "getserviceaccessdetailsentity-policy-1541697621384",
- "title": "To get sntity details from a previously-generated report"
- }
- ],
- "GetUser": [
- {
- "input": {
- "UserName": "Bob"
- },
- "output": {
- "User": {
- "Arn": "arn:aws:iam::123456789012:user/Bob",
- "CreateDate": "2012-09-21T23:03:13Z",
- "Path": "/",
- "UserId": "AKIAIOSFODNN7EXAMPLE",
- "UserName": "Bob"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command gets information about the IAM user named Bob.",
- "id": "ede000a1-9e4c-40db-bd0a-d4f95e41a6ab",
- "title": "To get information about an IAM user"
- }
- ],
- "ListAccessKeys": [
- {
- "input": {
- "UserName": "Alice"
- },
- "output": {
- "AccessKeyMetadata": [
- {
- "AccessKeyId": "AKIA111111111EXAMPLE",
- "CreateDate": "2016-12-01T22:19:58Z",
- "Status": "Active",
- "UserName": "Alice"
- },
- {
- "AccessKeyId": "AKIA222222222EXAMPLE",
- "CreateDate": "2016-12-01T22:20:01Z",
- "Status": "Active",
- "UserName": "Alice"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the access keys IDs for the IAM user named Alice.",
- "id": "15571463-ebea-411a-a021-1c76bd2a3625",
- "title": "To list the access key IDs for an IAM user"
- }
- ],
- "ListAccountAliases": [
- {
- "input": {
- },
- "output": {
- "AccountAliases": [
- "exmaple-corporation"
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the aliases for the current account.",
- "id": "e27b457a-16f9-4e05-a006-3df7b3472741",
- "title": "To list account aliases"
- }
- ],
- "ListGroupPolicies": [
- {
- "input": {
- "GroupName": "Admins"
- },
- "output": {
- "PolicyNames": [
- "AdminRoot",
- "KeyPolicy"
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.",
- "id": "02de5095-2410-4d3a-ac1b-cc40234af68f",
- "title": "To list the in-line policies for an IAM group"
- }
- ],
- "ListGroups": [
- {
- "input": {
- },
- "output": {
- "Groups": [
- {
- "Arn": "arn:aws:iam::123456789012:group/Admins",
- "CreateDate": "2016-12-15T21:40:08.121Z",
- "GroupId": "AGPA1111111111EXAMPLE",
- "GroupName": "Admins",
- "Path": "/division_abc/subdivision_xyz/"
- },
- {
- "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
- "CreateDate": "2016-11-30T14:10:01.156Z",
- "GroupId": "AGP22222222222EXAMPLE",
- "GroupName": "Test",
- "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
- },
- {
- "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
- "CreateDate": "2016-06-12T20:14:52.032Z",
- "GroupId": "AGPI3333333333EXAMPLE",
- "GroupName": "Managers",
- "Path": "/division_abc/subdivision_xyz/product_1234/"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the IAM groups in the current account:",
- "id": "b3ab1380-2a21-42fb-8e85-503f65512c66",
- "title": "To list the IAM groups for the current account"
- }
- ],
- "ListGroupsForUser": [
- {
- "input": {
- "UserName": "Bob"
- },
- "output": {
- "Groups": [
- {
- "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
- "CreateDate": "2016-11-30T14:10:01.156Z",
- "GroupId": "AGP2111111111EXAMPLE",
- "GroupName": "Test",
- "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
- },
- {
- "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
- "CreateDate": "2016-06-12T20:14:52.032Z",
- "GroupId": "AGPI222222222SEXAMPLE",
- "GroupName": "Managers",
- "Path": "/division_abc/subdivision_xyz/product_1234/"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command displays the groups that the IAM user named Bob belongs to.",
- "id": "278ec2ee-fc28-4136-83fb-433af0ae46a2",
- "title": "To list the groups that an IAM user belongs to"
- }
- ],
- "ListPoliciesGrantingServiceAccess": [
- {
- "input": {
- "Arn": "arn:aws:iam::123456789012:user/ExampleUser01",
- "ServiceNamespaces": [
- "iam",
- "ec2"
- ]
- },
- "output": {
- "IsTruncated": false,
- "PoliciesGrantingServiceAccess": [
- {
- "Policies": [
- {
- "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy",
- "PolicyName": "ExampleIamPolicy",
- "PolicyType": "MANAGED"
- },
- {
- "EntityName": "AWSExampleGroup1",
- "EntityType": "GROUP",
- "PolicyName": "ExampleGroup1Policy",
- "PolicyType": "INLINE"
- }
- ],
- "ServiceNamespace": "iam"
- },
- {
- "Policies": [
- {
- "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy",
- "PolicyName": "ExampleEc2Policy",
- "PolicyType": "MANAGED"
- }
- ],
- "ServiceNamespace": "ec2"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.",
- "id": "listpoliciesaccess-user-1541698749508",
- "title": "To list policies that allow access to a service"
- }
- ],
- "ListRoleTags": [
- {
- "input": {
- "RoleName": "taggedrole1"
- },
- "output": {
- "IsTruncated": false,
- "Tags": [
- {
- "Key": "Dept",
- "Value": "12345"
- },
- {
- "Key": "Team",
- "Value": "Accounting"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following example shows how to list the tags attached to a role.",
- "id": "to-list-the-tags-attached-to-an-iam-role-1506719238376",
- "title": "To list the tags attached to an IAM role"
- }
- ],
- "ListSigningCertificates": [
- {
- "input": {
- "UserName": "Bob"
- },
- "output": {
- "Certificates": [
- {
- "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
- "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
- "Status": "Active",
- "UploadDate": "2013-06-06T21:40:08Z",
- "UserName": "Bob"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the signing certificates for the IAM user named Bob.",
- "id": "b4c10256-4fc9-457e-b3fd-4a110d4d73dc",
- "title": "To list the signing certificates for an IAM user"
- }
- ],
- "ListUserTags": [
- {
- "input": {
- "UserName": "anika"
- },
- "output": {
- "IsTruncated": false,
- "Tags": [
- {
- "Key": "Dept",
- "Value": "12345"
- },
- {
- "Key": "Team",
- "Value": "Accounting"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following example shows how to list the tags attached to a user.",
- "id": "to-list-the-tags-attached-to-an-iam-user-1506719473186",
- "title": "To list the tags attached to an IAM user"
- }
- ],
- "ListUsers": [
- {
- "input": {
- },
- "output": {
- "Users": [
- {
- "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan",
- "CreateDate": "2012-09-05T19:38:48Z",
- "PasswordLastUsed": "2016-09-08T21:47:36Z",
- "Path": "/division_abc/subdivision_xyz/engineering/",
- "UserId": "AID2MAB8DPLSRHEXAMPLE",
- "UserName": "Juan"
- },
- {
- "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika",
- "CreateDate": "2014-04-09T15:43:45Z",
- "PasswordLastUsed": "2016-09-24T16:18:07Z",
- "Path": "/division_abc/subdivision_xyz/engineering/",
- "UserId": "AIDIODR4TAW7CSEXAMPLE",
- "UserName": "Anika"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the IAM users in the current account.",
- "id": "9edfbd73-03d8-4d8a-9a79-76c85e8c8298",
- "title": "To list IAM users"
- }
- ],
- "ListVirtualMFADevices": [
- {
- "input": {
- },
- "output": {
- "VirtualMFADevices": [
- {
- "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice"
- },
- {
- "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command lists the virtual MFA devices that have been configured for the current account.",
- "id": "54f9ac18-5100-4070-bec4-fe5f612710d5",
- "title": "To list virtual MFA devices"
- }
- ],
- "PutGroupPolicy": [
- {
- "input": {
- "GroupName": "Admins",
- "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
- "PolicyName": "AllPerms"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command adds a policy named AllPerms to the IAM group named Admins.",
- "id": "4bc17418-758f-4d0f-ab0c-4d00265fec2e",
- "title": "To add a policy to a group"
- }
- ],
- "PutRolePolicy": [
- {
- "input": {
- "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}",
- "PolicyName": "S3AccessPolicy",
- "RoleName": "S3Access"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command adds a permissions policy to the role named Test-Role.",
- "id": "de62fd00-46c7-4601-9e0d-71d5fbb11ecb",
- "title": "To attach a permissions policy to an IAM role"
- }
- ],
- "PutUserPolicy": [
- {
- "input": {
- "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
- "PolicyName": "AllAccessPolicy",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command attaches a policy to the IAM user named Bob.",
- "id": "2551ffc6-3576-4d39-823f-30b60bffc2c7",
- "title": "To attach a policy to an IAM user"
- }
- ],
- "RemoveRoleFromInstanceProfile": [
- {
- "input": {
- "InstanceProfileName": "ExampleInstanceProfile",
- "RoleName": "Test-Role"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.",
- "id": "6d9f46f1-9f4a-4873-b403-51a85c5c627c",
- "title": "To remove a role from an instance profile"
- }
- ],
- "RemoveUserFromGroup": [
- {
- "input": {
- "GroupName": "Admins",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command removes the user named Bob from the IAM group named Admins.",
- "id": "fb54d5b4-0caf-41d8-af0e-10a84413f174",
- "title": "To remove a user from an IAM group"
- }
- ],
- "SetSecurityTokenServicePreferences": [
- {
- "input": {
- "GlobalEndpointTokenVersion": "v2Token"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.",
- "id": "61a785a7-d30a-415a-ae18-ab9236e56871",
- "title": "To delete an access key for an IAM user"
- }
- ],
- "TagRole": [
- {
- "input": {
- "RoleName": "taggedrole",
- "Tags": [
- {
- "Key": "Dept",
- "Value": "Accounting"
- },
- {
- "Key": "CostCenter",
- "Value": "12345"
- }
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following example shows how to add tags to an existing role.",
- "id": "to-add-a-tag-key-and-value-to-an-iam-role-1506718791513",
- "title": "To add a tag key and value to an IAM role"
- }
- ],
- "TagUser": [
- {
- "input": {
- "Tags": [
- {
- "Key": "Dept",
- "Value": "Accounting"
- },
- {
- "Key": "CostCenter",
- "Value": "12345"
- }
- ],
- "UserName": "anika"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following example shows how to add tags to an existing user.",
- "id": "to-add-a-tag-key-and-value-to-an-iam-user-1506719044227",
- "title": "To add a tag key and value to an IAM user"
- }
- ],
- "UntagRole": [
- {
- "input": {
- "RoleName": "taggedrole",
- "TagKeys": [
- "Dept"
- ]
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.",
- "id": "to-remove-a-tag-from-an-iam-role-1506719589943",
- "title": "To remove a tag from an IAM role"
- }
- ],
- "UntagUser": [
- {
- "input": {
- "TagKeys": [
- "Dept"
- ],
- "UserName": "anika"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following example shows how to remove tags that are attached to a user named 'anika'.",
- "id": "to-remove-a-tag-from-an-iam-user-1506719725554",
- "title": "To remove a tag from an IAM user"
- }
- ],
- "UpdateAccessKey": [
- {
- "input": {
- "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
- "Status": "Inactive",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.",
- "id": "02b556fd-e673-49b7-ab6b-f2f9035967d0",
- "title": "To activate or deactivate an access key for an IAM user"
- }
- ],
- "UpdateAccountPasswordPolicy": [
- {
- "input": {
- "MinimumPasswordLength": 8,
- "RequireNumbers": true
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "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:",
- "id": "c263a1af-37dc-4423-8dba-9790284ef5e0",
- "title": "To set or change the current account password policy"
- }
- ],
- "UpdateAssumeRolePolicy": [
- {
- "input": {
- "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}",
- "RoleName": "S3AccessForEC2Instances"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command updates the role trust policy for the role named Test-Role:",
- "id": "c9150063-d953-4e99-9576-9685872006c6",
- "title": "To update the trust policy for an IAM role"
- }
- ],
- "UpdateGroup": [
- {
- "input": {
- "GroupName": "Test",
- "NewGroupName": "Test-1"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command changes the name of the IAM group Test to Test-1.",
- "id": "f0cf1662-91ae-4278-a80e-7db54256ccba",
- "title": "To rename an IAM group"
- }
- ],
- "UpdateLoginProfile": [
- {
- "input": {
- "Password": "SomeKindOfPassword123!@#",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command creates or changes the password for the IAM user named Bob.",
- "id": "036d9498-ecdb-4ed6-a8d8-366c383d1487",
- "title": "To change the password for an IAM user"
- }
- ],
- "UpdateSigningCertificate": [
- {
- "input": {
- "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
- "Status": "Inactive",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command changes the status of a signing certificate for a user named Bob to Inactive.",
- "id": "829aee7b-efc5-4b3b-84a5-7f899b38018d",
- "title": "To change the active status of a signing certificate for an IAM user"
- }
- ],
- "UpdateUser": [
- {
- "input": {
- "NewUserName": "Robert",
- "UserName": "Bob"
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.",
- "id": "275d53ed-347a-44e6-b7d0-a96276154352",
- "title": "To change an IAM user's name"
- }
- ],
- "UploadServerCertificate": [
- {
- "input": {
- "CertificateBody": "-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----",
- "Path": "/company/servercerts/",
- "PrivateKey": "-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----",
- "ServerCertificateName": "ProdServerCert"
- },
- "output": {
- "ServerCertificateMetadata": {
- "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert",
- "Expiration": "2012-05-08T01:02:03.004Z",
- "Path": "/company/servercerts/",
- "ServerCertificateId": "ASCA1111111111EXAMPLE",
- "ServerCertificateName": "ProdServerCert",
- "UploadDate": "2010-05-08T01:02:03.004Z"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following upload-server-certificate command uploads a server certificate to your AWS account:",
- "id": "06eab6d1-ebf2-4bd9-839d-f7508b9a38b6",
- "title": "To upload a server certificate to your AWS account"
- }
- ],
- "UploadSigningCertificate": [
- {
- "input": {
- "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
- "UserName": "Bob"
- },
- "output": {
- "Certificate": {
- "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
- "CertificateId": "ID123456789012345EXAMPLE",
- "Status": "Active",
- "UploadDate": "2015-06-06T21:40:08.121Z",
- "UserName": "Bob"
- }
- },
- "comments": {
- "input": {
- },
- "output": {
- }
- },
- "description": "The following command uploads a signing certificate for the IAM user named Bob.",
- "id": "e67489b6-7b73-4e30-9ed3-9a9e0231e458",
- "title": "To upload a signing certificate for an IAM user"
- }
- ]
- }
- }
|