AWS SDK Version 2 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.

.NET Framework 4.5
 

Classes

NameDescription
Class AccessKey Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.
Class AccessKeyLastUsed Contains information about the last time an AWS access key was used.

This data type is used as a response element in the GetAccessKeyLastUsed action.

Class AccessKeyMetadata Contains information about an AWS access key, without its secret key.

This data type is used as a response element in the ListAccessKeys action.

Class AddClientIDToOpenIDConnectProviderRequest Container for the parameters to the AddClientIDToOpenIDConnectProvider operation. Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider.

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

Class AddClientIDToOpenIDConnectProviderResponse
Class AddRoleToInstanceProfileRequest Container for the parameters to the AddRoleToInstanceProfile operation. Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
Class AddRoleToInstanceProfileResponse
Class AddUserToGroupRequest Container for the parameters to the AddUserToGroup operation. Adds the specified user to the specified group.
Class AddUserToGroupResponse
Class AttachedPolicyType Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Class AttachGroupPolicyRequest Container for the parameters to the AttachGroupPolicy operation. Attaches the specified managed policy to the specified group.

You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

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

Class AttachGroupPolicyResponse
Class AttachRolePolicyRequest Container for the parameters to the AttachRolePolicy operation. Attaches the specified managed policy to the specified role.

When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.

Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class AttachRolePolicyResponse
Class AttachUserPolicyRequest Container for the parameters to the AttachUserPolicy operation. Attaches the specified managed policy to the specified user.

You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.

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

Class AttachUserPolicyResponse
Class ChangePasswordRequest Container for the parameters to the ChangePassword operation. 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.

Class ChangePasswordResponse
Class ContextEntry Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulatePolicy.

Class CreateAccessKeyRequest Container for the parameters to the CreateAccessKey operation. 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.
Class CreateAccessKeyResponse Configuration for accessing Amazon CreateAccessKey service
Class CreateAccessKeyResult Contains the response to a successful CreateAccessKey request.
Class CreateAccountAliasRequest Container for the parameters to the CreateAccountAlias operation. 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.
Class CreateAccountAliasResponse
Class CreateGroupRequest Container for the parameters to the CreateGroup operation. Creates a new group.

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

Class CreateGroupResponse Configuration for accessing Amazon CreateGroup service
Class CreateGroupResult Contains the response to a successful CreateGroup request.
Class CreateInstanceProfileRequest Container for the parameters to the CreateInstanceProfile operation. 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.

Class CreateInstanceProfileResponse Configuration for accessing Amazon CreateInstanceProfile service
Class CreateInstanceProfileResult Contains the response to a successful CreateInstanceProfile request.
Class CreateLoginProfileRequest Container for the parameters to the CreateLoginProfile operation. Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide.
Class CreateLoginProfileResponse Configuration for accessing Amazon CreateLoginProfile service
Class CreateLoginProfileResult Contains the response to a successful CreateLoginProfile request.
Class CreateOpenIDConnectProviderRequest Container for the parameters to the CreateOpenIDConnectProvider operation. 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.
Class CreateOpenIDConnectProviderResponse Configuration for accessing Amazon CreateOpenIDConnectProvider service
Class CreateOpenIDConnectProviderResult Contains the response to a successful CreateOpenIDConnectProvider request.
Class CreatePolicyRequest Container for the parameters to the CreatePolicy operation. 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, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class CreatePolicyResponse Configuration for accessing Amazon CreatePolicy service
Class CreatePolicyResult Contains the response to a successful CreatePolicy request.
Class CreatePolicyVersionRequest Container for the parameters to the CreatePolicyVersion operation. Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

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

Class CreatePolicyVersionResponse Configuration for accessing Amazon CreatePolicyVersion service
Class CreatePolicyVersionResult Contains the response to a successful CreatePolicyVersion request.
Class CreateRoleRequest Container for the parameters to the CreateRole operation. 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.
Class CreateRoleResponse Configuration for accessing Amazon CreateRole service
Class CreateRoleResult Contains the response to a successful CreateRole request.
Class CreateSAMLProviderRequest Container for the parameters to the CreateSAMLProvider operation. Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.

The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

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.

Class CreateSAMLProviderResponse Configuration for accessing Amazon CreateSAMLProvider service
Class CreateSAMLProviderResult Contains the response to a successful CreateSAMLProvider request.
Class CreateUserRequest Container for the parameters to the CreateUser operation. Creates a new user for your AWS account.

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

Class CreateUserResponse Configuration for accessing Amazon CreateUser service
Class CreateUserResult Contains the response to a successful CreateUser request.
Class CreateVirtualMFADeviceRequest Container for the parameters to the CreateVirtualMFADevice operation. Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.

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

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.
Class CreateVirtualMFADeviceResponse Configuration for accessing Amazon CreateVirtualMFADevice service
Class CreateVirtualMFADeviceResult Contains the response to a successful CreateVirtualMFADevice request.
Class CredentialReportExpiredException IdentityManagementService exception
Class CredentialReportNotPresentException IdentityManagementService exception
Class CredentialReportNotReadyException IdentityManagementService exception
Class DeactivateMFADeviceRequest Container for the parameters to the DeactivateMFADevice operation. Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

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

Class DeactivateMFADeviceResponse
Class DeleteAccessKeyRequest Container for the parameters to the DeleteAccessKey operation. Deletes the access key associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

Class DeleteAccessKeyResponse
Class DeleteAccountAliasRequest Container for the parameters to the DeleteAccountAlias operation. 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.
Class DeleteAccountAliasResponse
Class DeleteAccountPasswordPolicyRequest Container for the parameters to the DeleteAccountPasswordPolicy operation. Deletes the password policy for the AWS account.
Class DeleteAccountPasswordPolicyResponse
Class DeleteConflictException IdentityManagementService exception
Class DeleteGroupPolicyRequest Container for the parameters to the DeleteGroupPolicy operation. Deletes the specified inline policy that is embedded in the specified group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class DeleteGroupPolicyResponse
Class DeleteGroupRequest Container for the parameters to the DeleteGroup operation. Deletes the specified group. The group must not contain any users or have any attached policies.
Class DeleteGroupResponse
Class DeleteInstanceProfileRequest Container for the parameters to the DeleteInstanceProfile operation. 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.

Class DeleteInstanceProfileResponse
Class DeleteLoginProfileRequest Container for the parameters to the DeleteLoginProfile operation. Deletes the password for the specified 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 IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
Class DeleteLoginProfileResponse
Class DeleteOpenIDConnectProviderRequest Container for the parameters to the DeleteOpenIDConnectProvider operation. Deletes an IAM OpenID Connect identity provider.

Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail.

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

Class DeleteOpenIDConnectProviderResponse
Class DeletePolicyRequest Container for the parameters to the DeletePolicy operation. Deletes the specified managed policy.

Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:

  1. 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.
  2. 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.
  3. Delete the policy (this automatically deletes the policy's default version) using this API.

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

Class DeletePolicyResponse
Class DeletePolicyVersionRequest Container for the parameters to the DeletePolicyVersion operation. Deletes the specified version of the specified managed policy.

You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

For information about versions for managed policies, refer to Versioning for Managed Policies in the IAM User Guide.

Class DeletePolicyVersionResponse
Class DeleteRolePolicyRequest Container for the parameters to the DeleteRolePolicy operation. Deletes the specified inline policy that is embedded in the specified role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class DeleteRolePolicyResponse
Class DeleteRoleRequest Container for the parameters to the DeleteRole operation. 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.
Class DeleteRoleResponse
Class DeleteSAMLProviderRequest Container for the parameters to the DeleteSAMLProvider operation. Deletes a SAML provider.

Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail.

This operation requires Signature Version 4.
Class DeleteSAMLProviderResponse
Class DeleteServerCertificateRequest Container for the parameters to the DeleteServerCertificate operation. 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.
Class DeleteServerCertificateResponse
Class DeleteSigningCertificateRequest Container for the parameters to the DeleteSigningCertificate operation. Deletes the specified signing certificate associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

Class DeleteSigningCertificateResponse
Class DeleteSSHPublicKeyRequest Container for the parameters to the DeleteSSHPublicKey operation. 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.

Class DeleteSSHPublicKeyResponse
Class DeleteUserPolicyRequest Container for the parameters to the DeleteUserPolicy operation. Deletes the specified inline policy that is embedded in the specified user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class DeleteUserPolicyResponse
Class DeleteUserRequest Container for the parameters to the DeleteUser operation. Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.
Class DeleteUserResponse
Class DeleteVirtualMFADeviceRequest Container for the parameters to the DeleteVirtualMFADevice operation. 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.
Class DeleteVirtualMFADeviceResponse
Class DetachGroupPolicyRequest Container for the parameters to the DetachGroupPolicy operation. Removes the specified managed policy from the specified group.

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

Class DetachGroupPolicyResponse
Class DetachRolePolicyRequest Container for the parameters to the DetachRolePolicy operation. Removes the specified managed policy from the specified role.

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

Class DetachRolePolicyResponse
Class DetachUserPolicyRequest Container for the parameters to the DetachUserPolicy operation. Removes the specified managed policy from the specified user.

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

Class DetachUserPolicyResponse
Class DuplicateCertificateException IdentityManagementService exception
Class DuplicateSSHPublicKeyException IdentityManagementService exception
Class EnableMFADeviceRequest Container for the parameters to the EnableMFADevice operation. Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.
Class EnableMFADeviceResponse
Class EntityAlreadyExistsException IdentityManagementService exception
Class EntityTemporarilyUnmodifiableException IdentityManagementService exception
Class EvaluationResult Contains the results of a simulation.

This data type is used by the return parameter of SimulatePolicy.

Class GenerateCredentialReportRequest Container for the parameters to the GenerateCredentialReport operation. Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
Class GenerateCredentialReportResponse Configuration for accessing Amazon GenerateCredentialReport service
Class GenerateCredentialReportResult Contains the response to a successful GenerateCredentialReport request.
Class GetAccessKeyLastUsedRequest Container for the parameters to the GetAccessKeyLastUsed operation. 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.
Class GetAccessKeyLastUsedResponse Configuration for accessing Amazon GetAccessKeyLastUsed service
Class GetAccessKeyLastUsedResult Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.
Class GetAccountAuthorizationDetailsRequest Container for the parameters to the GetAccountAuthorizationDetails operation. Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

Class GetAccountAuthorizationDetailsResponse Configuration for accessing Amazon GetAccountAuthorizationDetails service
Class GetAccountAuthorizationDetailsResult Contains the response to a successful GetAccountAuthorizationDetails request.
Class GetAccountPasswordPolicyRequest Container for the parameters to the GetAccountPasswordPolicy operation. Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
Class GetAccountPasswordPolicyResponse Configuration for accessing Amazon GetAccountPasswordPolicy service
Class GetAccountPasswordPolicyResult Contains the response to a successful GetAccountPasswordPolicy request.
Class GetAccountSummaryRequest Container for the parameters to the GetAccountSummary operation. 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.

Class GetAccountSummaryResponse Configuration for accessing Amazon GetAccountSummary service
Class GetAccountSummaryResult Contains the response to a successful GetAccountSummary request.
Class GetContextKeysForCustomPolicyRequest Container for the parameters to the GetContextKeysForCustomPolicy operation. Gets a list of all of the context keys referenced in Condition elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the Condition element of 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.

Class GetContextKeysForCustomPolicyResponse Configuration for accessing Amazon GetContextKeysForCustomPolicy service
Class GetContextKeysForCustomPolicyResult Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
Class GetContextKeysForPrincipalPolicyRequest Container for the parameters to the GetContextKeysForPrincipalPolicy operation. Gets a list of all of the context keys referenced in Condition elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the Condition element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Class GetContextKeysForPrincipalPolicyResponse Configuration for accessing Amazon GetContextKeysForPrincipalPolicy service
Class GetContextKeysForPrincipalPolicyResult Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
Class GetCredentialReportRequest Container for the parameters to the GetCredentialReport operation. Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
Class GetCredentialReportResponse Configuration for accessing Amazon GetCredentialReport service
Class GetCredentialReportResult Contains the response to a successful GetCredentialReport request.
Class GetGroupPolicyRequest Container for the parameters to the GetGroupPolicy operation. Retrieves the specified inline policy document that is embedded in the specified group.

A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

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

Class GetGroupPolicyResponse Configuration for accessing Amazon GetGroupPolicy service
Class GetGroupPolicyResult Contains the response to a successful GetGroupPolicy request.
Class GetGroupRequest Container for the parameters to the GetGroup operation. Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.
Class GetGroupResponse Configuration for accessing Amazon GetGroup service
Class GetGroupResult Contains the response to a successful GetGroup request.
Class GetInstanceProfileRequest Container for the parameters to the GetInstanceProfile operation. Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles. For more information about ARNs, go to ARNs.
Class GetInstanceProfileResponse Configuration for accessing Amazon GetInstanceProfile service
Class GetInstanceProfileResult Contains the response to a successful GetInstanceProfile request.
Class GetLoginProfileRequest Container for the parameters to the GetLoginProfile operation. Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.
Class GetLoginProfileResponse Configuration for accessing Amazon GetLoginProfile service
Class GetLoginProfileResult Contains the response to a successful GetLoginProfile request.
Class GetOpenIDConnectProviderRequest Container for the parameters to the GetOpenIDConnectProvider operation. Returns information about the specified OpenID Connect provider.
Class GetOpenIDConnectProviderResponse Configuration for accessing Amazon GetOpenIDConnectProvider service
Class GetOpenIDConnectProviderResult Contains the response to a successful GetOpenIDConnectProvider request.
Class GetPolicyRequest Container for the parameters to the GetPolicy operation. Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use GetPolicyVersion.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

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

Class GetPolicyResponse Configuration for accessing Amazon GetPolicy service
Class GetPolicyResult Contains the response to a successful GetPolicy request.
Class GetPolicyVersionRequest Container for the parameters to the GetPolicyVersion operation. Retrieves information about the specified version of the specified managed policy, including the policy document.

To list the available versions for a policy, use ListPolicyVersions.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about the types of policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class GetPolicyVersionResponse Configuration for accessing Amazon GetPolicyVersion service
Class GetPolicyVersionResult Contains the response to a successful GetPolicyVersion request.
Class GetRolePolicyRequest Container for the parameters to the GetRolePolicy operation. Retrieves the specified inline policy document that is embedded with the specified role.

A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

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

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

Class GetRolePolicyResponse Configuration for accessing Amazon GetRolePolicy service
Class GetRolePolicyResult Contains the response to a successful GetRolePolicy request.
Class GetRoleRequest Container for the parameters to the GetRole operation. Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles.
Class GetRoleResponse Configuration for accessing Amazon GetRole service
Class GetRoleResult Contains the response to a successful GetRole request.
Class GetSAMLProviderRequest Container for the parameters to the GetSAMLProvider operation. Returns the SAML provider metadocument that was uploaded when the provider was created or updated. This operation requires Signature Version 4.
Class GetSAMLProviderResponse Configuration for accessing Amazon GetSAMLProvider service
Class GetSAMLProviderResult Contains the response to a successful GetSAMLProvider request.
Class GetServerCertificateRequest Container for the parameters to the GetServerCertificate operation. Retrieves information about the specified server certificate.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

Class GetServerCertificateResponse Configuration for accessing Amazon GetServerCertificate service
Class GetServerCertificateResult Contains the response to a successful GetServerCertificate request.
Class GetSSHPublicKeyRequest Container for the parameters to the GetSSHPublicKey operation. 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.

Class GetSSHPublicKeyResponse Configuration for accessing Amazon GetSSHPublicKey service
Class GetSSHPublicKeyResult Contains the response to a successful GetSSHPublicKey request.
Class GetUserPolicyRequest Container for the parameters to the GetUserPolicy operation. Retrieves the specified inline policy document that is embedded in the specified user.

A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

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

Class GetUserPolicyResponse Configuration for accessing Amazon GetUserPolicy service
Class GetUserPolicyResult Contains the response to a successful GetUserPolicy request.
Class GetUserRequest Container for the parameters to the GetUser operation. Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request.

Class GetUserResponse Configuration for accessing Amazon GetUser service
Class GetUserResult Contains the response to a successful GetUser request.
Class Group Contains information about an IAM group entity.

This data type is used as a response element in the following actions:

Class GroupDetail Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class InstanceProfile Contains information about an instance profile.

This data type is used as a response element in the following actions:

Class InvalidAuthenticationCodeException IdentityManagementService exception
Class InvalidCertificateException IdentityManagementService exception
Class InvalidInputException IdentityManagementService exception
Class InvalidPublicKeyException IdentityManagementService exception
Class InvalidUserTypeException IdentityManagementService exception
Class KeyPairMismatchException IdentityManagementService exception
Class LimitExceededException IdentityManagementService exception
Class ListAccessKeysRequest Container for the parameters to the ListAccessKeys operation. Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the 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.
Class ListAccessKeysResponse Configuration for accessing Amazon ListAccessKeys service
Class ListAccessKeysResult Contains the response to a successful ListAccessKeys request.
Class ListAccountAliasesRequest Container for the parameters to the ListAccountAliases operation. Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
Class ListAccountAliasesResponse Configuration for accessing Amazon ListAccountAliases service
Class ListAccountAliasesResult Contains the response to a successful ListAccountAliases request.
Class ListAttachedGroupPoliciesRequest Container for the parameters to the ListAttachedGroupPolicies operation. Lists all managed policies that are attached to the specified group.

A group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the 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.

Class ListAttachedGroupPoliciesResponse Configuration for accessing Amazon ListAttachedGroupPolicies service
Class ListAttachedGroupPoliciesResult Contains the response to a successful ListAttachedGroupPolicies request.
Class ListAttachedRolePoliciesRequest Container for the parameters to the ListAttachedRolePolicies operation. Lists all managed policies that are attached to the specified role.

A role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the 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.

Class ListAttachedRolePoliciesResponse Configuration for accessing Amazon ListAttachedRolePolicies service
Class ListAttachedRolePoliciesResult Contains the response to a successful ListAttachedRolePolicies request.
Class ListAttachedUserPoliciesRequest Container for the parameters to the ListAttachedUserPolicies operation. Lists all managed policies that are attached to the specified user.

A user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the 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.

Class ListAttachedUserPoliciesResponse Configuration for accessing Amazon ListAttachedUserPolicies service
Class ListAttachedUserPoliciesResult Contains the response to a successful ListAttachedUserPolicies request.
Class ListEntitiesForPolicyRequest Container for the parameters to the ListEntitiesForPolicy operation. Lists all 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.

Class ListEntitiesForPolicyResponse Configuration for accessing Amazon ListEntitiesForPolicy service
Class ListEntitiesForPolicyResult Contains the response to a successful ListEntitiesForPolicy request.
Class ListGroupPoliciesRequest Container for the parameters to the ListGroupPolicies operation. Lists the names of the inline policies that are embedded in the specified group.

A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

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

Class ListGroupPoliciesResponse Configuration for accessing Amazon ListGroupPolicies service
Class ListGroupPoliciesResult Contains the response to a successful ListGroupPolicies request.
Class ListGroupsForUserRequest Container for the parameters to the ListGroupsForUser operation. Lists the groups the specified user belongs to.

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

Class ListGroupsForUserResponse Configuration for accessing Amazon ListGroupsForUser service
Class ListGroupsForUserResult Contains the response to a successful ListGroupsForUser request.
Class ListGroupsRequest Container for the parameters to the ListGroups operation. Lists the groups that have the specified path prefix.

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

Class ListGroupsResponse Configuration for accessing Amazon ListGroups service
Class ListGroupsResult Contains the response to a successful ListGroups request.
Class ListInstanceProfilesForRoleRequest Container for the parameters to the ListInstanceProfilesForRole operation. Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

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

Class ListInstanceProfilesForRoleResponse Configuration for accessing Amazon ListInstanceProfilesForRole service
Class ListInstanceProfilesForRoleResult Contains the response to a successful ListInstanceProfilesForRole request.
Class ListInstanceProfilesRequest Container for the parameters to the ListInstanceProfiles operation. 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.

Class ListInstanceProfilesResponse Configuration for accessing Amazon ListInstanceProfiles service
Class ListInstanceProfilesResult Contains the response to a successful ListInstanceProfiles request.
Class ListMFADevicesRequest Container for the parameters to the ListMFADevices operation. Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.

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

Class ListMFADevicesResponse Configuration for accessing Amazon ListMFADevices service
Class ListMFADevicesResult Contains the response to a successful ListMFADevices request.
Class ListOpenIDConnectProvidersRequest Container for the parameters to the ListOpenIDConnectProviders operation. Lists information about the OpenID Connect providers in the AWS account.
Class ListOpenIDConnectProvidersResponse Configuration for accessing Amazon ListOpenIDConnectProviders service
Class ListOpenIDConnectProvidersResult Contains the response to a successful ListOpenIDConnectProviders request.
Class ListPoliciesRequest Container for the parameters to the ListPolicies operation. Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional 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, refer to Managed Policies and Inline Policies in the IAM User Guide.

Class ListPoliciesResponse Configuration for accessing Amazon ListPolicies service
Class ListPoliciesResult Contains the response to a successful ListPolicies request.
Class ListPolicyVersionsRequest Container for the parameters to the ListPolicyVersions operation. Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version.

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

Class ListPolicyVersionsResponse Configuration for accessing Amazon ListPolicyVersions service
Class ListPolicyVersionsResult Contains the response to a successful ListPolicyVersions request.
Class ListRolePoliciesRequest Container for the parameters to the ListRolePolicies operation. Lists the names of the inline policies that are embedded in the specified role.

A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

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

Class ListRolePoliciesResponse Configuration for accessing Amazon ListRolePolicies service
Class ListRolePoliciesResult Contains the response to a successful ListRolePolicies request.
Class ListRolesRequest Container for the parameters to the ListRoles operation. Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.

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

Class ListRolesResponse Configuration for accessing Amazon ListRoles service
Class ListRolesResult Contains the response to a successful ListRoles request.
Class ListSAMLProvidersRequest Container for the parameters to the ListSAMLProviders operation. Lists the SAML providers in the account. This operation requires Signature Version 4.
Class ListSAMLProvidersResponse Configuration for accessing Amazon ListSAMLProviders service
Class ListSAMLProvidersResult Contains the response to a successful ListSAMLProviders request.
Class ListServerCertificatesRequest Container for the parameters to the ListServerCertificates operation. Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the 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.

Class ListServerCertificatesResponse Configuration for accessing Amazon ListServerCertificates service
Class ListServerCertificatesResult Contains the response to a successful ListServerCertificates request.
Class ListSigningCertificatesRequest Container for the parameters to the ListSigningCertificates operation. Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the 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. 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.

Class ListSigningCertificatesResponse Configuration for accessing Amazon ListSigningCertificates service
Class ListSigningCertificatesResult Contains the response to a successful ListSigningCertificates request.
Class ListSSHPublicKeysRequest Container for the parameters to the ListSSHPublicKeys operation. 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.

Class ListSSHPublicKeysResponse Configuration for accessing Amazon ListSSHPublicKeys service
Class ListSSHPublicKeysResult Contains the response to a successful ListSSHPublicKeys request.
Class ListUserPoliciesRequest Container for the parameters to the ListUserPolicies operation. Lists the names of the inline policies embedded in the specified user.

A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

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

Class ListUserPoliciesResponse Configuration for accessing Amazon ListUserPolicies service
Class ListUserPoliciesResult Contains the response to a successful ListUserPolicies request.
Class ListUsersRequest Container for the parameters to the ListUsers operation. 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.

Class ListUsersResponse Configuration for accessing Amazon ListUsers service
Class ListUsersResult Contains the response to a successful ListUsers request.
Class ListVirtualMFADevicesRequest Container for the parameters to the ListVirtualMFADevices operation. Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

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

Class ListVirtualMFADevicesResponse Configuration for accessing Amazon ListVirtualMFADevices service
Class ListVirtualMFADevicesResult Contains the response to a successful ListVirtualMFADevices request.
Class LoginProfile Contains the user name and password create date for a user.

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile actions.

Class MalformedCertificateException IdentityManagementService exception
Class MalformedPolicyDocumentException IdentityManagementService exception
Class ManagedPolicy Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Class ManagedPolicyDetail Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

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

Class MFADevice Contains information about an MFA device.

This data type is used as a response element in the ListMFADevices action.

Class NoSuchEntityException IdentityManagementService exception
Class OpenIDConnectProviderListEntry Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.
Class PasswordPolicy Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy action.

Class PasswordPolicyViolationException IdentityManagementService exception
Class PolicyDetail Contains information about an IAM policy, including the policy document.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class PolicyEvaluationException IdentityManagementService exception
Class PolicyGroup Contains information about a group that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Class PolicyRole Contains information about a role that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Class PolicyUser Contains information about a user that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Class PolicyVersion Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Class Position Contains the row and column of a location of a Statement element in a policy document.

This data type is used as a member of the Statement type.

Class PutGroupPolicyRequest Container for the parameters to the PutGroupPolicy operation. Adds (or updates) an inline policy document that is embedded in the specified group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.

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 Using IAM guide.
Class PutGroupPolicyResponse
Class PutRolePolicyRequest Container for the parameters to the PutRolePolicy operation. Adds (or updates) an inline policy document that is embedded in the specified role.

When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.

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 Using IAM guide.
Class PutRolePolicyResponse
Class PutUserPolicyRequest Container for the parameters to the PutUserPolicy operation. Adds (or updates) an inline policy document that is embedded in the specified user.

A user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.

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 Using IAM guide.
Class PutUserPolicyResponse
Class RemoveClientIDFromOpenIDConnectProviderRequest Container for the parameters to the RemoveClientIDFromOpenIDConnectProvider operation. Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider.

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

Class RemoveClientIDFromOpenIDConnectProviderResponse
Class RemoveRoleFromInstanceProfileRequest Container for the parameters to the RemoveRoleFromInstanceProfile operation. Removes the specified role from the specified 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 will break any applications running on the instance.

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

Class RemoveRoleFromInstanceProfileResponse
Class RemoveUserFromGroupRequest Container for the parameters to the RemoveUserFromGroup operation. Removes the specified user from the specified group.
Class RemoveUserFromGroupResponse
Class ResourceSpecificResult Contains the result of the simulation of a single API action call on a single resource.

This data type is used by a member of the EvaluationResult data type.

Class ResyncMFADeviceRequest Container for the parameters to the ResyncMFADevice operation. Synchronizes the specified MFA device with AWS servers.

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

Class ResyncMFADeviceResponse
Class Role Contains information about an IAM role.

This data type is used as a response element in the following actions:

Class RoleDetail Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class SAMLProviderListEntry Contains the list of SAML providers for this account.
Class ServerCertificate Contains information about a server certificate.

This data type is used as a response element in the GetServerCertificate action.

Class ServerCertificateMetadata Contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates actions.

Class ServiceFailureException IdentityManagementService exception
Class SetDefaultPolicyVersionRequest Container for the parameters to the SetDefaultPolicyVersion operation. Sets the specified version of the specified policy as the policy's default (operative) version.

This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.

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

Class SetDefaultPolicyVersionResponse
Class SigningCertificate Contains information about an X.509 signing certificate.

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.

Class SimulateCustomPolicyRequest Container for the parameters to the SimulateCustomPolicy operation. 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.

Class SimulateCustomPolicyResponse Configuration for accessing Amazon SimulateCustomPolicy service
Class SimulateCustomPolicyResult Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
Class SimulatePrincipalPolicyRequest Container for the parameters to the SimulatePrincipalPolicy operation. 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.

Class SimulatePrincipalPolicyResponse Configuration for accessing Amazon SimulatePrincipalPolicy service
Class SimulatePrincipalPolicyResult Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
Class SSHPublicKey Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey actions.

Class SSHPublicKeyMetadata Contains information about an SSH public key, without the key's body or fingerprint.

This data type is used as a response element in the ListSSHPublicKeys action.

Class Statement Contains a reference to a Statement element in a policy document that determines the result of the simulation.

This data type is used by the MatchedStatements member of the EvaluationResult type.

Class UnrecognizedPublicKeyEncodingException IdentityManagementService exception
Class UpdateAccessKeyRequest Container for the parameters to the UpdateAccessKey operation. 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.

Class UpdateAccessKeyResponse
Class UpdateAccountPasswordPolicyRequest Container for the parameters to the UpdateAccountPasswordPolicy operation. 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.

Class UpdateAccountPasswordPolicyResponse
Class UpdateAssumeRolePolicyRequest Container for the parameters to the UpdateAssumeRolePolicy operation. Updates the policy that grants an entity permission to assume a role. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
Class UpdateAssumeRolePolicyResponse
Class UpdateGroupRequest Container for the parameters to the UpdateGroup operation. Updates the name and/or the path of the specified 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 a 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 Managers and MGRs, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
Class UpdateGroupResponse
Class UpdateLoginProfileRequest Container for the parameters to the UpdateLoginProfile operation. Changes the password for the specified user.

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

Class UpdateLoginProfileResponse
Class UpdateOpenIDConnectProviderThumbprintRequest Container for the parameters to the UpdateOpenIDConnectProviderThumbprint operation. Replaces the existing list of server certificate thumbprints with a new list.

The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated.

Because trust for the OpenID Connect 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.
Class UpdateOpenIDConnectProviderThumbprintResponse
Class UpdateSAMLProviderRequest Container for the parameters to the UpdateSAMLProvider operation. Updates the metadata document for an existing SAML provider. This operation requires Signature Version 4.
Class UpdateSAMLProviderResponse Configuration for accessing Amazon UpdateSAMLProvider service
Class UpdateSAMLProviderResult Contains the response to a successful UpdateSAMLProvider request.
Class UpdateServerCertificateRequest Container for the parameters to the UpdateServerCertificate operation. Updates the name and/or the path of the specified server certificate.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

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.
Class UpdateServerCertificateResponse
Class UpdateSigningCertificateRequest Container for the parameters to the UpdateSigningCertificate operation. Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow.

If the 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.

Class UpdateSigningCertificateResponse
Class UpdateSSHPublicKeyRequest Container for the parameters to the UpdateSSHPublicKey operation. Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

Class UpdateSSHPublicKeyResponse
Class UpdateUserRequest Container for the parameters to the UpdateUser operation. Updates the name and/or the path of the specified user. You should understand the implications of changing a user's path or name. For more information, see Renaming Users and Groups 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.
Class UpdateUserResponse
Class UploadServerCertificateRequest Container for the parameters to the UploadServerCertificate operation. Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.

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.
Class UploadServerCertificateResponse Configuration for accessing Amazon UploadServerCertificate service
Class UploadServerCertificateResult Contains the response to a successful UploadServerCertificate request.
Class UploadSigningCertificateRequest Container for the parameters to the UploadSigningCertificate operation. Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

If the UserName field is not specified, the 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 Using IAMguide.
Class UploadSigningCertificateResponse Configuration for accessing Amazon UploadSigningCertificate service
Class UploadSigningCertificateResult Contains the response to a successful UploadSigningCertificate request.
Class UploadSSHPublicKeyRequest Container for the parameters to the UploadSSHPublicKey operation. 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.

Class UploadSSHPublicKeyResponse Configuration for accessing Amazon UploadSSHPublicKey service
Class UploadSSHPublicKeyResult Contains the response to a successful UploadSSHPublicKey request.
Class User Contains information about an IAM user entity.

This data type is used as a response element in the following actions:

Class UserDetail Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class VirtualMFADevice Contains information about a virtual MFA device.