docs.aws.amazon.com Open in urlscan Pro
18.165.98.90  Public Scan

Form analysis
0 forms found in the DOM

Text Content

SELECT YOUR COOKIE PREFERENCES

We use essential cookies and similar tools that are necessary to provide our
site and services. We use performance cookies to collect anonymous statistics,
so we can understand how customers use our site and make improvements. Essential
cookies cannot be deactivated, but you can choose “Customize” or “Decline” to
decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide
useful site features, remember your preferences, and display relevant content,
including relevant advertising. To accept or decline all non-essential cookies,
choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AcceptDeclineCustomize


CUSTOMIZE COOKIE PREFERENCES

We use cookies and similar tools (collectively, "cookies") for the following
purposes.


ESSENTIAL

Essential cookies are necessary to provide our site and services and cannot be
deactivated. They are usually set in response to your actions on the site, such
as setting your privacy preferences, signing in, or filling in forms.




PERFORMANCE

Performance cookies provide anonymous statistics about how customers navigate
our site so we can improve site experience and performance. Approved third
parties may perform analytics on our behalf, but they cannot use the data for
their own purposes.

Allow performance category
Allowed


FUNCTIONAL

Functional cookies help us provide useful site features, remember your
preferences, and display relevant content. Approved third parties may set these
cookies to provide certain site features. If you do not allow these cookies,
then some or all of these services may not function properly.

Allow functional category
Allowed


ADVERTISING

Advertising cookies may be set through our site by us or our advertising
partners and help us deliver relevant marketing content. If you do not allow
these cookies, you will experience less relevant advertising.

Allow advertising category
Allowed

Blocking some types of cookies may impact your experience of our sites. You may
review and change your choices at any time by selecting Cookie preferences in
the footer of this site. We and selected third-parties use cookies or similar
technologies as specified in the AWS Cookie Notice.

CancelSave preferences




UNABLE TO SAVE COOKIE PREFERENCES

We will only store essential cookies at this time, because we were unable to
save your cookie preferences.

If you want to change your cookie preferences, try again later using the link in
the AWS console footer, or contact support if the problem persists.

Dismiss


Contact Us
English



Create an AWS Account
 1. AWS
 2. ...
    
    
 3. Documentation
 4. AWS Identity and Access Management
 5. API Reference

 1. AWS
 2. Documentation
 3. AWS Identity and Access Management
 4. API Reference

Feedback
Preferences


AWS IDENTITY AND ACCESS MANAGEMENT


API REFERENCE

 * Welcome
 * Actions
    * AddClientIDToOpenIDConnectProvider
    * AddRoleToInstanceProfile
    * AddUserToGroup
    * AttachGroupPolicy
    * AttachRolePolicy
    * AttachUserPolicy
    * ChangePassword
    * CreateAccessKey
    * CreateAccountAlias
    * CreateGroup
    * CreateInstanceProfile
    * CreateLoginProfile
    * CreateOpenIDConnectProvider
    * CreatePolicy
    * CreatePolicyVersion
    * CreateRole
    * CreateSAMLProvider
    * CreateServiceLinkedRole
    * CreateServiceSpecificCredential
    * CreateUser
    * CreateVirtualMFADevice
    * DeactivateMFADevice
    * DeleteAccessKey
    * DeleteAccountAlias
    * DeleteAccountPasswordPolicy
    * DeleteGroup
    * DeleteGroupPolicy
    * DeleteInstanceProfile
    * DeleteLoginProfile
    * DeleteOpenIDConnectProvider
    * DeletePolicy
    * DeletePolicyVersion
    * DeleteRole
    * DeleteRolePermissionsBoundary
    * DeleteRolePolicy
    * DeleteSAMLProvider
    * DeleteServerCertificate
    * DeleteServiceLinkedRole
    * DeleteServiceSpecificCredential
    * DeleteSigningCertificate
    * DeleteSSHPublicKey
    * DeleteUser
    * DeleteUserPermissionsBoundary
    * DeleteUserPolicy
    * DeleteVirtualMFADevice
    * DetachGroupPolicy
    * DetachRolePolicy
    * DetachUserPolicy
    * DisableOrganizationsRootCredentialsManagement
    * DisableOrganizationsRootSessions
    * EnableMFADevice
    * EnableOrganizationsRootCredentialsManagement
    * EnableOrganizationsRootSessions
    * GenerateCredentialReport
    * GenerateOrganizationsAccessReport
    * GenerateServiceLastAccessedDetails
    * GetAccessKeyLastUsed
    * GetAccountAuthorizationDetails
    * GetAccountPasswordPolicy
    * GetAccountSummary
    * GetContextKeysForCustomPolicy
    * GetContextKeysForPrincipalPolicy
    * GetCredentialReport
    * GetGroup
    * GetGroupPolicy
    * GetInstanceProfile
    * GetLoginProfile
    * GetMFADevice
    * GetOpenIDConnectProvider
    * GetOrganizationsAccessReport
    * GetPolicy
    * GetPolicyVersion
    * GetRole
    * GetRolePolicy
    * GetSAMLProvider
    * GetServerCertificate
    * GetServiceLastAccessedDetails
    * GetServiceLastAccessedDetailsWithEntities
    * GetServiceLinkedRoleDeletionStatus
    * GetSSHPublicKey
    * GetUser
    * GetUserPolicy
    * ListAccessKeys
    * ListAccountAliases
    * ListAttachedGroupPolicies
    * ListAttachedRolePolicies
    * ListAttachedUserPolicies
    * ListEntitiesForPolicy
    * ListGroupPolicies
    * ListGroups
    * ListGroupsForUser
    * ListInstanceProfiles
    * ListInstanceProfilesForRole
    * ListInstanceProfileTags
    * ListMFADevices
    * ListMFADeviceTags
    * ListOpenIDConnectProviders
    * ListOpenIDConnectProviderTags
    * ListOrganizationsFeatures
    * ListPolicies
    * ListPoliciesGrantingServiceAccess
    * ListPolicyTags
    * ListPolicyVersions
    * ListRolePolicies
    * ListRoles
    * ListRoleTags
    * ListSAMLProviders
    * ListSAMLProviderTags
    * ListServerCertificates
    * ListServerCertificateTags
    * ListServiceSpecificCredentials
    * ListSigningCertificates
    * ListSSHPublicKeys
    * ListUserPolicies
    * ListUsers
    * ListUserTags
    * ListVirtualMFADevices
    * PutGroupPolicy
    * PutRolePermissionsBoundary
    * PutRolePolicy
    * PutUserPermissionsBoundary
    * PutUserPolicy
    * RemoveClientIDFromOpenIDConnectProvider
    * RemoveRoleFromInstanceProfile
    * RemoveUserFromGroup
    * ResetServiceSpecificCredential
    * ResyncMFADevice
    * SetDefaultPolicyVersion
    * SetSecurityTokenServicePreferences
    * SimulateCustomPolicy
    * SimulatePrincipalPolicy
    * TagInstanceProfile
    * TagMFADevice
    * TagOpenIDConnectProvider
    * TagPolicy
    * TagRole
    * TagSAMLProvider
    * TagServerCertificate
    * TagUser
    * UntagInstanceProfile
    * UntagMFADevice
    * UntagOpenIDConnectProvider
    * UntagPolicy
    * UntagRole
    * UntagSAMLProvider
    * UntagServerCertificate
    * UntagUser
    * UpdateAccessKey
    * UpdateAccountPasswordPolicy
    * UpdateAssumeRolePolicy
    * UpdateGroup
    * UpdateLoginProfile
    * UpdateOpenIDConnectProviderThumbprint
    * UpdateRole
    * UpdateRoleDescription
    * UpdateSAMLProvider
    * UpdateServerCertificate
    * UpdateServiceSpecificCredential
    * UpdateSigningCertificate
    * UpdateSSHPublicKey
    * UpdateUser
    * UploadServerCertificate
    * UploadSigningCertificate
    * UploadSSHPublicKey

 * Data Types
    * AccessDetail
    * AccessKey
    * AccessKeyLastUsed
    * AccessKeyMetadata
    * AttachedPermissionsBoundary
    * AttachedPolicy
    * ContextEntry
    * DeletionTaskFailureReasonType
    * EntityDetails
    * EntityInfo
    * ErrorDetails
    * EvaluationResult
    * Group
    * GroupDetail
    * InstanceProfile
    * ListPoliciesGrantingServiceAccessEntry
    * LoginProfile
    * ManagedPolicyDetail
    * MFADevice
    * OpenIDConnectProviderListEntry
    * OrganizationsDecisionDetail
    * PasswordPolicy
    * PermissionsBoundaryDecisionDetail
    * Policy
    * PolicyDetail
    * PolicyGrantingServiceAccess
    * PolicyGroup
    * PolicyRole
    * PolicyUser
    * PolicyVersion
    * Position
    * ResourceSpecificResult
    * Role
    * RoleDetail
    * RoleLastUsed
    * RoleUsageType
    * SAMLProviderListEntry
    * ServerCertificate
    * ServerCertificateMetadata
    * ServiceLastAccessed
    * ServiceSpecificCredential
    * ServiceSpecificCredentialMetadata
    * SigningCertificate
    * SSHPublicKey
    * SSHPublicKeyMetadata
    * Statement
    * Tag
    * TrackedActionLastAccessed
    * User
    * UserDetail
    * VirtualMFADevice

 * Common Parameters
 * Common Errors

Welcome to the IAM API Reference - AWS Identity and Access Management
AWSDocumentationAWS Identity and Access ManagementAPI Reference
Programmatic access to IAMSigning requestsAdditional resources


WELCOME TO THE IAM API REFERENCE


PDF

AWS Identity and Access Management (IAM) is a web service for securely
controlling access to AWS services. With IAM, you can centrally manage users,
security credentials such as access keys, and permissions that control which AWS
resources users and applications can access. For more information about IAM, see
AWS Identity and Access Management (IAM) and the IAM User Guide.


PROGRAMMATIC ACCESS TO IAM


We recommend that you use the AWS SDKs to make programmatic API calls to IAM.
The AWS SDKs consist of libraries and sample code for various programming
languages and platforms (for example, Java, Ruby, .NET, iOS, and Android). The
SDKs provide a convenient way to create programmatic access to IAM and AWS. For
example, the SDKs take care of tasks such as cryptographically signing requests,
managing errors, and retrying requests automatically. For more information, see
Tools to build on AWS.

Alternatively, you can also use the IAM Query API to make direct calls to the
IAM service. For more information about calling the IAM Query API, see Making
query requests in the AWS Identity and Access Management User Guide. IAM
supports GET and POST requests for all actions. That is, the API does not
require you to use GET for some actions and POST for others. However, GET
requests are subject to the limitation size of a URL. Therefore, for operations
that require larger sizes, use a POST request.


SIGNING REQUESTS


Requests must be signed using an access key ID and a secret access key. We
strongly recommend that you do not use your AWS account access key ID and secret
access key for everyday work with IAM. You can use the access key ID and secret
access key for an IAM user or you can use the AWS Security Token Service to
generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an
existing application that uses Signature Version 2, you do not have to update it
to use Signature Version 4. However, some operations now require Signature
Version 4. The documentation for operations that require version 4 indicate this
requirement.


ADDITIONAL RESOURCES


 * AWS security credentials. This topic provides general information about the
   types of credentials used for accessing AWS.

 * IAM best practices. This topic presents a list of suggestions for using the
   IAM service to help secure your AWS resources.

 * Signing AWS API requests. This set of topics walk you through the process of
   signing a request using an access key ID and secret access key.

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please
refer to your browser's Help pages for instructions.

Document Conventions
Actions
Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of
it.



Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.





DID THIS PAGE HELP YOU?

Yes
No
Provide feedback

NEXT TOPIC:

Actions

NEED HELP?

 * Try AWS re:Post 
 * Connect with an AWS IQ expert 

PrivacySite termsCookie preferences
© 2024, Amazon Web Services, Inc. or its affiliates. All rights reserved.


ON THIS PAGE

 * Programmatic access to IAM
 * Signing requests
 * Additional resources