ebook img

AWS Identity and Access Management - API Reference PDF

418 Pages·2017·2.91 MB·English
by  
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview AWS Identity and Access Management - API Reference

AWS Identity and Access Management API Reference API Version 2010-05-08 AWS Identity and Access Management API Reference AWS Identity and Access Management: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Identity and Access Management API Reference Table of Contents Welcome........................................................................................................................................... 1 Programmatic access to IAM ........................................................................................................ 1 Signing requests........................................................................................................................ 1 Additional resources................................................................................................................... 1 Actions............................................................................................................................................. 2 AddClientIDToOpenIDConnectProvider.......................................................................................... 6 Request Parameters............................................................................................................ 6 Errors............................................................................................................................... 6 Examples........................................................................................................................... 7 See Also............................................................................................................................ 7 AddRoleToInstanceProfile............................................................................................................ 8 Request Parameters............................................................................................................ 8 Errors............................................................................................................................... 8 Examples........................................................................................................................... 9 See Also............................................................................................................................ 9 AddUserToGroup...................................................................................................................... 11 Request Parameters.......................................................................................................... 11 Errors.............................................................................................................................. 11 Examples......................................................................................................................... 12 See Also.......................................................................................................................... 12 AttachGroupPolicy.................................................................................................................... 13 Request Parameters.......................................................................................................... 13 Errors.............................................................................................................................. 13 Examples......................................................................................................................... 14 See Also.......................................................................................................................... 14 AttachRolePolicy...................................................................................................................... 16 Request Parameters.......................................................................................................... 16 Errors.............................................................................................................................. 16 Examples......................................................................................................................... 17 See Also.......................................................................................................................... 18 AttachUserPolicy...................................................................................................................... 19 Request Parameters.......................................................................................................... 19 Errors.............................................................................................................................. 19 Examples......................................................................................................................... 20 See Also.......................................................................................................................... 20 ChangePassword ...................................................................................................................... 22 Request Parameters.......................................................................................................... 22 Errors.............................................................................................................................. 22 Examples......................................................................................................................... 23 See Also.......................................................................................................................... 23 CreateAccessKey....................................................................................................................... 25 Request Parameters.......................................................................................................... 25 Response Elements........................................................................................................... 25 Errors.............................................................................................................................. 25 Examples......................................................................................................................... 26 See Also.......................................................................................................................... 26 CreateAccountAlias................................................................................................................... 28 Request Parameters.......................................................................................................... 28 Errors.............................................................................................................................. 28 Examples......................................................................................................................... 29 See Also.......................................................................................................................... 29 CreateGroup............................................................................................................................ 30 Request Parameters.......................................................................................................... 30 Response Elements........................................................................................................... 30 API Version 2010-05-08 iii AWS Identity and Access Management API Reference Errors.............................................................................................................................. 31 Examples......................................................................................................................... 31 See Also.......................................................................................................................... 32 CreateInstanceProfile................................................................................................................ 33 Request Parameters.......................................................................................................... 33 Response Elements........................................................................................................... 34 Errors.............................................................................................................................. 34 Examples......................................................................................................................... 34 See Also.......................................................................................................................... 35 CreateLoginProfile.................................................................................................................... 36 Request Parameters.......................................................................................................... 36 Response Elements........................................................................................................... 37 Errors.............................................................................................................................. 37 Examples......................................................................................................................... 37 See Also.......................................................................................................................... 38 CreateOpenIDConnectProvider................................................................................................... 39 Request Parameters.......................................................................................................... 39 Response Elements........................................................................................................... 40 Errors.............................................................................................................................. 41 Examples......................................................................................................................... 41 See Also.......................................................................................................................... 42 CreatePolicy............................................................................................................................. 43 Request Parameters.......................................................................................................... 43 Response Elements........................................................................................................... 44 Errors.............................................................................................................................. 45 Examples......................................................................................................................... 45 See Also.......................................................................................................................... 46 CreatePolicyVersion.................................................................................................................. 47 Request Parameters.......................................................................................................... 47 Response Elements........................................................................................................... 48 Errors.............................................................................................................................. 48 Examples......................................................................................................................... 49 See Also.......................................................................................................................... 49 CreateRole............................................................................................................................... 50 Request Parameters.......................................................................................................... 50 Response Elements........................................................................................................... 52 Errors.............................................................................................................................. 52 Examples......................................................................................................................... 53 See Also.......................................................................................................................... 53 CreateSAMLProvider................................................................................................................. 55 Request Parameters.......................................................................................................... 55 Response Elements........................................................................................................... 56 Errors.............................................................................................................................. 56 Examples......................................................................................................................... 57 See Also.......................................................................................................................... 57 CreateServiceLinkedRole............................................................................................................ 58 Request Parameters.......................................................................................................... 58 Response Elements........................................................................................................... 59 Errors.............................................................................................................................. 59 See Also.......................................................................................................................... 59 CreateServiceSpecificCredential .................................................................................................. 61 Request Parameters.......................................................................................................... 61 Response Elements........................................................................................................... 61 Errors.............................................................................................................................. 62 Examples......................................................................................................................... 62 See Also.......................................................................................................................... 63 CreateUser............................................................................................................................... 64 API Version 2010-05-08 iv AWS Identity and Access Management API Reference Request Parameters.......................................................................................................... 64 Response Elements........................................................................................................... 65 Errors.............................................................................................................................. 65 Examples......................................................................................................................... 66 See Also.......................................................................................................................... 66 CreateVirtualMFADevice............................................................................................................ 68 Request Parameters.......................................................................................................... 68 Response Elements........................................................................................................... 69 Errors.............................................................................................................................. 69 Examples......................................................................................................................... 70 See Also.......................................................................................................................... 70 DeactivateMFADevice................................................................................................................ 71 Request Parameters.......................................................................................................... 71 Errors.............................................................................................................................. 71 Examples......................................................................................................................... 72 See Also.......................................................................................................................... 72 DeleteAccessKey....................................................................................................................... 74 Request Parameters.......................................................................................................... 74 Errors.............................................................................................................................. 74 Examples......................................................................................................................... 75 See Also.......................................................................................................................... 75 DeleteAccountAlias................................................................................................................... 76 Request Parameters.......................................................................................................... 76 Errors.............................................................................................................................. 76 Examples......................................................................................................................... 77 See Also.......................................................................................................................... 77 DeleteAccountPasswordPolicy.................................................................................................... 78 Errors.............................................................................................................................. 78 Examples......................................................................................................................... 78 See Also.......................................................................................................................... 78 DeleteGroup............................................................................................................................ 80 Request Parameters.......................................................................................................... 80 Errors.............................................................................................................................. 80 Examples......................................................................................................................... 81 See Also.......................................................................................................................... 81 DeleteGroupPolicy.................................................................................................................... 82 Request Parameters.......................................................................................................... 82 Errors.............................................................................................................................. 82 Examples......................................................................................................................... 83 See Also.......................................................................................................................... 83 DeleteInstanceProfile................................................................................................................ 84 Request Parameters.......................................................................................................... 84 Errors.............................................................................................................................. 84 Examples......................................................................................................................... 85 See Also.......................................................................................................................... 85 DeleteLoginProfile.................................................................................................................... 86 Request Parameters.......................................................................................................... 86 Errors.............................................................................................................................. 86 Examples......................................................................................................................... 87 See Also.......................................................................................................................... 87 DeleteOpenIDConnectProvider................................................................................................... 88 Request Parameters.......................................................................................................... 88 Errors.............................................................................................................................. 88 Examples......................................................................................................................... 88 See Also.......................................................................................................................... 89 DeletePolicy............................................................................................................................. 90 Request Parameters.......................................................................................................... 90 API Version 2010-05-08 v AWS Identity and Access Management API Reference Errors.............................................................................................................................. 90 Examples......................................................................................................................... 91 See Also.......................................................................................................................... 91 DeletePolicyVersion.................................................................................................................. 92 Request Parameters.......................................................................................................... 92 Errors.............................................................................................................................. 92 Examples......................................................................................................................... 93 See Also.......................................................................................................................... 93 DeleteRole............................................................................................................................... 95 Request Parameters.......................................................................................................... 95 Errors.............................................................................................................................. 95 Examples......................................................................................................................... 96 See Also.......................................................................................................................... 96 DeleteRolePermissionsBoundary................................................................................................. 98 Request Parameters.......................................................................................................... 98 Errors.............................................................................................................................. 98 See Also.......................................................................................................................... 98 DeleteRolePolicy..................................................................................................................... 100 Request Parameters........................................................................................................ 100 Errors............................................................................................................................ 100 Examples....................................................................................................................... 101 See Also........................................................................................................................ 101 DeleteSAMLProvider................................................................................................................ 102 Request Parameters........................................................................................................ 102 Errors............................................................................................................................ 102 Examples....................................................................................................................... 103 See Also........................................................................................................................ 103 DeleteServerCertificate............................................................................................................ 104 Request Parameters........................................................................................................ 104 Errors............................................................................................................................ 104 Examples....................................................................................................................... 105 See Also........................................................................................................................ 105 DeleteServiceLinkedRole.......................................................................................................... 106 Request Parameters........................................................................................................ 106 Response Elements......................................................................................................... 106 Errors............................................................................................................................ 106 Examples....................................................................................................................... 107 See Also........................................................................................................................ 107 DeleteServiceSpecificCredential ................................................................................................ 109 Request Parameters........................................................................................................ 109 Errors............................................................................................................................ 109 Examples....................................................................................................................... 110 See Also........................................................................................................................ 110 DeleteSigningCertificate.......................................................................................................... 111 Request Parameters........................................................................................................ 111 Errors............................................................................................................................ 111 Examples....................................................................................................................... 112 See Also........................................................................................................................ 112 DeleteSSHPublicKey................................................................................................................ 113 Request Parameters........................................................................................................ 113 Errors............................................................................................................................ 113 Examples....................................................................................................................... 114 See Also........................................................................................................................ 114 DeleteUser............................................................................................................................. 115 Request Parameters........................................................................................................ 115 Errors............................................................................................................................ 115 Examples....................................................................................................................... 116 API Version 2010-05-08 vi AWS Identity and Access Management API Reference See Also........................................................................................................................ 116 DeleteUserPermissionsBoundary............................................................................................... 118 Request Parameters........................................................................................................ 118 Errors............................................................................................................................ 118 See Also........................................................................................................................ 118 DeleteUserPolicy..................................................................................................................... 120 Request Parameters........................................................................................................ 120 Errors............................................................................................................................ 120 Examples....................................................................................................................... 121 See Also........................................................................................................................ 121 DeleteVirtualMFADevice........................................................................................................... 122 Request Parameters........................................................................................................ 122 Errors............................................................................................................................ 122 Examples....................................................................................................................... 123 See Also........................................................................................................................ 123 DetachGroupPolicy.................................................................................................................. 124 Request Parameters........................................................................................................ 124 Errors............................................................................................................................ 124 Examples....................................................................................................................... 125 See Also........................................................................................................................ 125 DetachRolePolicy.................................................................................................................... 126 Request Parameters........................................................................................................ 126 Errors............................................................................................................................ 126 Examples....................................................................................................................... 127 See Also........................................................................................................................ 127 DetachUserPolicy.................................................................................................................... 129 Request Parameters........................................................................................................ 129 Errors............................................................................................................................ 129 Examples....................................................................................................................... 130 See Also........................................................................................................................ 130 EnableMFADevice.................................................................................................................... 131 Request Parameters........................................................................................................ 131 Errors............................................................................................................................ 132 Examples....................................................................................................................... 133 See Also........................................................................................................................ 133 GenerateCredentialReport........................................................................................................ 134 Response Elements......................................................................................................... 134 Errors............................................................................................................................ 134 Examples....................................................................................................................... 134 See Also........................................................................................................................ 135 GenerateOrganizationsAccessReport.......................................................................................... 136 Request Parameters........................................................................................................ 137 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 138 Examples....................................................................................................................... 138 See Also........................................................................................................................ 139 GenerateServiceLastAccessedDetails.......................................................................................... 140 Request Parameters........................................................................................................ 140 Response Elements......................................................................................................... 141 Errors............................................................................................................................ 141 Examples....................................................................................................................... 141 See Also........................................................................................................................ 142 GetAccessKeyLastUsed ............................................................................................................. 143 Request Parameters........................................................................................................ 143 Response Elements......................................................................................................... 143 Errors............................................................................................................................ 143 Examples....................................................................................................................... 144 API Version 2010-05-08 vii AWS Identity and Access Management API Reference See Also........................................................................................................................ 144 GetAccountAuthorizationDetails............................................................................................... 145 Request Parameters........................................................................................................ 145 Response Elements......................................................................................................... 146 Errors............................................................................................................................ 146 Examples....................................................................................................................... 147 See Also........................................................................................................................ 151 GetAccountPasswordPolicy....................................................................................................... 152 Response Elements......................................................................................................... 152 Errors............................................................................................................................ 152 Examples....................................................................................................................... 152 See Also........................................................................................................................ 153 GetAccountSummary............................................................................................................... 154 Response Elements......................................................................................................... 154 Errors............................................................................................................................ 154 Examples....................................................................................................................... 154 See Also........................................................................................................................ 157 GetContextKeysForCustomPolicy............................................................................................... 158 Request Parameters........................................................................................................ 158 Response Elements......................................................................................................... 158 Errors............................................................................................................................ 158 Examples....................................................................................................................... 159 See Also........................................................................................................................ 159 GetContextKeysForPrincipalPolicy............................................................................................. 161 Request Parameters........................................................................................................ 161 Response Elements......................................................................................................... 162 Errors............................................................................................................................ 162 Examples....................................................................................................................... 162 See Also........................................................................................................................ 163 GetCredentialReport............................................................................................................... 164 Response Elements......................................................................................................... 164 Errors............................................................................................................................ 164 Examples....................................................................................................................... 165 See Also........................................................................................................................ 165 GetGroup............................................................................................................................... 166 Request Parameters........................................................................................................ 166 Response Elements......................................................................................................... 166 Errors............................................................................................................................ 167 Examples....................................................................................................................... 167 See Also........................................................................................................................ 168 GetGroupPolicy...................................................................................................................... 169 Request Parameters........................................................................................................ 169 Response Elements......................................................................................................... 169 Errors............................................................................................................................ 170 Examples....................................................................................................................... 170 See Also........................................................................................................................ 171 GetInstanceProfile.................................................................................................................. 172 Request Parameters........................................................................................................ 172 Response Elements......................................................................................................... 172 Errors............................................................................................................................ 172 Examples....................................................................................................................... 173 See Also........................................................................................................................ 173 GetLoginProfile...................................................................................................................... 175 Request Parameters........................................................................................................ 175 Response Elements......................................................................................................... 175 Errors............................................................................................................................ 175 Examples....................................................................................................................... 176 API Version 2010-05-08 viii AWS Identity and Access Management API Reference See Also........................................................................................................................ 176 GetOpenIDConnectProvider..................................................................................................... 177 Request Parameters........................................................................................................ 177 Response Elements......................................................................................................... 177 Errors............................................................................................................................ 178 Examples....................................................................................................................... 178 See Also........................................................................................................................ 179 GetOrganizationsAccessReport................................................................................................. 180 Request Parameters........................................................................................................ 180 Response Elements......................................................................................................... 181 Errors............................................................................................................................ 182 Examples....................................................................................................................... 182 See Also........................................................................................................................ 183 GetPolicy............................................................................................................................... 184 Request Parameters........................................................................................................ 184 Response Elements......................................................................................................... 184 Errors............................................................................................................................ 184 Examples....................................................................................................................... 185 See Also........................................................................................................................ 185 GetPolicyVersion..................................................................................................................... 187 Request Parameters........................................................................................................ 187 Response Elements......................................................................................................... 187 Errors............................................................................................................................ 188 Examples....................................................................................................................... 188 See Also........................................................................................................................ 189 GetRole................................................................................................................................. 190 Request Parameters........................................................................................................ 190 Response Elements......................................................................................................... 190 Errors............................................................................................................................ 190 Examples....................................................................................................................... 191 See Also........................................................................................................................ 191 GetRolePolicy......................................................................................................................... 192 Request Parameters........................................................................................................ 192 Response Elements......................................................................................................... 192 Errors............................................................................................................................ 193 Examples....................................................................................................................... 193 See Also........................................................................................................................ 194 GetSAMLProvider.................................................................................................................... 195 Request Parameters........................................................................................................ 195 Response Elements......................................................................................................... 195 Errors............................................................................................................................ 196 Examples....................................................................................................................... 196 See Also........................................................................................................................ 196 GetServerCertificate................................................................................................................ 198 Request Parameters........................................................................................................ 198 Response Elements......................................................................................................... 198 Errors............................................................................................................................ 198 Examples....................................................................................................................... 199 See Also........................................................................................................................ 199 GetServiceLastAccessedDetails.................................................................................................. 201 Request Parameters........................................................................................................ 201 Response Elements......................................................................................................... 202 Errors............................................................................................................................ 203 Examples....................................................................................................................... 203 See Also........................................................................................................................ 204 GetServiceLastAccessedDetailsWithEntities................................................................................. 206 Request Parameters........................................................................................................ 206 API Version 2010-05-08 ix AWS Identity and Access Management API Reference Response Elements......................................................................................................... 207 Errors............................................................................................................................ 208 Examples....................................................................................................................... 208 See Also........................................................................................................................ 209 GetServiceLinkedRoleDeletionStatus......................................................................................... 210 Request Parameters........................................................................................................ 210 Response Elements......................................................................................................... 210 Errors............................................................................................................................ 210 Examples....................................................................................................................... 211 See Also........................................................................................................................ 212 GetSSHPublicKey.................................................................................................................... 213 Request Parameters........................................................................................................ 213 Response Elements......................................................................................................... 213 Errors............................................................................................................................ 214 Examples....................................................................................................................... 214 See Also........................................................................................................................ 215 GetUser................................................................................................................................. 216 Request Parameters........................................................................................................ 216 Response Elements......................................................................................................... 216 Errors............................................................................................................................ 216 Examples....................................................................................................................... 217 See Also........................................................................................................................ 217 GetUserPolicy......................................................................................................................... 219 Request Parameters........................................................................................................ 219 Response Elements......................................................................................................... 219 Errors............................................................................................................................ 220 Examples....................................................................................................................... 220 See Also........................................................................................................................ 221 ListAccessKeys........................................................................................................................ 222 Request Parameters........................................................................................................ 222 Response Elements......................................................................................................... 223 Errors............................................................................................................................ 223 Examples....................................................................................................................... 223 See Also........................................................................................................................ 224 ListAccountAliases................................................................................................................... 225 Request Parameters........................................................................................................ 225 Response Elements......................................................................................................... 225 Errors............................................................................................................................ 226 Examples....................................................................................................................... 226 See Also........................................................................................................................ 226 ListAttachedGroupPolicies........................................................................................................ 228 Request Parameters........................................................................................................ 228 Response Elements......................................................................................................... 229 Errors............................................................................................................................ 229 Examples....................................................................................................................... 230 See Also........................................................................................................................ 230 ListAttachedRolePolicies.......................................................................................................... 232 Request Parameters........................................................................................................ 232 Response Elements......................................................................................................... 233 Errors............................................................................................................................ 233 Examples....................................................................................................................... 234 See Also........................................................................................................................ 234 ListAttachedUserPolicies.......................................................................................................... 236 Request Parameters........................................................................................................ 236 Response Elements......................................................................................................... 237 Errors............................................................................................................................ 237 Examples....................................................................................................................... 238 API Version 2010-05-08 x

Description:
AWS Identity and Access Management: API Reference. Copyright © 2017 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.