com.amazonaws.services.identitymanagement

Interface AmazonIdentityManagement

All Known Subinterfaces:

AmazonIdentityManagementAsync

All Known Implementing Classes:

AmazonIdentityManagementAsyncClient, AmazonIdentityManagementClient

public interface AmazonIdentityManagement

Interface for accessing AmazonIdentityManagement. 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 the IAM API. For general information about IAM, see AWS Identity and Access Management (IAM) . For the user guide for IAM, see Using IAM .

NOTE: 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.

Using the IAM Query API, you make direct calls to the IAM web service. 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; although this limit is browser dependent, a typical limit is 2048 bytes. Therefore, for operations that require larger sizes, you must 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:

• AWS Security Credentials . This topic provides general information about the types of credentials used for accessing AWS.
• IAM Best Practices . This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.
• AWS Security Token Service . This guide describes how to create and use temporary security credentials.
• Signing AWS API Requests . This set of topics walk you through the process of signing a request using an access key ID and secret access key.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest) Adds the specified role to the specified instance profile.
void	addUserToGroup(AddUserToGroupRequest addUserToGroupRequest) Adds the specified user to the specified group.
void	changePassword(ChangePasswordRequest changePasswordRequest) Changes the password of the IAM user calling ChangePassword .
CreateAccessKeyResult	createAccessKey() Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
CreateAccessKeyResult	createAccessKey(CreateAccessKeyRequest createAccessKeyRequest) Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
void	createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest) This action creates an alias for your AWS account.
CreateGroupResult	createGroup(CreateGroupRequest createGroupRequest) Creates a new group.
CreateInstanceProfileResult	createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest) Creates a new instance profile.
CreateLoginProfileResult	createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest) Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console.
CreateRoleResult	createRole(CreateRoleRequest createRoleRequest) Creates a new role for your AWS account.
CreateSAMLProviderResult	createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest) Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
CreateUserResult	createUser(CreateUserRequest createUserRequest) Creates a new user for your AWS account.
CreateVirtualMFADeviceResult	createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest) Creates a new virtual MFA device for the AWS account.
void	deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest) Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
void	deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest) Deletes the access key associated with the specified user.
void	deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest) Deletes the specified AWS account alias.
void	deleteAccountPasswordPolicy() Deletes the password policy for the AWS account.
void	deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest) Deletes the password policy for the AWS account.
void	deleteGroup(DeleteGroupRequest deleteGroupRequest) Deletes the specified group.
void	deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest) Deletes the specified policy that is associated with the specified group.
void	deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest) Deletes the specified instance profile.
void	deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest) Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console.
void	deleteRole(DeleteRoleRequest deleteRoleRequest) Deletes the specified role.
void	deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest) Deletes the specified policy associated with the specified role.
void	deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest) Deletes a SAML provider.
void	deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest) Deletes the specified server certificate.
void	deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest) Deletes the specified signing certificate associated with the specified user.
void	deleteUser(DeleteUserRequest deleteUserRequest) Deletes the specified user.
void	deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest) Deletes the specified policy associated with the specified user.
void	deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest) Deletes a virtual MFA device.
void	enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest) Enables the specified MFA device and associates it with the specified user name.
GetAccountPasswordPolicyResult	getAccountPasswordPolicy() Retrieves the password policy for the AWS account.
GetAccountPasswordPolicyResult	getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest) Retrieves the password policy for the AWS account.
GetAccountSummaryResult	getAccountSummary() Retrieves account level information about account entity usage and IAM quotas.
GetAccountSummaryResult	getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest) Retrieves account level information about account entity usage and IAM quotas.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetGroupResult	getGroup(GetGroupRequest getGroupRequest) Returns a list of users that are in the specified group.
GetGroupPolicyResult	getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest) Retrieves the specified policy document for the specified group.
GetInstanceProfileResult	getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest) Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role.
GetLoginProfileResult	getLoginProfile(GetLoginProfileRequest getLoginProfileRequest) Retrieves the user name and password-creation date for the specified user.
GetRoleResult	getRole(GetRoleRequest getRoleRequest) Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to EC2 to assume the role.
GetRolePolicyResult	getRolePolicy(GetRolePolicyRequest getRolePolicyRequest) Retrieves the specified policy document for the specified role.
GetSAMLProviderResult	getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest) Returns the SAML provider metadocument that was uploaded when the provider was created or updated.
GetServerCertificateResult	getServerCertificate(GetServerCertificateRequest getServerCertificateRequest) Retrieves information about the specified server certificate.
GetUserResult	getUser() Retrieves information about the specified user, including the user's path, unique ID, and ARN.
GetUserResult	getUser(GetUserRequest getUserRequest) Retrieves information about the specified user, including the user's path, unique ID, and ARN.
GetUserPolicyResult	getUserPolicy(GetUserPolicyRequest getUserPolicyRequest) Retrieves the specified policy document for the specified user.
ListAccessKeysResult	listAccessKeys() Returns information about the access key IDs associated with the specified user.
ListAccessKeysResult	listAccessKeys(ListAccessKeysRequest listAccessKeysRequest) Returns information about the access key IDs associated with the specified user.
ListAccountAliasesResult	listAccountAliases() Lists the account aliases associated with the account.
ListAccountAliasesResult	listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest) Lists the account aliases associated with the account.
ListGroupPoliciesResult	listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest) Lists the names of the policies associated with the specified group.
ListGroupsResult	listGroups() Lists the groups that have the specified path prefix.
ListGroupsResult	listGroups(ListGroupsRequest listGroupsRequest) Lists the groups that have the specified path prefix.
ListGroupsForUserResult	listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest) Lists the groups the specified user belongs to.
ListInstanceProfilesResult	listInstanceProfiles() Lists the instance profiles that have the specified path prefix.
ListInstanceProfilesResult	listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest) Lists the instance profiles that have the specified path prefix.
ListInstanceProfilesForRoleResult	listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) Lists the instance profiles that have the specified associated role.
ListMFADevicesResult	listMFADevices() Lists the MFA devices.
ListMFADevicesResult	listMFADevices(ListMFADevicesRequest listMFADevicesRequest) Lists the MFA devices.
ListRolePoliciesResult	listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest) Lists the names of the policies associated with the specified role.
ListRolesResult	listRoles() Lists the roles that have the specified path prefix.
ListRolesResult	listRoles(ListRolesRequest listRolesRequest) Lists the roles that have the specified path prefix.
ListSAMLProvidersResult	listSAMLProviders() Lists the SAML providers in the account.
ListSAMLProvidersResult	listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest) Lists the SAML providers in the account.
ListServerCertificatesResult	listServerCertificates() Lists the server certificates that have the specified path prefix.
ListServerCertificatesResult	listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest) Lists the server certificates that have the specified path prefix.
ListSigningCertificatesResult	listSigningCertificates() Returns information about the signing certificates associated with the specified user.
ListSigningCertificatesResult	listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest) Returns information about the signing certificates associated with the specified user.
ListUserPoliciesResult	listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest) Lists the names of the policies associated with the specified user.
ListUsersResult	listUsers() Lists the users that have the specified path prefix.
ListUsersResult	listUsers(ListUsersRequest listUsersRequest) Lists the users that have the specified path prefix.
ListVirtualMFADevicesResult	listVirtualMFADevices() Lists the virtual MFA devices under the AWS account by assignment status.
ListVirtualMFADevicesResult	listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest) Lists the virtual MFA devices under the AWS account by assignment status.
void	putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest) Adds (or updates) a policy document associated with the specified group.
void	putRolePolicy(PutRolePolicyRequest putRolePolicyRequest) Adds (or updates) a policy document associated with the specified role.
void	putUserPolicy(PutUserPolicyRequest putUserPolicyRequest) Adds (or updates) a policy document associated with the specified user.
void	removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest) Removes the specified role from the specified instance profile.
void	removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest) Removes the specified user from the specified group.
void	resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest) Synchronizes the specified MFA device with AWS servers.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://iam.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
void	updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest) Changes the status of the specified access key from Active to Inactive, or vice versa.
void	updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest) Updates the password policy settings for the account.
void	updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest) Updates the policy that grants an entity permission to assume a role.
void	updateGroup(UpdateGroupRequest updateGroupRequest) Updates the name and/or the path of the specified group.
void	updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest) Changes the password for the specified user.
UpdateSAMLProviderResult	updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest) Updates the metadata document for an existing SAML provider.
void	updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest) Updates the name and/or the path of the specified server certificate.
void	updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest) Changes the status of the specified signing certificate from active to disabled, or vice versa.
void	updateUser(UpdateUserRequest updateUserRequest) Updates the name and/or the path of the specified user.
UploadServerCertificateResult	uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest) Uploads a server certificate entity for the AWS account.
UploadSigningCertificateResult	uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest) Uploads an X.509 signing certificate and associates it with the specified user.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://iam.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "iam.amazonaws.com") or a full URL, including the protocol (ex: "https://iam.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "iam.amazonaws.com") or a full URL, including the protocol (ex: "https://iam.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteAccountAlias

void deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access Management .

Parameters:

deleteAccountAliasRequest - Container for the necessary parameters to execute the DeleteAccountAlias service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listGroups

ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Lists the groups that have the specified path prefix.

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

Parameters:

listGroupsRequest - Container for the necessary parameters to execute the ListGroups service method on AmazonIdentityManagement.

Returns:

The response from the ListGroups service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteAccessKey

void deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
                     throws AmazonServiceException,
                            AmazonClientException

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 API to manage root credentials even if the AWS account has no associated users.

Parameters:

deleteAccessKeyRequest - Container for the necessary parameters to execute the DeleteAccessKey service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteVirtualMFADevice

void deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a virtual MFA device.

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

Parameters:

deleteVirtualMFADeviceRequest - Container for the necessary parameters to execute the DeleteVirtualMFADevice service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

DeleteConflictException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteUserPolicy

void deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Deletes the specified policy associated with the specified user.

Parameters:

deleteUserPolicyRequest - Container for the necessary parameters to execute the DeleteUserPolicy service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

putUserPolicy

void putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Adds (or updates) a policy document associated with the specified user. For information about policies, refer to Overview of Policies in Using AWS Identity and Access Management .

For information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in Using AWS Identity and Access Management .

NOTE:Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. 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 Using IAM.

Parameters:

putUserPolicyRequest - Container for the necessary parameters to execute the PutUserPolicy service method on AmazonIdentityManagement.

Throws:

MalformedPolicyDocumentException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listServerCertificates

ListServerCertificatesResult listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Parameters:

listServerCertificatesRequest - Container for the necessary parameters to execute the ListServerCertificates service method on AmazonIdentityManagement.

Returns:

The response from the ListServerCertificates service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listSAMLProviders

ListSAMLProvidersResult listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Lists the SAML providers in the account.

NOTE:This operation requires Signature Version 4.

Parameters:

listSAMLProvidersRequest - Container for the necessary parameters to execute the ListSAMLProviders service method on AmazonIdentityManagement.

Returns:

The response from the ListSAMLProviders service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getUserPolicy

GetUserPolicyResult getUserPolicy(GetUserPolicyRequest getUserPolicyRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Retrieves the specified policy document for the specified user. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

Parameters:

getUserPolicyRequest - Container for the necessary parameters to execute the GetUserPolicy service method on AmazonIdentityManagement.

Returns:

The response from the GetUserPolicy service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateServerCertificate

void updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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

IMPORTANT: You should understand the implications of changing a server certificate's path or name. For more information, see Managing Server Certificates in Using AWS Identity and Access Management.

NOTE: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 Permissions and Policies.

Parameters:

updateServerCertificateRequest - Container for the necessary parameters to execute the UpdateServerCertificate service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateUser

void updateUser(UpdateUserRequest updateUserRequest)
                throws AmazonServiceException,
                       AmazonClientException

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

IMPORTANT: You should understand the implications of changing a user's path or name. For more information, see Renaming Users and Groups in Using AWS Identity and Access Management.

NOTE: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.

Parameters:

updateUserRequest - Container for the necessary parameters to execute the UpdateUser service method on AmazonIdentityManagement.

Throws:

EntityTemporarilyUnmodifiableException

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

putRolePolicy

void putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Adds (or updates) a policy document associated with the specified role. For information about policies, go to Overview of Policies in Using AWS Identity and Access Management .

For information about limits on the policies you can associate with a role, see Limitations on IAM Entities in Using AWS Identity and Access Management .

NOTE:Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. 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 Using IAM.

Parameters:

putRolePolicyRequest - Container for the necessary parameters to execute the PutRolePolicy service method on AmazonIdentityManagement.

Throws:

MalformedPolicyDocumentException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateSigningCertificate

void updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

For information about rotating certificates, see Managing Keys and Certificates in Using AWS Identity and Access Management .

Parameters:

updateSigningCertificateRequest - Container for the necessary parameters to execute the UpdateSigningCertificate service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteGroupPolicy

void deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Deletes the specified policy that is associated with the specified group.

Parameters:

deleteGroupPolicyRequest - Container for the necessary parameters to execute the DeleteGroupPolicy service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listUsers

ListUsersResult listUsers(ListUsersRequest listUsersRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Lists the users that have the specified path prefix. If there are none, the action returns an empty list.

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

Parameters:

listUsersRequest - Container for the necessary parameters to execute the ListUsers service method on AmazonIdentityManagement.

Returns:

The response from the ListUsers service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateGroup

void updateGroup(UpdateGroupRequest updateGroupRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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

IMPORTANT: You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in Using AWS Identity and Access Management.

NOTE: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.

Parameters:

updateGroupRequest - Container for the necessary parameters to execute the UpdateGroup service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createUser

CreateUserResult createUser(CreateUserRequest createUserRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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 Using AWS Identity and Access Management .

Parameters:

createUserRequest - Container for the necessary parameters to execute the CreateUser service method on AmazonIdentityManagement.

Returns:

The response from the CreateUser service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteSAMLProvider

void deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
                        throws AmazonServiceException,
                               AmazonClientException

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.

NOTE:This operation requires Signature Version 4.

Parameters:

deleteSAMLProviderRequest - Container for the necessary parameters to execute the DeleteSAMLProvider service method on AmazonIdentityManagement.

Throws:

InvalidInputException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

enableMFADevice

void enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
                     throws AmazonServiceException,
                            AmazonClientException

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.

Parameters:

enableMFADeviceRequest - Container for the necessary parameters to execute the EnableMFADevice service method on AmazonIdentityManagement.

Throws:

EntityTemporarilyUnmodifiableException

NoSuchEntityException

InvalidAuthenticationCodeException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteAccountPasswordPolicy

void deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes the password policy for the AWS account.

Parameters:

deleteAccountPasswordPolicyRequest - Container for the necessary parameters to execute the DeleteAccountPasswordPolicy service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getLoginProfile

GetLoginProfileResult getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Parameters:

getLoginProfileRequest - Container for the necessary parameters to execute the GetLoginProfile service method on AmazonIdentityManagement.

Returns:

The response from the GetLoginProfile service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateSAMLProvider

UpdateSAMLProviderResult updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Updates the metadata document for an existing SAML provider.

NOTE:This operation requires Signature Version 4.

Parameters:

updateSAMLProviderRequest - Container for the necessary parameters to execute the UpdateSAMLProvider service method on AmazonIdentityManagement.

Returns:

The response from the UpdateSAMLProvider service method, as returned by AmazonIdentityManagement.

Throws:

InvalidInputException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

uploadServerCertificate

UploadServerCertificateResult uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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 information about the number of server certificates you can upload, see Limitations on IAM Entities in Using AWS Identity and Access Management .

NOTE: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 Making Query Requests in Using IAM.

Parameters:

uploadServerCertificateRequest - Container for the necessary parameters to execute the UploadServerCertificate service method on AmazonIdentityManagement.

Returns:

The response from the UploadServerCertificate service method, as returned by AmazonIdentityManagement.

Throws:

KeyPairMismatchException

MalformedCertificateException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createGroup

CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in Using AWS Identity and Access Management .

Parameters:

createGroupRequest - Container for the necessary parameters to execute the CreateGroup service method on AmazonIdentityManagement.

Returns:

The response from the CreateGroup service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createAccountAlias

void createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest)
                        throws AmazonServiceException,
                               AmazonClientException

This action 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 Using AWS Identity and Access Management .

Parameters:

createAccountAliasRequest - Container for the necessary parameters to execute the CreateAccountAlias service method on AmazonIdentityManagement.

Throws:

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteUser

void deleteUser(DeleteUserRequest deleteUserRequest)
                throws AmazonServiceException,
                       AmazonClientException

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

Parameters:

deleteUserRequest - Container for the necessary parameters to execute the DeleteUser service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

DeleteConflictException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deactivateMFADevice

void deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

Parameters:

deactivateMFADeviceRequest - Container for the necessary parameters to execute the DeactivateMFADevice service method on AmazonIdentityManagement.

Throws:

EntityTemporarilyUnmodifiableException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

removeUserFromGroup

void removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Removes the specified user from the specified group.

Parameters:

removeUserFromGroupRequest - Container for the necessary parameters to execute the RemoveUserFromGroup service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteRole

void deleteRole(DeleteRoleRequest deleteRoleRequest)
                throws AmazonServiceException,
                       AmazonClientException

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

IMPORTANT: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.

Parameters:

deleteRoleRequest - Container for the necessary parameters to execute the DeleteRole service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

DeleteConflictException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteServerCertificate

void deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Deletes the specified server certificate.

IMPORTANT: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.

Parameters:

deleteServerCertificateRequest - Container for the necessary parameters to execute the DeleteServerCertificate service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

DeleteConflictException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createAccessKey

CreateAccessKeyResult createAccessKey(CreateAccessKeyRequest createAccessKeyRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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 API 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 Using AWS Identity and Access Management .

IMPORTANT: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.

Parameters:

createAccessKeyRequest - Container for the necessary parameters to execute the CreateAccessKey service method on AmazonIdentityManagement.

Returns:

The response from the CreateAccessKey service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getUser

GetUserResult getUser(GetUserRequest getUserRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Retrieves information about the specified user, including the user's 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 signing the request.

Parameters:

getUserRequest - Container for the necessary parameters to execute the GetUser service method on AmazonIdentityManagement.

Returns:

The response from the GetUser service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

resyncMFADevice

void resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
                     throws AmazonServiceException,
                            AmazonClientException

Synchronizes the specified MFA device with AWS servers.

Parameters:

resyncMFADeviceRequest - Container for the necessary parameters to execute the ResyncMFADevice service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

InvalidAuthenticationCodeException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listMFADevices

ListMFADevicesResult listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

listMFADevicesRequest - Container for the necessary parameters to execute the ListMFADevices service method on AmazonIdentityManagement.

Returns:

The response from the ListMFADevices service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createVirtualMFADevice

CreateVirtualMFADeviceResult createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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 Using AWS Identity and Access Management .

For information about limits on the number of MFA devices you can create, see Limitations on Entities in Using AWS Identity and Access Management .

IMPORTANT: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.

Parameters:

createVirtualMFADeviceRequest - Container for the necessary parameters to execute the CreateVirtualMFADevice service method on AmazonIdentityManagement.

Returns:

The response from the CreateVirtualMFADevice service method, as returned by AmazonIdentityManagement.

Throws:

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listInstanceProfiles

ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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.

Parameters:

listInstanceProfilesRequest - Container for the necessary parameters to execute the ListInstanceProfiles service method on AmazonIdentityManagement.

Returns:

The response from the ListInstanceProfiles service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateAccessKey

void updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest)
                     throws AmazonServiceException,
                            AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

For information about rotating keys, see Managing Keys and Certificates in Using AWS Identity and Access Management .

Parameters:

updateAccessKeyRequest - Container for the necessary parameters to execute the UpdateAccessKey service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

addUserToGroup

void addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Adds the specified user to the specified group.

Parameters:

addUserToGroupRequest - Container for the necessary parameters to execute the AddUserToGroup service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getGroup

GetGroupResult getGroup(GetGroupRequest getGroupRequest)
                        throws AmazonServiceException,
                               AmazonClientException

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

Parameters:

getGroupRequest - Container for the necessary parameters to execute the GetGroup service method on AmazonIdentityManagement.

Returns:

The response from the GetGroup service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listAccountAliases

ListAccountAliasesResult listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Lists the account aliases associated with the account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access Management .

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

Parameters:

listAccountAliasesRequest - Container for the necessary parameters to execute the ListAccountAliases service method on AmazonIdentityManagement.

Returns:

The response from the ListAccountAliases service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteGroup

void deleteGroup(DeleteGroupRequest deleteGroupRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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

Parameters:

deleteGroupRequest - Container for the necessary parameters to execute the DeleteGroup service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

DeleteConflictException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getRole

GetRoleResult getRole(GetRoleRequest getRoleRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to EC2 to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles .

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

Parameters:

getRoleRequest - Container for the necessary parameters to execute the GetRole service method on AmazonIdentityManagement.

Returns:

The response from the GetRole service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listRolePolicies

ListRolePoliciesResult listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Lists the names of the policies associated with the specified role. If there are none, the action returns an empty list.

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

Parameters:

listRolePoliciesRequest - Container for the necessary parameters to execute the ListRolePolicies service method on AmazonIdentityManagement.

Returns:

The response from the ListRolePolicies service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listSigningCertificates

ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

Parameters:

listSigningCertificatesRequest - Container for the necessary parameters to execute the ListSigningCertificates service method on AmazonIdentityManagement.

Returns:

The response from the ListSigningCertificates service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

uploadSigningCertificate

UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

NOTE: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 Using IAM.

Parameters:

uploadSigningCertificateRequest - Container for the necessary parameters to execute the UploadSigningCertificate service method on AmazonIdentityManagement.

Returns:

The response from the UploadSigningCertificate service method, as returned by AmazonIdentityManagement.

Throws:

DuplicateCertificateException

InvalidCertificateException

MalformedCertificateException

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteInstanceProfile

void deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

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

IMPORTANT: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 .

Parameters:

deleteInstanceProfileRequest - Container for the necessary parameters to execute the DeleteInstanceProfile service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

DeleteConflictException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getSAMLProvider

GetSAMLProviderResult getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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

NOTE:This operation requires Signature Version 4.

Parameters:

getSAMLProviderRequest - Container for the necessary parameters to execute the GetSAMLProvider service method on AmazonIdentityManagement.

Returns:

The response from the GetSAMLProvider service method, as returned by AmazonIdentityManagement.

Throws:

InvalidInputException

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createRole

CreateRoleResult createRole(CreateRoleRequest createRoleRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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 Using AWS Identity and Access Management .

The policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html . Currently, only EC2 instances can assume roles.

Parameters:

createRoleRequest - Container for the necessary parameters to execute the CreateRole service method on AmazonIdentityManagement.

Returns:

The response from the CreateRole service method, as returned by AmazonIdentityManagement.

Throws:

MalformedPolicyDocumentException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateLoginProfile

void updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Changes the password for the specified user.

Parameters:

updateLoginProfileRequest - Container for the necessary parameters to execute the UpdateLoginProfile service method on AmazonIdentityManagement.

Throws:

PasswordPolicyViolationException

EntityTemporarilyUnmodifiableException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteLoginProfile

void deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
                        throws AmazonServiceException,
                               AmazonClientException

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

IMPORTANT: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.

Parameters:

deleteLoginProfileRequest - Container for the necessary parameters to execute the DeleteLoginProfile service method on AmazonIdentityManagement.

Throws:

EntityTemporarilyUnmodifiableException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

changePassword

void changePassword(ChangePasswordRequest changePasswordRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Changes the password of the IAM user calling ChangePassword . The root account password is not affected by this action. For information about modifying passwords, see Managing Passwords .

Parameters:

changePasswordRequest - Container for the necessary parameters to execute the ChangePassword service method on AmazonIdentityManagement.

Throws:

EntityTemporarilyUnmodifiableException

NoSuchEntityException

LimitExceededException

InvalidUserTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getServerCertificate

GetServerCertificateResult getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Retrieves information about the specified server certificate.

Parameters:

getServerCertificateRequest - Container for the necessary parameters to execute the GetServerCertificate service method on AmazonIdentityManagement.

Returns:

The response from the GetServerCertificate service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

putGroupPolicy

void putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Adds (or updates) a policy document associated with the specified group. For information about policies, refer to Overview of Policies in Using AWS Identity and Access Management .

For information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in Using AWS Identity and Access Management .

NOTE:Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. 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 Using IAM.

Parameters:

putGroupPolicyRequest - Container for the necessary parameters to execute the PutGroupPolicy service method on AmazonIdentityManagement.

Throws:

MalformedPolicyDocumentException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteSigningCertificate

void deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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 API to manage root credentials even if the AWS account has no associated users.

Parameters:

deleteSigningCertificateRequest - Container for the necessary parameters to execute the DeleteSigningCertificate service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listUserPolicies

ListUserPoliciesResult listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Lists the names of the policies associated with the specified user. If there are none, the action returns an empty list.

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

Parameters:

listUserPoliciesRequest - Container for the necessary parameters to execute the ListUserPolicies service method on AmazonIdentityManagement.

Returns:

The response from the ListUserPolicies service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listAccessKeys

ListAccessKeysResult listAccessKeys(ListAccessKeysRequest listAccessKeysRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

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

Parameters:

listAccessKeysRequest - Container for the necessary parameters to execute the ListAccessKeys service method on AmazonIdentityManagement.

Returns:

The response from the ListAccessKeys service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listGroupsForUser

ListGroupsForUserResult listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Lists the groups the specified user belongs to.

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

Parameters:

listGroupsForUserRequest - Container for the necessary parameters to execute the ListGroupsForUser service method on AmazonIdentityManagement.

Returns:

The response from the ListGroupsForUser service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

addRoleToInstanceProfile

void addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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 .

Parameters:

addRoleToInstanceProfileRequest - Container for the necessary parameters to execute the AddRoleToInstanceProfile service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getGroupPolicy

GetGroupPolicyResult getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Retrieves the specified policy document for the specified group. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

Parameters:

getGroupPolicyRequest - Container for the necessary parameters to execute the GetGroupPolicy service method on AmazonIdentityManagement.

Returns:

The response from the GetGroupPolicy service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getRolePolicy

GetRolePolicyResult getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Retrieves the specified policy document for the specified role. For more information about roles, go to Working with Roles .

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

Parameters:

getRolePolicyRequest - Container for the necessary parameters to execute the GetRolePolicy service method on AmazonIdentityManagement.

Returns:

The response from the GetRolePolicy service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listInstanceProfilesForRole

ListInstanceProfilesForRoleResult listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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.

Parameters:

listInstanceProfilesForRoleRequest - Container for the necessary parameters to execute the ListInstanceProfilesForRole service method on AmazonIdentityManagement.

Returns:

The response from the ListInstanceProfilesForRole service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listVirtualMFADevices

ListVirtualMFADevicesResult listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Parameters:

listVirtualMFADevicesRequest - Container for the necessary parameters to execute the ListVirtualMFADevices service method on AmazonIdentityManagement.

Returns:

The response from the ListVirtualMFADevices service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteRolePolicy

void deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Deletes the specified policy associated with the specified role.

Parameters:

deleteRolePolicyRequest - Container for the necessary parameters to execute the DeleteRolePolicy service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createInstanceProfile

CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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 Using AWS Identity and Access Management .

Parameters:

createInstanceProfileRequest - Container for the necessary parameters to execute the CreateInstanceProfile service method on AmazonIdentityManagement.

Returns:

The response from the CreateInstanceProfile service method, as returned by AmazonIdentityManagement.

Throws:

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listGroupPolicies

ListGroupPoliciesResult listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Lists the names of the policies associated with the specified group. If there are none, the action returns an empty list.

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

Parameters:

listGroupPoliciesRequest - Container for the necessary parameters to execute the ListGroupPolicies service method on AmazonIdentityManagement.

Returns:

The response from the ListGroupPolicies service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createLoginProfile

CreateLoginProfileResult createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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 Using IAM .

Parameters:

createLoginProfileRequest - Container for the necessary parameters to execute the CreateLoginProfile service method on AmazonIdentityManagement.

Returns:

The response from the CreateLoginProfile service method, as returned by AmazonIdentityManagement.

Throws:

PasswordPolicyViolationException

NoSuchEntityException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

removeRoleFromInstanceProfile

void removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Removes the specified role from the specified instance profile.

IMPORTANT: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 .

Parameters:

removeRoleFromInstanceProfileRequest - Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile service method on AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateAccountPasswordPolicy

void updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

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

Parameters:

updateAccountPasswordPolicyRequest - Container for the necessary parameters to execute the UpdateAccountPasswordPolicy service method on AmazonIdentityManagement.

Throws:

MalformedPolicyDocumentException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

updateAssumeRolePolicy

void updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Updates the policy that grants an entity permission to assume a role. Currently, only an Amazon EC2 instance can assume a role. For more information about roles, go to Working with Roles .

Parameters:

updateAssumeRolePolicyRequest - Container for the necessary parameters to execute the UpdateAssumeRolePolicy service method on AmazonIdentityManagement.

Throws:

MalformedPolicyDocumentException

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getInstanceProfile

GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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 .

Parameters:

getInstanceProfileRequest - Container for the necessary parameters to execute the GetInstanceProfile service method on AmazonIdentityManagement.

Returns:

The response from the GetInstanceProfile service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listRoles

ListRolesResult listRoles(ListRolesRequest listRolesRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

Parameters:

listRolesRequest - Container for the necessary parameters to execute the ListRoles service method on AmazonIdentityManagement.

Returns:

The response from the ListRoles service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getAccountSummary

GetAccountSummaryResult getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Retrieves account level information about account entity usage and IAM quotas.

For information about limitations on IAM entities, see Limitations on IAM Entities in Using AWS Identity and Access Management .

Parameters:

getAccountSummaryRequest - Container for the necessary parameters to execute the GetAccountSummary service method on AmazonIdentityManagement.

Returns:

The response from the GetAccountSummary service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createSAMLProvider

CreateSAMLProviderResult createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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.

NOTE:This operation requires Signature Version 4.

For more information, see Giving Console Access Using SAML and Creating Temporary Security Credentials for SAML Federation in the Using Temporary Credentials guide.

Parameters:

createSAMLProviderRequest - Container for the necessary parameters to execute the CreateSAMLProvider service method on AmazonIdentityManagement.

Returns:

The response from the CreateSAMLProvider service method, as returned by AmazonIdentityManagement.

Throws:

InvalidInputException

LimitExceededException

EntityAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getAccountPasswordPolicy

GetAccountPasswordPolicyResult getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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

Parameters:

getAccountPasswordPolicyRequest - Container for the necessary parameters to execute the GetAccountPasswordPolicy service method on AmazonIdentityManagement.

Returns:

The response from the GetAccountPasswordPolicy service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listGroups

ListGroupsResult listGroups()
                            throws AmazonServiceException,
                                   AmazonClientException

Lists the groups that have the specified path prefix.

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

Returns:

The response from the ListGroups service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listServerCertificates

ListServerCertificatesResult listServerCertificates()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Returns:

The response from the ListServerCertificates service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listSAMLProviders

ListSAMLProvidersResult listSAMLProviders()
                                          throws AmazonServiceException,
                                                 AmazonClientException

Lists the SAML providers in the account.

NOTE:This operation requires Signature Version 4.

Returns:

The response from the ListSAMLProviders service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listUsers

ListUsersResult listUsers()
                          throws AmazonServiceException,
                                 AmazonClientException

Lists the users that have the specified path prefix. If there are none, the action returns an empty list.

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

Returns:

The response from the ListUsers service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

deleteAccountPasswordPolicy

void deleteAccountPasswordPolicy()
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes the password policy for the AWS account.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

createAccessKey

CreateAccessKeyResult createAccessKey()
                                      throws AmazonServiceException,
                                             AmazonClientException

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 API 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 Using AWS Identity and Access Management .

IMPORTANT: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.

Returns:

The response from the CreateAccessKey service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getUser

GetUserResult getUser()
                      throws AmazonServiceException,
                             AmazonClientException

Retrieves information about the specified user, including the user's 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 signing the request.

Returns:

The response from the GetUser service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listMFADevices

ListMFADevicesResult listMFADevices()
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Returns:

The response from the ListMFADevices service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listInstanceProfiles

ListInstanceProfilesResult listInstanceProfiles()
                                                throws AmazonServiceException,
                                                       AmazonClientException

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.

Returns:

The response from the ListInstanceProfiles service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listAccountAliases

ListAccountAliasesResult listAccountAliases()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Lists the account aliases associated with the account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access Management .

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

Returns:

The response from the ListAccountAliases service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listSigningCertificates

ListSigningCertificatesResult listSigningCertificates()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

Returns:

The response from the ListSigningCertificates service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listAccessKeys

ListAccessKeysResult listAccessKeys()
                                    throws AmazonServiceException,
                                           AmazonClientException

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, this API can be used to manage root credentials even if the AWS account has no associated users.

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

Returns:

The response from the ListAccessKeys service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listVirtualMFADevices

ListVirtualMFADevicesResult listVirtualMFADevices()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Returns:

The response from the ListVirtualMFADevices service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

listRoles

ListRolesResult listRoles()
                          throws AmazonServiceException,
                                 AmazonClientException

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.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

Returns:

The response from the ListRoles service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getAccountSummary

GetAccountSummaryResult getAccountSummary()
                                          throws AmazonServiceException,
                                                 AmazonClientException

Retrieves account level information about account entity usage and IAM quotas.

For information about limitations on IAM entities, see Limitations on IAM Entities in Using AWS Identity and Access Management .

Returns:

The response from the GetAccountSummary service method, as returned by AmazonIdentityManagement.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

getAccountPasswordPolicy

GetAccountPasswordPolicyResult getAccountPasswordPolicy()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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

Returns:

The response from the GetAccountPasswordPolicy service method, as returned by AmazonIdentityManagement.

Throws:

NoSuchEntityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonIdentityManagement indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.