AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.
We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM 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
For more information, see the following:
Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonIdentityManagementService IDisposable
The IAmazonIdentityManagementService type exposes the following members
Name | Description | |
---|---|---|
AddClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest) |
Adds a new client ID (also known as audience) to the list of client IDs already registered
for the specified IAM OpenID Connect provider.
This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider. |
|
AddClientIDToOpenIDConnectProviderAsync(AddClientIDToOpenIDConnectProviderRequest, CancellationToken) | Initiates the asynchronous execution of the AddClientIDToOpenIDConnectProvider operation. | |
AddRoleToInstanceProfile(AddRoleToInstanceProfileRequest) | Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles. | |
AddRoleToInstanceProfileAsync(AddRoleToInstanceProfileRequest, CancellationToken) | Initiates the asynchronous execution of the AddRoleToInstanceProfile operation. | |
AddUserToGroup(AddUserToGroupRequest) | Adds the specified user to the specified group. | |
AddUserToGroupAsync(AddUserToGroupRequest, CancellationToken) | Initiates the asynchronous execution of the AddUserToGroup operation. | |
AttachGroupPolicy(AttachGroupPolicyRequest) |
Attaches the specified managed policy to the specified group.
You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
AttachGroupPolicyAsync(AttachGroupPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the AttachGroupPolicy operation. | |
AttachRolePolicy(AttachRolePolicyRequest) |
Attaches the specified managed policy to the specified role.
When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
AttachRolePolicyAsync(AttachRolePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the AttachRolePolicy operation. | |
AttachUserPolicy(AttachUserPolicyRequest) |
Attaches the specified managed policy to the specified user.
You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
AttachUserPolicyAsync(AttachUserPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the AttachUserPolicy operation. | |
ChangePassword(ChangePasswordRequest) |
Changes the password of the IAM user who is calling this action. The root account
password is not affected by this action.
To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide. |
|
ChangePasswordAsync(ChangePasswordRequest, CancellationToken) | Initiates the asynchronous execution of the ChangePassword operation. | |
CreateAccessKey() |
Creates a new AWS secret access key and corresponding AWS access key ID for the specified
user. The default status for new keys is Active .
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide. |
|
CreateAccessKey(CreateAccessKeyRequest) |
Creates a new AWS secret access key and corresponding AWS access key ID for the specified
user. The default status for new keys is Active .
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide. |
|
CreateAccessKeyAsync(CreateAccessKeyRequest, CancellationToken) | Initiates the asynchronous execution of the CreateAccessKey operation. | |
CreateAccountAlias(CreateAccountAliasRequest) | Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. | |
CreateAccountAliasAsync(CreateAccountAliasRequest, CancellationToken) | Initiates the asynchronous execution of the CreateAccountAlias operation. | |
CreateGroup(CreateGroupRequest) |
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide. |
|
CreateGroupAsync(CreateGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateGroup operation. | |
CreateInstanceProfile(CreateInstanceProfileRequest) |
Creates a new instance profile. For information about instance profiles, go to About
Instance Profiles.
For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide. |
|
CreateInstanceProfileAsync(CreateInstanceProfileRequest, CancellationToken) | Initiates the asynchronous execution of the CreateInstanceProfile operation. | |
CreateLoginProfile(CreateLoginProfileRequest) | Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide. | |
CreateLoginProfileAsync(CreateLoginProfileRequest, CancellationToken) | Initiates the asynchronous execution of the CreateLoginProfile operation. | |
CreateOpenIDConnectProvider(CreateOpenIDConnectProviderRequest) |
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID
Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider. When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS. |
|
CreateOpenIDConnectProviderAsync(CreateOpenIDConnectProviderRequest, CancellationToken) | Initiates the asynchronous execution of the CreateOpenIDConnectProvider operation. | |
CreatePolicy(CreatePolicyRequest) |
Creates a new managed policy for your AWS account.
This operation creates a policy version with a version identifier of For more information about managed policies in general, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
CreatePolicyAsync(CreatePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePolicy operation. | |
CreatePolicyVersion(CreatePolicyVersionRequest) |
Creates a new version of the specified managed policy. To update a managed policy,
you create a new policy version. A managed policy can have up to five versions. If
the policy has five versions, you must delete an existing version using DeletePolicyVersion
before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. |
|
CreatePolicyVersionAsync(CreatePolicyVersionRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePolicyVersion operation. | |
CreateRole(CreateRoleRequest) | Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide. | |
CreateRoleAsync(CreateRoleRequest, CancellationToken) | Initiates the asynchronous execution of the CreateRole operation. | |
CreateSAMLProvider(CreateSAMLProviderRequest) |
Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide. |
|
CreateSAMLProviderAsync(CreateSAMLProviderRequest, CancellationToken) | Initiates the asynchronous execution of the CreateSAMLProvider operation. | |
CreateUser(CreateUserRequest) |
Creates a new user for your AWS account.
For information about limitations on the number of users you can create, see Limitations on IAM Entities in the IAM User Guide. |
|
CreateUserAsync(CreateUserRequest, CancellationToken) | Initiates the asynchronous execution of the CreateUser operation. | |
CreateVirtualMFADevice(CreateVirtualMFADeviceRequest) |
Creates a new virtual MFA device for the AWS account. After creating the virtual MFA,
use EnableMFADevice to attach the MFA device to an IAM user. For more information
about creating and working with virtual MFA devices, go to Using
a Virtual MFA Device in the Using IAM guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the Using IAM guide. |
|
CreateVirtualMFADeviceAsync(CreateVirtualMFADeviceRequest, CancellationToken) | Initiates the asynchronous execution of the CreateVirtualMFADevice operation. | |
DeactivateMFADevice(DeactivateMFADeviceRequest) |
Deactivates the specified MFA device and removes it from association with the user
name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide. |
|
DeactivateMFADeviceAsync(DeactivateMFADeviceRequest, CancellationToken) | Initiates the asynchronous execution of the DeactivateMFADevice operation. | |
DeleteAccessKey(DeleteAccessKeyRequest) |
Deletes the access key associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. |
|
DeleteAccessKeyAsync(DeleteAccessKeyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteAccessKey operation. | |
DeleteAccountAlias(DeleteAccountAliasRequest) | Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. | |
DeleteAccountAliasAsync(DeleteAccountAliasRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteAccountAlias operation. | |
DeleteAccountPasswordPolicy() | Deletes the password policy for the AWS account. | |
DeleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest) | Deletes the password policy for the AWS account. | |
DeleteAccountPasswordPolicyAsync(DeleteAccountPasswordPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteAccountPasswordPolicy operation. | |
DeleteGroup(DeleteGroupRequest) | Deletes the specified group. The group must not contain any users or have any attached policies. | |
DeleteGroupAsync(DeleteGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteGroup operation. | |
DeleteGroupPolicy(DeleteGroupPolicyRequest) |
Deletes the specified inline policy that is embedded in the specified group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DeleteGroupPolicyAsync(DeleteGroupPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteGroupPolicy operation. | |
DeleteInstanceProfile(DeleteInstanceProfileRequest) |
Deletes the specified instance profile. The instance profile must not have an associated
role.
For more information about instance profiles, go to About Instance Profiles. |
|
DeleteInstanceProfileAsync(DeleteInstanceProfileRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteInstanceProfile operation. | |
DeleteLoginProfile(DeleteLoginProfileRequest) |
Deletes the password for the specified user, which terminates the user's ability
to access AWS services through the AWS Management Console.
|
|
DeleteLoginProfileAsync(DeleteLoginProfileRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteLoginProfile operation. | |
DeleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest) |
Deletes an IAM OpenID Connect identity provider.
Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail. This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted. |
|
DeleteOpenIDConnectProviderAsync(DeleteOpenIDConnectProviderRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteOpenIDConnectProvider operation. | |
DeletePolicy(DeletePolicyRequest) |
Deletes the specified managed policy.
Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:
For information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DeletePolicyAsync(DeletePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeletePolicy operation. | |
DeletePolicyVersion(DeletePolicyVersionRequest) |
Deletes the specified version of the specified managed policy.
You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. For information about versions for managed policies, refer to Versioning for Managed Policies in the IAM User Guide. |
|
DeletePolicyVersionAsync(DeletePolicyVersionRequest, CancellationToken) | Initiates the asynchronous execution of the DeletePolicyVersion operation. | |
DeleteRole(DeleteRoleRequest) |
Deletes the specified role. The role must not have any policies attached. For more
information about roles, go to Working
with Roles.
|
|
DeleteRoleAsync(DeleteRoleRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteRole operation. | |
DeleteRolePolicy(DeleteRolePolicyRequest) |
Deletes the specified inline policy that is embedded in the specified role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DeleteRolePolicyAsync(DeleteRolePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteRolePolicy operation. | |
DeleteSAMLProvider(DeleteSAMLProviderRequest) |
Deletes a SAML provider.
Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail. |
|
DeleteSAMLProviderAsync(DeleteSAMLProviderRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSAMLProvider operation. | |
DeleteServerCertificate(DeleteServerCertificateRequest) |
Deletes the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide. |
|
DeleteServerCertificateAsync(DeleteServerCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteServerCertificate operation. | |
DeleteSigningCertificate(DeleteSigningCertificateRequest) |
Deletes the specified signing certificate associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. |
|
DeleteSigningCertificateAsync(DeleteSigningCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSigningCertificate operation. | |
DeleteSSHPublicKey(DeleteSSHPublicKeyRequest) |
Deletes the specified SSH public key.
The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. |
|
DeleteSSHPublicKeyAsync(DeleteSSHPublicKeyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSSHPublicKey operation. | |
DeleteUser(DeleteUserRequest) | Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies. | |
DeleteUserAsync(DeleteUserRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteUser operation. | |
DeleteUserPolicy(DeleteUserPolicyRequest) |
Deletes the specified inline policy that is embedded in the specified user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DeleteUserPolicyAsync(DeleteUserPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteUserPolicy operation. | |
DeleteVirtualMFADevice(DeleteVirtualMFADeviceRequest) |
Deletes a virtual MFA device.
|
|
DeleteVirtualMFADeviceAsync(DeleteVirtualMFADeviceRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteVirtualMFADevice operation. | |
DetachGroupPolicy(DetachGroupPolicyRequest) |
Removes the specified managed policy from the specified group.
A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DetachGroupPolicyAsync(DetachGroupPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DetachGroupPolicy operation. | |
DetachRolePolicy(DetachRolePolicyRequest) |
Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DetachRolePolicyAsync(DetachRolePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DetachRolePolicy operation. | |
DetachUserPolicy(DetachUserPolicyRequest) |
Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
DetachUserPolicyAsync(DetachUserPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DetachUserPolicy operation. | |
EnableMFADevice(EnableMFADeviceRequest) | Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device. | |
EnableMFADeviceAsync(EnableMFADeviceRequest, CancellationToken) | Initiates the asynchronous execution of the EnableMFADevice operation. | |
GenerateCredentialReport() | Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide. | |
GenerateCredentialReport(GenerateCredentialReportRequest) | Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide. | |
GenerateCredentialReportAsync(GenerateCredentialReportRequest, CancellationToken) | Initiates the asynchronous execution of the GenerateCredentialReport operation. | |
GetAccessKeyLastUsed(GetAccessKeyLastUsedRequest) | Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key. | |
GetAccessKeyLastUsedAsync(GetAccessKeyLastUsedRequest, CancellationToken) | Initiates the asynchronous execution of the GetAccessKeyLastUsed operation. | |
GetAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest) |
Retrieves information about all IAM users, groups, roles, and policies in your account,
including their relationships to one another. Use this API to obtain a snapshot of
the configuration of IAM permissions (users, groups, roles, and policies) in your
account.
You can optionally filter the results using the |
|
GetAccountAuthorizationDetailsAsync(GetAccountAuthorizationDetailsRequest, CancellationToken) | Initiates the asynchronous execution of the GetAccountAuthorizationDetails operation. | |
GetAccountPasswordPolicy() | Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy. | |
GetAccountPasswordPolicy(GetAccountPasswordPolicyRequest) | Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy. | |
GetAccountPasswordPolicyAsync(GetAccountPasswordPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetAccountPasswordPolicy operation. | |
GetAccountSummary() |
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide. |
|
GetAccountSummary(GetAccountSummaryRequest) |
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide. |
|
GetAccountSummaryAsync(GetAccountSummaryRequest, CancellationToken) | Initiates the asynchronous execution of the GetAccountSummary operation. | |
GetContextKeysForCustomPolicy(List<String>) |
Gets a list of all of the context keys referenced in Condition elements
in the input policies. The policies are supplied as a list of one or more strings.
To get the context keys from policies associated with an IAM user, group, or role,
use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request, and can be evaluated by using the |
|
GetContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest) |
Gets a list of all of the context keys referenced in Condition elements
in the input policies. The policies are supplied as a list of one or more strings.
To get the context keys from policies associated with an IAM user, group, or role,
use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request, and can be evaluated by using the |
|
GetContextKeysForCustomPolicyAsync(GetContextKeysForCustomPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetContextKeysForCustomPolicy operation. | |
GetContextKeysForPrincipalPolicy(string) |
Gets a list of all of the context keys referenced in Condition elements
in all of the IAM policies attached to the specified IAM entity. The entity can be
an IAM user, group, or role. If you specify a user, then the request also includes
all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request, and can be evaluated by using the |
|
GetContextKeysForPrincipalPolicy(string, List<String>) |
Gets a list of all of the context keys referenced in Condition elements
in all of the IAM policies attached to the specified IAM entity. The entity can be
an IAM user, group, or role. If you specify a user, then the request also includes
all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request, and can be evaluated by using the |
|
GetContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest) |
Gets a list of all of the context keys referenced in Condition elements
in all of the IAM policies attached to the specified IAM entity. The entity can be
an IAM user, group, or role. If you specify a user, then the request also includes
all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request, and can be evaluated by using the |
|
GetContextKeysForPrincipalPolicyAsync(GetContextKeysForPrincipalPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetContextKeysForPrincipalPolicy operation. | |
GetCredentialReport() | Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide. | |
GetCredentialReport(GetCredentialReportRequest) | Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide. | |
GetCredentialReportAsync(GetCredentialReportRequest, CancellationToken) | Initiates the asynchronous execution of the GetCredentialReport operation. | |
GetGroup(GetGroupRequest) |
Returns a list of users that are in the specified group. You can paginate the results
using the MaxItems and Marker parameters.
|
|
GetGroupAsync(GetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the GetGroup operation. | |
GetGroupPolicy(GetGroupPolicyRequest) |
Retrieves the specified inline policy document that is embedded in the specified group.
A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
GetGroupPolicyAsync(GetGroupPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetGroupPolicy operation. | |
GetInstanceProfile(GetInstanceProfileRequest) | Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles. For more information about ARNs, go to ARNs. | |
GetInstanceProfileAsync(GetInstanceProfileRequest, CancellationToken) | Initiates the asynchronous execution of the GetInstanceProfile operation. | |
GetLoginProfile(GetLoginProfileRequest) |
Retrieves the user name and password-creation date for the specified user. If the
user has not been assigned a password, the action returns a 404 (NoSuchEntity )
error.
|
|
GetLoginProfileAsync(GetLoginProfileRequest, CancellationToken) | Initiates the asynchronous execution of the GetLoginProfile operation. | |
GetOpenIDConnectProvider(GetOpenIDConnectProviderRequest) | Returns information about the specified OpenID Connect provider. | |
GetOpenIDConnectProviderAsync(GetOpenIDConnectProviderRequest, CancellationToken) | Initiates the asynchronous execution of the GetOpenIDConnectProvider operation. | |
GetPolicy(GetPolicyRequest) |
Retrieves information about the specified managed policy, including the policy's default
version and the total number of users, groups, and roles that the policy is attached
to. For a list of the specific users, groups, and roles that the policy is attached
to, use the ListEntitiesForPolicy API. This API returns metadata about the
policy. To retrieve the policy document for a specific version of the policy, use
GetPolicyVersion.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
GetPolicyAsync(GetPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetPolicy operation. | |
GetPolicyVersion(GetPolicyVersionRequest) |
Retrieves information about the specified version of the specified managed policy,
including the policy document.
To list the available versions for a policy, use ListPolicyVersions. This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API. For more information about the types of policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
GetPolicyVersionAsync(GetPolicyVersionRequest, CancellationToken) | Initiates the asynchronous execution of the GetPolicyVersion operation. | |
GetRole(GetRoleRequest) | Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles. | |
GetRoleAsync(GetRoleRequest, CancellationToken) | Initiates the asynchronous execution of the GetRole operation. | |
GetRolePolicy(GetRolePolicyRequest) |
Retrieves the specified inline policy document that is embedded with the specified
role.
A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities. |
|
GetRolePolicyAsync(GetRolePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetRolePolicy operation. | |
GetSAMLProvider(GetSAMLProviderRequest) |
Returns the SAML provider metadocument that was uploaded when the provider was created
or updated.
|
|
GetSAMLProviderAsync(GetSAMLProviderRequest, CancellationToken) | Initiates the asynchronous execution of the GetSAMLProvider operation. | |
GetServerCertificate(GetServerCertificateRequest) |
Retrieves information about the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide. |
|
GetServerCertificateAsync(GetServerCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the GetServerCertificate operation. | |
GetSSHPublicKey(GetSSHPublicKeyRequest) |
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. |
|
GetSSHPublicKeyAsync(GetSSHPublicKeyRequest, CancellationToken) | Initiates the asynchronous execution of the GetSSHPublicKey operation. | |
GetUser() |
Retrieves information about the specified user, including the user's creation date,
path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. |
|
GetUser(GetUserRequest) |
Retrieves information about the specified user, including the user's creation date,
path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. |
|
GetUserAsync(GetUserRequest, CancellationToken) | Initiates the asynchronous execution of the GetUser operation. | |
GetUserPolicy(GetUserPolicyRequest) |
Retrieves the specified inline policy document that is embedded in the specified user.
A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
GetUserPolicyAsync(GetUserPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetUserPolicy operation. | |
ListAccessKeys() |
Returns information about the access key IDs associated with the specified user. If
there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the
results using the
If the |
|
ListAccessKeys(ListAccessKeysRequest) |
Returns information about the access key IDs associated with the specified user. If
there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the
results using the
If the |
|
ListAccessKeysAsync(ListAccessKeysRequest, CancellationToken) | Initiates the asynchronous execution of the ListAccessKeys operation. | |
ListAccountAliases() | Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. | |
ListAccountAliases(ListAccountAliasesRequest) | Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. | |
ListAccountAliasesAsync(ListAccountAliasesRequest, CancellationToken) | Initiates the asynchronous execution of the ListAccountAliases operation. | |
ListAttachedGroupPolicies(ListAttachedGroupPoliciesRequest) |
Lists all managed policies that are attached to the specified group.
A group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the |
|
ListAttachedGroupPoliciesAsync(ListAttachedGroupPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListAttachedGroupPolicies operation. | |
ListAttachedRolePolicies(ListAttachedRolePoliciesRequest) |
Lists all managed policies that are attached to the specified role.
A role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the |
|
ListAttachedRolePoliciesAsync(ListAttachedRolePoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListAttachedRolePolicies operation. | |
ListAttachedUserPolicies(ListAttachedUserPoliciesRequest) |
Lists all managed policies that are attached to the specified user.
A user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the |
|
ListAttachedUserPoliciesAsync(ListAttachedUserPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListAttachedUserPolicies operation. | |
ListEntitiesForPolicy(ListEntitiesForPolicyRequest) |
Lists all users, groups, and roles that the specified managed policy is attached to.
You can use the optional
You can paginate the results using the |
|
ListEntitiesForPolicyAsync(ListEntitiesForPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the ListEntitiesForPolicy operation. | |
ListGroupPolicies(ListGroupPoliciesRequest) |
Lists the names of the inline policies that are embedded in the specified group.
A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the |
|
ListGroupPoliciesAsync(ListGroupPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListGroupPolicies operation. | |
ListGroups() |
Lists the groups that have the specified path prefix.
You can paginate the results using the |
|
ListGroups(ListGroupsRequest) |
Lists the groups that have the specified path prefix.
You can paginate the results using the |
|
ListGroupsAsync(ListGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the ListGroups operation. | |
ListGroupsForUser(ListGroupsForUserRequest) |
Lists the groups the specified user belongs to.
You can paginate the results using the |
|
ListGroupsForUserAsync(ListGroupsForUserRequest, CancellationToken) | Initiates the asynchronous execution of the ListGroupsForUser operation. | |
ListInstanceProfiles() |
Lists the instance profiles that have the specified path prefix. If there are none,
the action returns an empty list. For more information about instance profiles, go
to About
Instance Profiles.
You can paginate the results using the |
|
ListInstanceProfiles(ListInstanceProfilesRequest) |
Lists the instance profiles that have the specified path prefix. If there are none,
the action returns an empty list. For more information about instance profiles, go
to About
Instance Profiles.
You can paginate the results using the |
|
ListInstanceProfilesAsync(ListInstanceProfilesRequest, CancellationToken) | Initiates the asynchronous execution of the ListInstanceProfiles operation. | |
ListInstanceProfilesForRole(ListInstanceProfilesForRoleRequest) |
Lists the instance profiles that have the specified associated role. If there are
none, the action returns an empty list. For more information about instance profiles,
go to About
Instance Profiles.
You can paginate the results using the |
|
ListInstanceProfilesForRoleAsync(ListInstanceProfilesForRoleRequest, CancellationToken) | Initiates the asynchronous execution of the ListInstanceProfilesForRole operation. | |
ListMFADevices() |
Lists the MFA devices. If the request includes the user name, then this action lists
all the MFA devices associated with the specified user name. If you do not specify
a user name, IAM determines the user name implicitly based on the AWS access key ID
signing the request.
You can paginate the results using the |
|
ListMFADevices(ListMFADevicesRequest) |
Lists the MFA devices. If the request includes the user name, then this action lists
all the MFA devices associated with the specified user name. If you do not specify
a user name, IAM determines the user name implicitly based on the AWS access key ID
signing the request.
You can paginate the results using the |
|
ListMFADevicesAsync(ListMFADevicesRequest, CancellationToken) | Initiates the asynchronous execution of the ListMFADevices operation. | |
ListOpenIDConnectProviders(ListOpenIDConnectProvidersRequest) | Lists information about the OpenID Connect providers in the AWS account. | |
ListOpenIDConnectProvidersAsync(ListOpenIDConnectProvidersRequest, CancellationToken) | Initiates the asynchronous execution of the ListOpenIDConnectProviders operation. | |
ListPolicies() |
Lists all the managed policies that are available to your account, including your
own customer managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional
You can paginate the results using the For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
ListPolicies(ListPoliciesRequest) |
Lists all the managed policies that are available to your account, including your
own customer managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional
You can paginate the results using the For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
ListPoliciesAsync(ListPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListPolicies operation. | |
ListPolicyVersions(ListPolicyVersionsRequest) |
Lists information about the versions of the specified managed policy, including the
version that is set as the policy's default version.
For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
ListPolicyVersionsAsync(ListPolicyVersionsRequest, CancellationToken) | Initiates the asynchronous execution of the ListPolicyVersions operation. | |
ListRolePolicies(ListRolePoliciesRequest) |
Lists the names of the inline policies that are embedded in the specified role.
A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the |
|
ListRolePoliciesAsync(ListRolePoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListRolePolicies operation. | |
ListRoles() |
Lists the roles that have the specified path prefix. If there are none, the action
returns an empty list. For more information about roles, go to Working
with Roles.
You can paginate the results using the |
|
ListRoles(ListRolesRequest) |
Lists the roles that have the specified path prefix. If there are none, the action
returns an empty list. For more information about roles, go to Working
with Roles.
You can paginate the results using the |
|
ListRolesAsync(ListRolesRequest, CancellationToken) | Initiates the asynchronous execution of the ListRoles operation. | |
ListSAMLProviders() |
Lists the SAML providers in the account.
|
|
ListSAMLProviders(ListSAMLProvidersRequest) |
Lists the SAML providers in the account.
|
|
ListSAMLProvidersAsync(ListSAMLProvidersRequest, CancellationToken) | Initiates the asynchronous execution of the ListSAMLProviders operation. | |
ListServerCertificates() |
Lists the server certificates that have the specified path prefix. If none exist,
the action returns an empty list.
You can paginate the results using the For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide. |
|
ListServerCertificates(ListServerCertificatesRequest) |
Lists the server certificates that have the specified path prefix. If none exist,
the action returns an empty list.
You can paginate the results using the For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide. |
|
ListServerCertificatesAsync(ListServerCertificatesRequest, CancellationToken) | Initiates the asynchronous execution of the ListServerCertificates operation. | |
ListSigningCertificates() |
Returns information about the signing certificates associated with the specified user.
If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates, you can still
paginate the results using the
If the |
|
ListSigningCertificates(ListSigningCertificatesRequest) |
Returns information about the signing certificates associated with the specified user.
If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates, you can still
paginate the results using the
If the |
|
ListSigningCertificatesAsync(ListSigningCertificatesRequest, CancellationToken) | Initiates the asynchronous execution of the ListSigningCertificates operation. | |
ListSSHPublicKeys(ListSSHPublicKeysRequest) |
Returns information about the SSH public keys associated with the specified IAM user.
If there are none, the action returns an empty list.
The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the
results using the |
|
ListSSHPublicKeysAsync(ListSSHPublicKeysRequest, CancellationToken) | Initiates the asynchronous execution of the ListSSHPublicKeys operation. | |
ListUserPolicies(ListUserPoliciesRequest) |
Lists the names of the inline policies embedded in the specified user.
A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the |
|
ListUserPoliciesAsync(ListUserPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the ListUserPolicies operation. | |
ListUsers() |
Lists the IAM users that have the specified path prefix. If no path prefix is specified,
the action returns all users in the AWS account. If there are none, the action returns
an empty list.
You can paginate the results using the |
|
ListUsers(ListUsersRequest) |
Lists the IAM users that have the specified path prefix. If no path prefix is specified,
the action returns all users in the AWS account. If there are none, the action returns
an empty list.
You can paginate the results using the |
|
ListUsersAsync(ListUsersRequest, CancellationToken) | Initiates the asynchronous execution of the ListUsers operation. | |
ListVirtualMFADevices() |
Lists the virtual MFA devices under the AWS account by assignment status. If you do
not specify an assignment status, the action returns a list of all virtual MFA devices.
Assignment status can be Assigned , Unassigned , or Any .
You can paginate the results using the |
|
ListVirtualMFADevices(ListVirtualMFADevicesRequest) |
Lists the virtual MFA devices under the AWS account by assignment status. If you do
not specify an assignment status, the action returns a list of all virtual MFA devices.
Assignment status can be Assigned , Unassigned , or Any .
You can paginate the results using the |
|
ListVirtualMFADevicesAsync(ListVirtualMFADevicesRequest, CancellationToken) | Initiates the asynchronous execution of the ListVirtualMFADevices operation. | |
PutGroupPolicy(PutGroupPolicyRequest) |
Adds (or updates) an inline policy document that is embedded in the specified group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide. PutGroupPolicy . For general information about using the
Query API with IAM, go to Making
Query Requests in the Using IAM guide. |
|
PutGroupPolicyAsync(PutGroupPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the PutGroupPolicy operation. | |
PutRolePolicy(PutRolePolicyRequest) |
Adds (or updates) an inline policy document that is embedded in the specified role.
When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities. A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide. PutRolePolicy . For general information about using the Query
API with IAM, go to Making
Query Requests in the Using IAM guide. |
|
PutRolePolicyAsync(PutRolePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the PutRolePolicy operation. | |
PutUserPolicy(PutUserPolicyRequest) |
Adds (or updates) an inline policy document that is embedded in the specified user.
A user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide. PutUserPolicy . For general information about using the Query
API with IAM, go to Making
Query Requests in the Using IAM guide. |
|
PutUserPolicyAsync(PutUserPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the PutUserPolicy operation. | |
RemoveClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest) |
Removes the specified client ID (also known as audience) from the list of client IDs
registered for the specified IAM OpenID Connect provider.
This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously. |
|
RemoveClientIDFromOpenIDConnectProviderAsync(RemoveClientIDFromOpenIDConnectProviderRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveClientIDFromOpenIDConnectProvider operation. | |
RemoveRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest) |
Removes the specified role from the specified instance profile.
For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles. |
|
RemoveRoleFromInstanceProfileAsync(RemoveRoleFromInstanceProfileRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveRoleFromInstanceProfile operation. | |
RemoveUserFromGroup(RemoveUserFromGroupRequest) | Removes the specified user from the specified group. | |
RemoveUserFromGroupAsync(RemoveUserFromGroupRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveUserFromGroup operation. | |
ResyncMFADevice(ResyncMFADeviceRequest) |
Synchronizes the specified MFA device with AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide. |
|
ResyncMFADeviceAsync(ResyncMFADeviceRequest, CancellationToken) | Initiates the asynchronous execution of the ResyncMFADevice operation. | |
SetDefaultPolicyVersion(SetDefaultPolicyVersionRequest) |
Sets the specified version of the specified policy as the policy's default (operative)
version.
This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. For information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide. |
|
SetDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest, CancellationToken) | Initiates the asynchronous execution of the SetDefaultPolicyVersion operation. | |
SimulateCustomPolicy(SimulateCustomPolicyRequest) |
Simulate how a set of IAM policies and optionally a resource-based policy works with
a list of API actions and AWS resources to determine the policies' effective permissions.
The policies are provided as strings.
The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions. If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request. You can use the
If the output is long, you can use |
|
SimulateCustomPolicyAsync(SimulateCustomPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the SimulateCustomPolicy operation. | |
SimulatePrincipalPolicy(SimulatePrincipalPolicyRequest) |
Simulate how a set of IAM policies attached to an IAM entity works with a list of
API actions and AWS resources to determine the policies' effective permissions. The
entity can be an IAM user, group, or role. If you specify a user, then the simulation
also includes all of the policies that are attached to groups that the user belongs
to .
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details
about the context of an API query request. You can use the
If the output is long, you can use the |
|
SimulatePrincipalPolicyAsync(SimulatePrincipalPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the SimulatePrincipalPolicy operation. | |
UpdateAccessKey(UpdateAccessKeyRequest) |
Changes the status of the specified access key from Active to Inactive, or vice versa.
This action can be used to disable a user's key as part of a key rotation work flow.
If the For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide. |
|
UpdateAccessKeyAsync(UpdateAccessKeyRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateAccessKey operation. | |
UpdateAccountPasswordPolicy() |
Updates the password policy settings for the AWS account.
This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide. |
|
UpdateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest) |
Updates the password policy settings for the AWS account.
This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide. |
|
UpdateAccountPasswordPolicyAsync(UpdateAccountPasswordPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateAccountPasswordPolicy operation. | |
UpdateAssumeRolePolicy(UpdateAssumeRolePolicyRequest) | Updates the policy that grants an entity permission to assume a role. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities. | |
UpdateAssumeRolePolicyAsync(UpdateAssumeRolePolicyRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateAssumeRolePolicy operation. | |
UpdateGroup(UpdateGroupRequest) |
Updates the name and/or the path of the specified group.
|
|
UpdateGroupAsync(UpdateGroupRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateGroup operation. | |
UpdateLoginProfile(UpdateLoginProfileRequest) |
Changes the password for the specified user.
Users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide. |
|
UpdateLoginProfileAsync(UpdateLoginProfileRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateLoginProfile operation. | |
UpdateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest) |
Replaces the existing list of server certificate thumbprints with a new list.
The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated. UpdateOpenIDConnectProviderThumbprint action to highly-privileged
users. |
|
UpdateOpenIDConnectProviderThumbprintAsync(UpdateOpenIDConnectProviderThumbprintRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateOpenIDConnectProviderThumbprint operation. | |
UpdateSAMLProvider(UpdateSAMLProviderRequest) |
Updates the metadata document for an existing SAML provider.
|
|
UpdateSAMLProviderAsync(UpdateSAMLProviderRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateSAMLProvider operation. | |
UpdateServerCertificate(UpdateServerCertificateRequest) |
Updates the name and/or the path of the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide. |
|
UpdateServerCertificateAsync(UpdateServerCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateServerCertificate operation. | |
UpdateSigningCertificate(UpdateSigningCertificateRequest) |
Changes the status of the specified signing certificate from active to disabled, or
vice versa. This action can be used to disable a user's signing certificate as part
of a certificate rotation work flow.
If the |
|
UpdateSigningCertificateAsync(UpdateSigningCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateSigningCertificate operation. | |
UpdateSSHPublicKey(UpdateSSHPublicKeyRequest) |
Sets the status of the specified SSH public key to active or inactive. SSH public
keys that are inactive cannot be used for authentication. This action can be used
to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. |
|
UpdateSSHPublicKeyAsync(UpdateSSHPublicKeyRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateSSHPublicKey operation. | |
UpdateUser(UpdateUserRequest) |
Updates the name and/or the path of the specified user.
|
|
UpdateUserAsync(UpdateUserRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateUser operation. | |
UploadServerCertificate(UploadServerCertificateRequest) |
Uploads a server certificate entity for the AWS account. The server certificate entity
includes a public key certificate, a private key, and an optional certificate chain,
which should all be PEM-encoded.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide. For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide. UploadServerCertificate .
For information about setting up signatures and authorization through the API, go
to Signing
AWS API Requests in the AWS General Reference. For general information
about using the Query API with IAM, go to Calling
the API by Making HTTP Query Requests in the IAM User Guide. |
|
UploadServerCertificateAsync(UploadServerCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the UploadServerCertificate operation. | |
UploadSigningCertificate(UploadSigningCertificateRequest) |
Uploads an X.509 signing certificate and associates it with the specified user. Some
AWS services use X.509 signing certificates to validate requests that are signed with
a corresponding private key. When you upload the certificate, its default status is
Active .
If the UploadSigningCertificate . For information about
setting up signatures and authorization through the API, go to Signing
AWS API Requests in the AWS General Reference. For general information
about using the Query API with IAM, go to Making
Query Requests in the Using IAMguide. |
|
UploadSigningCertificateAsync(UploadSigningCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the UploadSigningCertificate operation. | |
UploadSSHPublicKey(UploadSSHPublicKeyRequest) |
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. |
|
UploadSSHPublicKeyAsync(UploadSSHPublicKeyRequest, CancellationToken) | Initiates the asynchronous execution of the UploadSSHPublicKey operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1