AWS SDK Version 3 for .NET
API Reference

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.

Implementation for accessing IdentityManagementService AWS Identity and Access Management

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.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). 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 (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

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:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.IdentityManagement.AmazonIdentityManagementServiceClient

Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonIdentityManagementServiceClient : AmazonServiceClient
         IAmazonIdentityManagementService, IAmazonService, IDisposable

The AmazonIdentityManagementServiceClient type exposes the following members

Constructors

NameDescription
Public Method AmazonIdentityManagementServiceClient()

Constructs AmazonIdentityManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIdentityManagementServiceClient(RegionEndpoint)

Constructs AmazonIdentityManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIdentityManagementServiceClient(AmazonIdentityManagementServiceConfig)

Constructs AmazonIdentityManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIdentityManagementServiceClient(AWSCredentials)

Constructs AmazonIdentityManagementServiceClient with AWS Credentials

Public Method AmazonIdentityManagementServiceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonIdentityManagementServiceClient with AWS Credentials

Public Method AmazonIdentityManagementServiceClient(AWSCredentials, AmazonIdentityManagementServiceConfig)

Constructs AmazonIdentityManagementServiceClient with AWS Credentials and an AmazonIdentityManagementServiceClient Configuration object.

Public Method AmazonIdentityManagementServiceClient(string, string)

Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIdentityManagementServiceClient(string, string, RegionEndpoint)

Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIdentityManagementServiceClient(string, string, AmazonIdentityManagementServiceConfig)

Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonIdentityManagementServiceClient Configuration object.

Public Method AmazonIdentityManagementServiceClient(string, string, string)

Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIdentityManagementServiceClient(string, string, string, RegionEndpoint)

Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIdentityManagementServiceClient(string, string, string, AmazonIdentityManagementServiceConfig)

Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonIdentityManagementServiceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method 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 (OIDC) provider resource.

This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

Public Method AddClientIDToOpenIDConnectProviderAsync(AddClientIDToOpenIDConnectProviderRequest, CancellationToken)

Initiates the asynchronous execution of the AddClientIDToOpenIDConnectProvider operation.

Public Method AddRoleToInstanceProfile(AddRoleToInstanceProfileRequest)

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased.

The caller of this API must be granted the PassRole permission on the IAM role by a permission policy.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

Public Method AddRoleToInstanceProfileAsync(AddRoleToInstanceProfileRequest, CancellationToken)

Initiates the asynchronous execution of the AddRoleToInstanceProfile operation.

Public Method AddUserToGroup(AddUserToGroupRequest)

Adds the specified user to the specified group.

Public Method AddUserToGroupAsync(AddUserToGroupRequest, CancellationToken)

Initiates the asynchronous execution of the AddUserToGroup operation.

Public Method AttachGroupPolicy(AttachGroupPolicyRequest)

Attaches the specified managed policy to the specified IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method AttachGroupPolicyAsync(AttachGroupPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachGroupPolicy operation.

Public Method AttachRolePolicy(AttachRolePolicyRequest)

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method AttachRolePolicyAsync(AttachRolePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachRolePolicy operation.

Public Method 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method AttachUserPolicyAsync(AttachUserPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachUserPolicy operation.

Public Method 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.

Public Method ChangePasswordAsync(ChangePasswordRequest, CancellationToken)

Initiates the asynchronous execution of the ChangePassword operation.

Public Method 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.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

Public Method 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.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

Public Method CreateAccessKeyAsync(CancellationToken)

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.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

Public Method CreateAccessKeyAsync(CreateAccessKeyRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAccessKey operation.

Public Method 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.

Public Method CreateAccountAliasAsync(CreateAccountAliasRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAccountAlias operation.

Public Method 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.

Public Method CreateGroupAsync(CreateGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateGroup operation.

Public Method 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.

Public Method CreateInstanceProfileAsync(CreateInstanceProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateInstanceProfile operation.

Public Method 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 IAM User Guide.

Public Method CreateLoginProfileAsync(CreateLoginProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLoginProfile operation.

Public Method 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.

Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the CreateOpenIDConnectProvider action to highly-privileged users.

Public Method CreateOpenIDConnectProviderAsync(CreateOpenIDConnectProviderRequest, CancellationToken)

Initiates the asynchronous execution of the CreateOpenIDConnectProvider operation.

Public Method CreatePolicy(CreatePolicyRequest)

Creates a new managed policy for your AWS account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide.

For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method CreatePolicyAsync(CreatePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePolicy operation.

Public Method 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 version that is in effect for the IAM users, groups, and roles to which the policy is attached.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Public Method CreatePolicyVersionAsync(CreatePolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePolicyVersion operation.

Public Method 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.

Public Method CreateRoleAsync(CreateRoleRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRole operation.

Public Method CreateSAMLProvider(CreateSAMLProviderRequest)

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. 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 resource, 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 the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

This operation requires Signature Version 4.

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.

Public Method CreateSAMLProviderAsync(CreateSAMLProviderRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSAMLProvider operation.

Public Method CreateServiceLinkedRole(CreateServiceLinkedRoleRequest)

Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed.

The name of the role is autogenerated by combining the string that you specify for the AWSServiceName parameter with the string that you specify for the CustomSuffix parameter. The resulting name must be unique in your account or the request fails.

To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role.

Public Method CreateServiceLinkedRoleAsync(CreateServiceLinkedRoleRequest, CancellationToken)

Initiates the asynchronous execution of the CreateServiceLinkedRole operation.

Public Method CreateServiceSpecificCredential(CreateServiceSpecificCredentialRequest)

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

The only supported service at this time is AWS CodeCommit.

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide.

Public Method CreateServiceSpecificCredentialAsync(CreateServiceSpecificCredentialRequest, CancellationToken)

Initiates the asynchronous execution of the CreateServiceSpecificCredential operation.

Public Method CreateUser(CreateUserRequest)

Creates a new IAM user for your AWS account.

For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUser operation.

Public Method 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 IAM User Guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

Public Method CreateVirtualMFADeviceAsync(CreateVirtualMFADeviceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateVirtualMFADevice operation.

Public Method 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 IAM User Guide.

Public Method DeactivateMFADeviceAsync(DeactivateMFADeviceRequest, CancellationToken)

Initiates the asynchronous execution of the DeactivateMFADevice operation.

Public Method DeleteAccessKey(DeleteAccessKeyRequest)

Deletes the access key pair associated with the specified IAM 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.

Public Method DeleteAccessKeyAsync(DeleteAccessKeyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAccessKey operation.

Public Method 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.

Public Method DeleteAccountAliasAsync(DeleteAccountAliasRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAccountAlias operation.

Public Method DeleteAccountPasswordPolicy()

Deletes the password policy for the AWS account. There are no parameters.

Public Method DeleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest)

Deletes the password policy for the AWS account. There are no parameters.

Public Method DeleteAccountPasswordPolicyAsync(CancellationToken)

Deletes the password policy for the AWS account. There are no parameters.

Public Method DeleteAccountPasswordPolicyAsync(DeleteAccountPasswordPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAccountPasswordPolicy operation.

Public Method DeleteGroup(DeleteGroupRequest)

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

Public Method DeleteGroupAsync(DeleteGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteGroup operation.

Public Method DeleteGroupPolicy(DeleteGroupPolicyRequest)

Deletes the specified inline policy that is embedded in the specified IAM 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.

Public Method DeleteGroupPolicyAsync(DeleteGroupPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteGroupPolicy operation.

Public Method DeleteInstanceProfile(DeleteInstanceProfileRequest)

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, go to About Instance Profiles.

Public Method DeleteInstanceProfileAsync(DeleteInstanceProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteInstanceProfile operation.

Public Method DeleteLoginProfile(DeleteLoginProfileRequest)

Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.

Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

Public Method DeleteLoginProfileAsync(DeleteLoginProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteLoginProfile operation.

Public Method DeleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest)

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource 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 deleted provider fails.

This action is idempotent; it does not fail or return an error if you call the action for a provider that does not exist.

Public Method DeleteOpenIDConnectProviderAsync(DeleteOpenIDConnectProviderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteOpenIDConnectProvider operation.

Public Method DeletePolicy(DeletePolicyRequest)

Deletes the specified managed policy.

Before you can delete a managed policy, you must first 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:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy APIs. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes the policy's default version) using this API.

For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicy operation.

Public Method DeletePolicyVersion(DeletePolicyVersionRequest)

Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this API. To delete the default version from 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, see Versioning for Managed Policies in the IAM User Guide.

Public Method DeletePolicyVersionAsync(DeletePolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicyVersion operation.

Public Method DeleteRole(DeleteRoleRequest)

Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.

Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

Public Method DeleteRoleAsync(DeleteRoleRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRole operation.

Public Method DeleteRolePolicy(DeleteRolePolicyRequest)

Deletes the specified inline policy that is embedded in the specified IAM 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.

Public Method DeleteRolePolicyAsync(DeleteRolePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRolePolicy operation.

Public Method DeleteSAMLProvider(DeleteSAMLProviderRequest)

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

Public Method DeleteSAMLProviderAsync(DeleteSAMLProviderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSAMLProvider operation.

Public Method 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.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

Public Method DeleteServerCertificateAsync(DeleteServerCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteServerCertificate operation.

Public Method DeleteServiceLinkedRole(DeleteServiceLinkedRoleRequest)

Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus API operation returns the reason for the failure, including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service.

For more information about service-linked roles, see Roles Terms and Concepts: AWS Service-Linked Role in the IAM User Guide.

Public Method DeleteServiceLinkedRoleAsync(DeleteServiceLinkedRoleRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteServiceLinkedRole operation.

Public Method DeleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest)

Deletes the specified service-specific credential.

Public Method DeleteServiceSpecificCredentialAsync(DeleteServiceSpecificCredentialRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteServiceSpecificCredential operation.

Public Method DeleteSigningCertificate(DeleteSigningCertificateRequest)

Deletes a signing certificate associated with the specified IAM 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 IAM users.

Public Method DeleteSigningCertificateAsync(DeleteSigningCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSigningCertificate operation.

Public Method 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.

Public Method DeleteSSHPublicKeyAsync(DeleteSSHPublicKeyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSSHPublicKey operation.

Public Method DeleteUser(DeleteUserRequest)

Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DeleteUserPolicy(DeleteUserPolicyRequest)

Deletes the specified inline policy that is embedded in the specified IAM 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.

Public Method DeleteUserPolicyAsync(DeleteUserPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserPolicy operation.

Public Method DeleteVirtualMFADevice(DeleteVirtualMFADeviceRequest)

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

Public Method DeleteVirtualMFADeviceAsync(DeleteVirtualMFADeviceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteVirtualMFADevice operation.

Public Method DetachGroupPolicy(DetachGroupPolicyRequest)

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method DetachGroupPolicyAsync(DetachGroupPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachGroupPolicy operation.

Public Method 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method DetachRolePolicyAsync(DetachRolePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachRolePolicy operation.

Public Method 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method DetachUserPolicyAsync(DetachUserPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachUserPolicy operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EnableMFADevice(EnableMFADeviceRequest)

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

Public Method EnableMFADeviceAsync(EnableMFADeviceRequest, CancellationToken)

Initiates the asynchronous execution of the EnableMFADevice operation.

Public Method 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.

Public Method 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.

Public Method GenerateCredentialReportAsync(CancellationToken)

Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

Public Method GenerateCredentialReportAsync(GenerateCredentialReportRequest, CancellationToken)

Initiates the asynchronous execution of the GenerateCredentialReport operation.

Public Method 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.

Public Method GetAccessKeyLastUsedAsync(GetAccessKeyLastUsedRequest, CancellationToken)

Initiates the asynchronous execution of the GetAccessKeyLastUsed operation.

Public Method GetAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest)

Retrieves information about all IAM users, groups, roles, and policies in your AWS 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 Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

Public Method GetAccountAuthorizationDetailsAsync(GetAccountAuthorizationDetailsRequest, CancellationToken)

Initiates the asynchronous execution of the GetAccountAuthorizationDetails operation.

Public Method GetAccountPasswordPolicy()

Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.

Public Method 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.

Public Method GetAccountPasswordPolicyAsync(CancellationToken)

Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.

Public Method GetAccountPasswordPolicyAsync(GetAccountPasswordPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetAccountPasswordPolicy operation.

Public Method 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.

Public Method 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.

Public Method GetAccountSummaryAsync(CancellationToken)

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.

Public Method GetAccountSummaryAsync(GetAccountSummaryRequest, CancellationToken)

Initiates the asynchronous execution of the GetAccountSummary operation.

Public Method GetContextKeysForCustomPolicy(List<String>)

Gets a list of all of the context keys referenced 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 testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

Public Method GetContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest)

Gets a list of all of the context keys referenced 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 testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

Public Method GetContextKeysForCustomPolicyAsync(List<String>, CancellationToken)

Gets a list of all of the context keys referenced 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 testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

Public Method GetContextKeysForCustomPolicyAsync(GetContextKeysForCustomPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetContextKeysForCustomPolicy operation.

Public Method GetContextKeysForPrincipalPolicy(string)

Gets a list of all of the context keys referenced 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 testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Public Method GetContextKeysForPrincipalPolicy(string, List<String>)

Gets a list of all of the context keys referenced 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 testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Public Method GetContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest)

Gets a list of all of the context keys referenced 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 testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Public Method GetContextKeysForPrincipalPolicyAsync(string, CancellationToken)

Gets a list of all of the context keys referenced 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 testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Public Method GetContextKeysForPrincipalPolicyAsync(string, List<String>, CancellationToken)

Gets a list of all of the context keys referenced 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 testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Public Method GetContextKeysForPrincipalPolicyAsync(GetContextKeysForPrincipalPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetContextKeysForPrincipalPolicy operation.

Public Method 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.

Public Method 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.

Public Method GetCredentialReportAsync(CancellationToken)

Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

Public Method GetCredentialReportAsync(GetCredentialReportRequest, CancellationToken)

Initiates the asynchronous execution of the GetCredentialReport operation.

Public Method GetGroup(GetGroupRequest)

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

Public Method GetGroupAsync(GetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the GetGroup operation.

Public Method GetGroupPolicy(GetGroupPolicyRequest)

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method GetGroupPolicyAsync(GetGroupPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetGroupPolicy operation.

Public Method 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, see About Instance Profiles in the IAM User Guide.

Public Method GetInstanceProfileAsync(GetInstanceProfileRequest, CancellationToken)

Initiates the asynchronous execution of the GetInstanceProfile operation.

Public Method GetLoginProfile(GetLoginProfileRequest)

Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.

Public Method GetLoginProfileAsync(GetLoginProfileRequest, CancellationToken)

Initiates the asynchronous execution of the GetLoginProfile operation.

Public Method GetOpenIDConnectProvider(GetOpenIDConnectProviderRequest)

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

Public Method GetOpenIDConnectProviderAsync(GetOpenIDConnectProviderRequest, CancellationToken)

Initiates the asynchronous execution of the GetOpenIDConnectProvider operation.

Public Method GetPolicy(GetPolicyRequest)

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the 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 actual 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 an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method GetPolicyAsync(GetPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetPolicy operation.

Public Method GetPolicyVersion(GetPolicyVersionRequest)

Retrieves information about the specified version of the specified managed policy, including the policy document.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

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, see Managed Policies and Inline Policies in the IAM User Guide.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Public Method GetPolicyVersionAsync(GetPolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the GetPolicyVersion operation.

Public Method GetRole(GetRoleRequest)

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Public Method GetRoleAsync(GetRoleRequest, CancellationToken)

Initiates the asynchronous execution of the GetRole operation.

Public Method GetRolePolicy(GetRolePolicyRequest)

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

For more information about roles, see Using Roles to Delegate Permissions and Federate Identities.

Public Method GetRolePolicyAsync(GetRolePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetRolePolicy operation.

Public Method GetSAMLProvider(GetSAMLProviderRequest)

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

Public Method GetSAMLProviderAsync(GetSAMLProviderRequest, CancellationToken)

Initiates the asynchronous execution of the GetSAMLProvider operation.

Public Method GetServerCertificate(GetServerCertificateRequest)

Retrieves information about the specified server certificate stored in IAM.

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.

Public Method GetServerCertificateAsync(GetServerCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the GetServerCertificate operation.

Public Method GetServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest)

Retrieves the status of your service-linked role deletion. After you use the DeleteServiceLinkedRole API operation to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed.

Public Method GetServiceLinkedRoleDeletionStatusAsync(GetServiceLinkedRoleDeletionStatusRequest, CancellationToken)

Initiates the asynchronous execution of the GetServiceLinkedRoleDeletionStatus operation.

Public Method 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.

Public Method GetSSHPublicKeyAsync(GetSSHPublicKeyRequest, CancellationToken)

Initiates the asynchronous execution of the GetSSHPublicKey operation.

Public Method GetUser()

Retrieves information about the specified IAM 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 to this API.

Public Method GetUser(GetUserRequest)

Retrieves information about the specified IAM 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 to this API.

Public Method GetUserAsync(CancellationToken)

Retrieves information about the specified IAM 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 to this API.

Public Method GetUserAsync(GetUserRequest, CancellationToken)

Initiates the asynchronous execution of the GetUser operation.

Public Method GetUserPolicy(GetUserPolicyRequest)

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method GetUserPolicyAsync(GetUserPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetUserPolicy operation.

Public Method ListAccessKeys()

Returns information about the access key IDs associated with the specified IAM 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 MaxItems and Marker parameters.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign 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.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.

Public Method ListAccessKeys(ListAccessKeysRequest)

Returns information about the access key IDs associated with the specified IAM 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 MaxItems and Marker parameters.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign 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.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.

Public Method ListAccessKeysAsync(CancellationToken)

Returns information about the access key IDs associated with the specified IAM 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 MaxItems and Marker parameters.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign 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.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.

Public Method ListAccessKeysAsync(ListAccessKeysRequest, CancellationToken)

Initiates the asynchronous execution of the ListAccessKeys operation.

Public Method ListAccountAliases()

Lists the account alias associated with the AWS 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.

Public Method ListAccountAliases(ListAccountAliasesRequest)

Lists the account alias associated with the AWS 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.

Public Method ListAccountAliasesAsync(CancellationToken)

Lists the account alias associated with the AWS 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.

Public Method ListAccountAliasesAsync(ListAccountAliasesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAccountAliases operation.

Public Method ListAttachedGroupPolicies(ListAttachedGroupPoliciesRequest)

Lists all managed policies that are attached to the specified IAM group.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.

Public Method ListAttachedGroupPoliciesAsync(ListAttachedGroupPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAttachedGroupPolicies operation.

Public Method ListAttachedRolePolicies(ListAttachedRolePoliciesRequest)

Lists all managed policies that are attached to the specified IAM role.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list.

Public Method ListAttachedRolePoliciesAsync(ListAttachedRolePoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAttachedRolePolicies operation.

Public Method ListAttachedUserPolicies(ListAttachedUserPoliciesRequest)

Lists all managed policies that are attached to the specified IAM user.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.

Public Method ListAttachedUserPoliciesAsync(ListAttachedUserPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAttachedUserPolicies operation.

Public Method ListEntitiesForPolicy(ListEntitiesForPolicyRequest)

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListEntitiesForPolicyAsync(ListEntitiesForPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the ListEntitiesForPolicy operation.

Public Method ListGroupPolicies(ListGroupPoliciesRequest)

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the action returns an empty list.

Public Method ListGroupPoliciesAsync(ListGroupPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListGroupPolicies operation.

Public Method ListGroups()

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListGroups(ListGroupsRequest)

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListGroupsAsync(CancellationToken)

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListGroupsAsync(ListGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the ListGroups operation.

Public Method ListGroupsForUser(ListGroupsForUserRequest)

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListGroupsForUserAsync(ListGroupsForUserRequest, CancellationToken)

Initiates the asynchronous execution of the ListGroupsForUser operation.

Public Method 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 MaxItems and Marker parameters.

Public Method 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 MaxItems and Marker parameters.

Public Method ListInstanceProfilesAsync(CancellationToken)

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 MaxItems and Marker parameters.

Public Method ListInstanceProfilesAsync(ListInstanceProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the ListInstanceProfiles operation.

Public Method ListInstanceProfilesForRole(ListInstanceProfilesForRoleRequest)

Lists the instance profiles that have the specified associated IAM 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 MaxItems and Marker parameters.

Public Method ListInstanceProfilesForRoleAsync(ListInstanceProfilesForRoleRequest, CancellationToken)

Initiates the asynchronous execution of the ListInstanceProfilesForRole operation.

Public Method ListMFADevices()

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices 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 for this API.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListMFADevices(ListMFADevicesRequest)

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices 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 for this API.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListMFADevicesAsync(CancellationToken)

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices 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 for this API.

You can paginate the results using the MaxItems and Marker parameters.

Public Method ListMFADevicesAsync(ListMFADevicesRequest, CancellationToken)

Initiates the asynchronous execution of the ListMFADevices operation.

Public Method ListOpenIDConnectProviders(ListOpenIDConnectProvidersRequest)

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.

Public Method ListOpenIDConnectProvidersAsync(ListOpenIDConnectProvidersRequest, CancellationToken)

Initiates the asynchronous execution of the ListOpenIDConnectProviders operation.

Public Method ListPolicies()

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method ListPolicies(ListPoliciesRequest)

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method ListPoliciesAsync(CancellationToken)

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method ListPoliciesAsync(ListPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicies operation.

Public Method ListPolicyVersions(ListPolicyVersionsRequest)

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method ListPolicyVersionsAsync(ListPolicyVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicyVersions operation.

Public Method ListRolePolicies(ListRolePoliciesRequest)

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the action returns an empty list.

Public Method ListRolePoliciesAsync(ListRolePoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListRolePolicies operation.

Public Method ListRoles()

Lists the IAM 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 MaxItems and Marker parameters.

Public Method ListRoles(ListRolesRequest)

Lists the IAM 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 MaxItems and Marker parameters.

Public Method ListRolesAsync(CancellationToken)

Lists the IAM 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 MaxItems and Marker parameters.

Public Method ListRolesAsync(ListRolesRequest, CancellationToken)

Initiates the asynchronous execution of the ListRoles operation.

Public Method ListSAMLProviders()

Lists the SAML provider resource objects defined in IAM in the account.

This operation requires Signature Version 4.

Public Method ListSAMLProviders(ListSAMLProvidersRequest)

Lists the SAML provider resource objects defined in IAM in the account.

This operation requires Signature Version 4.

Public Method ListSAMLProvidersAsync(CancellationToken)

Lists the SAML provider resource objects defined in IAM in the account.

This operation requires Signature Version 4.

Public Method ListSAMLProvidersAsync(ListSAMLProvidersRequest, CancellationToken)

Initiates the asynchronous execution of the ListSAMLProviders operation.

Public Method ListServerCertificates()

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

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.

Public Method ListServerCertificates(ListServerCertificatesRequest)

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

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.

Public Method ListServerCertificatesAsync(CancellationToken)

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

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.

Public Method ListServerCertificatesAsync(ListServerCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListServerCertificates operation.

Public Method ListServiceSpecificCredentials(ListServiceSpecificCredentialsRequest)

Returns information about the service-specific credentials associated with the specified IAM user. If there are none, the action returns an empty list. The service-specific credentials returned by this action are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide.

Public Method ListServiceSpecificCredentialsAsync(ListServiceSpecificCredentialsRequest, CancellationToken)

Initiates the asynchronous execution of the ListServiceSpecificCredentials operation.

Public Method ListSigningCertificates()

Returns information about the signing certificates associated with the specified IAM 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 MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. 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.

Public Method ListSigningCertificates(ListSigningCertificatesRequest)

Returns information about the signing certificates associated with the specified IAM 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 MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. 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.

Public Method ListSigningCertificatesAsync(CancellationToken)

Returns information about the signing certificates associated with the specified IAM 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 MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. 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.

Public Method ListSigningCertificatesAsync(ListSigningCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListSigningCertificates operation.

Public Method 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 MaxItems and Marker parameters.

Public Method ListSSHPublicKeysAsync(ListSSHPublicKeysRequest, CancellationToken)

Initiates the asynchronous execution of the ListSSHPublicKeys operation.

Public Method ListUserPolicies(ListUserPoliciesRequest)

Lists the names of the inline policies embedded in the specified IAM user.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the action returns an empty list.

Public Method ListUserPoliciesAsync(ListUserPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListUserPolicies operation.

Public Method 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 MaxItems and Marker parameters.

Public Method 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 MaxItems and Marker parameters.

Public Method ListUsersAsync(CancellationToken)

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 MaxItems and Marker parameters.

Public Method ListUsersAsync(ListUsersRequest, CancellationToken)

Initiates the asynchronous execution of the ListUsers operation.

Public Method ListVirtualMFADevices()

Lists the virtual MFA devices defined in 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 MaxItems and Marker parameters.

Public Method ListVirtualMFADevices(ListVirtualMFADevicesRequest)

Lists the virtual MFA devices defined in 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 MaxItems and Marker parameters.

Public Method ListVirtualMFADevicesAsync(CancellationToken)

Lists the virtual MFA devices defined in 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 MaxItems and Marker parameters.

Public Method ListVirtualMFADevicesAsync(ListVirtualMFADevicesRequest, CancellationToken)

Initiates the asynchronous execution of the ListVirtualMFADevices operation.

Public Method PutGroupPolicy(PutGroupPolicyRequest)

Adds or updates an inline policy document that is embedded in the specified IAM 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, see 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.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

Public Method PutGroupPolicyAsync(PutGroupPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutGroupPolicy operation.

Public Method PutRolePolicy(PutRolePolicyRequest)

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of 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 IAM 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, see 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.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

Public Method PutRolePolicyAsync(PutRolePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutRolePolicy operation.

Public Method PutUserPolicy(PutUserPolicyRequest)

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM 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, see 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.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

Public Method PutUserPolicyAsync(PutUserPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutUserPolicy operation.

Public Method RemoveClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest)

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This action is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

Public Method RemoveClientIDFromOpenIDConnectProviderAsync(RemoveClientIDFromOpenIDConnectProviderRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveClientIDFromOpenIDConnectProvider operation.

Public Method RemoveRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest)

Removes the specified IAM role from the specified EC2 instance profile.

Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

Public Method RemoveRoleFromInstanceProfileAsync(RemoveRoleFromInstanceProfileRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveRoleFromInstanceProfile operation.

Public Method RemoveUserFromGroup(RemoveUserFromGroupRequest)

Removes the specified user from the specified group.

Public Method RemoveUserFromGroupAsync(RemoveUserFromGroupRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveUserFromGroup operation.

Public Method ResetServiceSpecificCredential(ResetServiceSpecificCredentialRequest)

Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

Public Method ResetServiceSpecificCredentialAsync(ResetServiceSpecificCredentialRequest, CancellationToken)

Initiates the asynchronous execution of the ResetServiceSpecificCredential operation.

Public Method ResyncMFADevice(ResyncMFADeviceRequest)

Synchronizes the specified MFA device with its IAM resource object on the AWS servers.

For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

Public Method ResyncMFADeviceAsync(ResyncMFADeviceRequest, CancellationToken)

Initiates the asynchronous execution of the ResyncMFADevice operation.

Public Method 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, see Managed Policies and Inline Policies in the IAM User Guide.

Public Method SetDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the SetDefaultPolicyVersion operation.

Public Method 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 Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

Public Method SimulateCustomPolicyAsync(SimulateCustomPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the SimulateCustomPolicy operation.

Public Method 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 Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

Public Method SimulatePrincipalPolicyAsync(SimulatePrincipalPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the SimulatePrincipalPolicy operation.

Public Method 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 UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign 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 rotating keys, see Managing Keys and Certificates in the IAM User Guide.

Public Method UpdateAccessKeyAsync(UpdateAccessKeyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAccessKey operation.

Public Method 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.

Public Method 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.

Public Method UpdateAccountPasswordPolicyAsync(CancellationToken)

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.

Public Method UpdateAccountPasswordPolicyAsync(UpdateAccountPasswordPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAccountPasswordPolicy operation.

Public Method UpdateAssumeRolePolicy(UpdateAssumeRolePolicyRequest)

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

Public Method UpdateAssumeRolePolicyAsync(UpdateAssumeRolePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAssumeRolePolicy operation.

Public Method UpdateGroup(UpdateGroupRequest)

Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.

To change an IAM group name the requester must have appropriate permissions on both the source object and the target object. For example, to change "Managers" to "MGRs", the entity making the request must have permission on both "Managers" and "MGRs", or must have permission on all (*). For more information about permissions, see Permissions and Policies.

Public Method UpdateGroupAsync(UpdateGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateGroup operation.

Public Method UpdateLoginProfile(UpdateLoginProfileRequest)

Changes the password for the specified IAM user.

IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.

Public Method UpdateLoginProfileAsync(UpdateLoginProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateLoginProfile operation.

Public Method UpdateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest)

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

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 fails until the certificate thumbprint is updated.

Because trust for the OIDC provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the UpdateOpenIDConnectProviderThumbprint action to highly-privileged users.

Public Method UpdateOpenIDConnectProviderThumbprintAsync(UpdateOpenIDConnectProviderThumbprintRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateOpenIDConnectProviderThumbprint operation.

Public Method UpdateRoleDescription(UpdateRoleDescriptionRequest)

Modifies the description of a role.

Public Method UpdateRoleDescriptionAsync(UpdateRoleDescriptionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRoleDescription operation.

Public Method UpdateSAMLProvider(UpdateSAMLProviderRequest)

Updates the metadata document for an existing SAML provider resource object.

This operation requires Signature Version 4.

Public Method UpdateSAMLProviderAsync(UpdateSAMLProviderRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSAMLProvider operation.

Public Method UpdateServerCertificate(UpdateServerCertificateRequest)

Updates the name and/or the path of the specified server certificate stored in IAM.

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.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide.

To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from "ProductionCert" to "ProdCert", the entity making the request must have permission on "ProductionCert" and "ProdCert", or must have permission on all (*). For more information about permissions, see Access Management in the IAM User Guide.

Public Method UpdateServerCertificateAsync(UpdateServerCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateServerCertificate operation.

Public Method UpdateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest)

Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This action can be used to disable a user’s service-specific credential as part of a credential rotation work flow.

Public Method UpdateServiceSpecificCredentialAsync(UpdateServiceSpecificCredentialRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateServiceSpecificCredential operation.

Public Method UpdateSigningCertificate(UpdateSigningCertificateRequest)

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign 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.

Public Method UpdateSigningCertificateAsync(UpdateSigningCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSigningCertificate operation.

Public Method UpdateSSHPublicKey(UpdateSSHPublicKeyRequest)

Sets the status of an IAM user's 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.

Public Method UpdateSSHPublicKeyAsync(UpdateSSHPublicKeyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSSHPublicKey operation.

Public Method UpdateUser(UpdateUserRequest)

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide.

To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

Public Method UpdateUserAsync(UpdateUserRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUser operation.

Public Method 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.

We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide.

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.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling 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.

Public Method UploadServerCertificateAsync(UploadServerCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UploadServerCertificate operation.

Public Method UploadSigningCertificate(UploadSigningCertificateRequest)

Uploads an X.509 signing certificate and associates it with the specified IAM 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 UserName field is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign 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.

Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling 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 IAM User Guide.

Public Method UploadSigningCertificateAsync(UploadSigningCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UploadSigningCertificate operation.

Public Method 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.

Public Method UploadSSHPublicKeyAsync(UploadSSHPublicKeyRequest, CancellationToken)

Initiates the asynchronous execution of the UploadSSHPublicKey operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone