public class AmazonIdentityManagementClient extends AmazonWebServiceClient implements 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:
Constructor and Description |
---|
AmazonIdentityManagementClient()
Constructs a new client to invoke service methods on
AmazonIdentityManagement.
|
AmazonIdentityManagementClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonIdentityManagement using the specified AWS account credentials.
|
AmazonIdentityManagementClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonIdentityManagement using the specified AWS account credentials
and client configuration options.
|
AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonIdentityManagement using the specified AWS account credentials provider.
|
AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonIdentityManagement using the specified AWS account credentials
provider and client configuration options.
|
AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonIdentityManagement using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AmazonIdentityManagementClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonIdentityManagement.
|
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 |
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.
|
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
public AmazonIdentityManagementClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonIdentityManagementClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonIdentityManagement
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonIdentityManagementClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonIdentityManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonIdentityManagement
(ex: proxy settings, retry counts, etc.).public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonIdentityManagement
(ex: proxy settings, retry counts, etc.).public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonIdentityManagement
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic void deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access Management .
deleteAccountAlias
in interface AmazonIdentityManagement
deleteAccountAliasRequest
- Container for the necessary
parameters to execute the DeleteAccountAlias service method on
AmazonIdentityManagement.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.public ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems
and
Marker
parameters.
listGroups
in interface AmazonIdentityManagement
listGroupsRequest
- Container for the necessary parameters to
execute the ListGroups service method on AmazonIdentityManagement.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.public void deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
Deletes the access key associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this API to manage root credentials even if the AWS account has no associated users.
deleteAccessKey
in interface AmazonIdentityManagement
deleteAccessKeyRequest
- Container for the necessary parameters
to execute the DeleteAccessKey service method on
AmazonIdentityManagement.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.public void deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
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.
deleteVirtualMFADevice
in interface AmazonIdentityManagement
deleteVirtualMFADeviceRequest
- Container for the necessary
parameters to execute the DeleteVirtualMFADevice service method on
AmazonIdentityManagement.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.public void deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
Deletes the specified policy associated with the specified user.
deleteUserPolicy
in interface AmazonIdentityManagement
deleteUserPolicyRequest
- Container for the necessary parameters
to execute the DeleteUserPolicy service method on
AmazonIdentityManagement.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.public void putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
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.
putUserPolicy
in interface AmazonIdentityManagement
putUserPolicyRequest
- Container for the necessary parameters to
execute the PutUserPolicy service method on AmazonIdentityManagement.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.public ListServerCertificatesResult listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems
and
Marker
parameters.
listServerCertificates
in interface AmazonIdentityManagement
listServerCertificatesRequest
- Container for the necessary
parameters to execute the ListServerCertificates service method on
AmazonIdentityManagement.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.public ListSAMLProvidersResult listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
Lists the SAML providers in the account.
NOTE:This operation requires Signature Version 4.
listSAMLProviders
in interface AmazonIdentityManagement
listSAMLProvidersRequest
- Container for the necessary parameters
to execute the ListSAMLProviders service method on
AmazonIdentityManagement.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.public GetUserPolicyResult getUserPolicy(GetUserPolicyRequest getUserPolicyRequest)
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 .
getUserPolicy
in interface AmazonIdentityManagement
getUserPolicyRequest
- Container for the necessary parameters to
execute the GetUserPolicy service method on AmazonIdentityManagement.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.public void updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
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.
updateServerCertificate
in interface AmazonIdentityManagement
updateServerCertificateRequest
- Container for the necessary
parameters to execute the UpdateServerCertificate service method on
AmazonIdentityManagement.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.public void updateUser(UpdateUserRequest updateUserRequest)
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.
updateUser
in interface AmazonIdentityManagement
updateUserRequest
- Container for the necessary parameters to
execute the UpdateUser service method on AmazonIdentityManagement.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.public void putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
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.
putRolePolicy
in interface AmazonIdentityManagement
putRolePolicyRequest
- Container for the necessary parameters to
execute the PutRolePolicy service method on AmazonIdentityManagement.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.public void updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow.
If the 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 .
updateSigningCertificate
in interface AmazonIdentityManagement
updateSigningCertificateRequest
- Container for the necessary
parameters to execute the UpdateSigningCertificate service method on
AmazonIdentityManagement.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.public void deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
Deletes the specified policy that is associated with the specified group.
deleteGroupPolicy
in interface AmazonIdentityManagement
deleteGroupPolicyRequest
- Container for the necessary parameters
to execute the DeleteGroupPolicy service method on
AmazonIdentityManagement.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.public ListUsersResult listUsers(ListUsersRequest listUsersRequest)
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.
listUsers
in interface AmazonIdentityManagement
listUsersRequest
- Container for the necessary parameters to
execute the ListUsers service method on AmazonIdentityManagement.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.public void updateGroup(UpdateGroupRequest updateGroupRequest)
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.
updateGroup
in interface AmazonIdentityManagement
updateGroupRequest
- Container for the necessary parameters to
execute the UpdateGroup service method on AmazonIdentityManagement.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.public CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a new user for your AWS account.
For information about limitations on the number of users you can create, see Limitations on IAM Entities in Using AWS Identity and Access Management .
createUser
in interface AmazonIdentityManagement
createUserRequest
- Container for the necessary parameters to
execute the CreateUser service method on AmazonIdentityManagement.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.public void deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
Deletes a SAML provider.
Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail.
NOTE:This operation requires Signature Version 4.
deleteSAMLProvider
in interface AmazonIdentityManagement
deleteSAMLProviderRequest
- Container for the necessary
parameters to execute the DeleteSAMLProvider service method on
AmazonIdentityManagement.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.public void enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.
enableMFADevice
in interface AmazonIdentityManagement
enableMFADeviceRequest
- Container for the necessary parameters
to execute the EnableMFADevice service method on
AmazonIdentityManagement.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.public void deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account.
deleteAccountPasswordPolicy
in interface AmazonIdentityManagement
deleteAccountPasswordPolicyRequest
- Container for the necessary
parameters to execute the DeleteAccountPasswordPolicy service method
on AmazonIdentityManagement.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.public GetLoginProfileResult getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
Retrieves the user name and password-creation date for the specified
user. If the user has not been assigned a password, the action returns
a 404 ( NoSuchEntity
) error.
getLoginProfile
in interface AmazonIdentityManagement
getLoginProfileRequest
- Container for the necessary parameters
to execute the GetLoginProfile service method on
AmazonIdentityManagement.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.public UpdateSAMLProviderResult updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider.
NOTE:This operation requires Signature Version 4.
updateSAMLProvider
in interface AmazonIdentityManagement
updateSAMLProviderRequest
- Container for the necessary
parameters to execute the UpdateSAMLProvider service method on
AmazonIdentityManagement.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.public UploadServerCertificateResult uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest)
Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
For 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.
uploadServerCertificate
in interface AmazonIdentityManagement
uploadServerCertificateRequest
- Container for the necessary
parameters to execute the UploadServerCertificate service method on
AmazonIdentityManagement.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.public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
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 .
createGroup
in interface AmazonIdentityManagement
createGroupRequest
- Container for the necessary parameters to
execute the CreateGroup service method on AmazonIdentityManagement.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.public void createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest)
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 .
createAccountAlias
in interface AmazonIdentityManagement
createAccountAliasRequest
- Container for the necessary
parameters to execute the CreateAccountAlias service method on
AmazonIdentityManagement.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.public void deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.
deleteUser
in interface AmazonIdentityManagement
deleteUserRequest
- Container for the necessary parameters to
execute the DeleteUser service method on AmazonIdentityManagement.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.public void deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
deactivateMFADevice
in interface AmazonIdentityManagement
deactivateMFADeviceRequest
- Container for the necessary
parameters to execute the DeactivateMFADevice service method on
AmazonIdentityManagement.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.public void removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
Removes the specified user from the specified group.
removeUserFromGroup
in interface AmazonIdentityManagement
removeUserFromGroupRequest
- Container for the necessary
parameters to execute the RemoveUserFromGroup service method on
AmazonIdentityManagement.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.public void deleteRole(DeleteRoleRequest deleteRoleRequest)
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.
deleteRole
in interface AmazonIdentityManagement
deleteRoleRequest
- Container for the necessary parameters to
execute the DeleteRole service method on AmazonIdentityManagement.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.public void deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest)
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.
deleteServerCertificate
in interface AmazonIdentityManagement
deleteServerCertificateRequest
- Container for the necessary
parameters to execute the DeleteServerCertificate service method on
AmazonIdentityManagement.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.public CreateAccessKeyResult createAccessKey(CreateAccessKeyRequest createAccessKeyRequest)
Creates a new AWS secret access key and corresponding AWS access key
ID for the specified user. The default status for new keys is
Active
.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this 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.
createAccessKey
in interface AmazonIdentityManagement
createAccessKeyRequest
- Container for the necessary parameters
to execute the CreateAccessKey service method on
AmazonIdentityManagement.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.public GetUserResult getUser(GetUserRequest getUserRequest)
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.
getUser
in interface AmazonIdentityManagement
getUserRequest
- Container for the necessary parameters to
execute the GetUser service method on AmazonIdentityManagement.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.public void resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
Synchronizes the specified MFA device with AWS servers.
resyncMFADevice
in interface AmazonIdentityManagement
resyncMFADeviceRequest
- Container for the necessary parameters
to execute the ResyncMFADevice service method on
AmazonIdentityManagement.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.public ListMFADevicesResult listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.
You can paginate the results using the MaxItems
and
Marker
parameters.
listMFADevices
in interface AmazonIdentityManagement
listMFADevicesRequest
- Container for the necessary parameters to
execute the ListMFADevices service method on AmazonIdentityManagement.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.public CreateVirtualMFADeviceResult createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest)
Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in 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.
createVirtualMFADevice
in interface AmazonIdentityManagement
createVirtualMFADeviceRequest
- Container for the necessary
parameters to execute the CreateVirtualMFADevice service method on
AmazonIdentityManagement.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.public ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles .
You can paginate the results using the MaxItems
and
Marker
parameters.
listInstanceProfiles
in interface AmazonIdentityManagement
listInstanceProfilesRequest
- Container for the necessary
parameters to execute the ListInstanceProfiles service method on
AmazonIdentityManagement.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.public void updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest)
Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.
If the UserName
field is not specified, the UserName is
determined implicitly based on the AWS access key ID used to sign the
request. Because this action works for access keys under the AWS
account, 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 .
updateAccessKey
in interface AmazonIdentityManagement
updateAccessKeyRequest
- Container for the necessary parameters
to execute the UpdateAccessKey service method on
AmazonIdentityManagement.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.public void addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
Adds the specified user to the specified group.
addUserToGroup
in interface AmazonIdentityManagement
addUserToGroupRequest
- Container for the necessary parameters to
execute the AddUserToGroup service method on AmazonIdentityManagement.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.public GetGroupResult getGroup(GetGroupRequest getGroupRequest)
Returns a list of users that are in the specified group. You can
paginate the results using the MaxItems
and
Marker
parameters.
getGroup
in interface AmazonIdentityManagement
getGroupRequest
- Container for the necessary parameters to
execute the GetGroup service method on AmazonIdentityManagement.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.public ListAccountAliasesResult listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
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.
listAccountAliases
in interface AmazonIdentityManagement
listAccountAliasesRequest
- Container for the necessary
parameters to execute the ListAccountAliases service method on
AmazonIdentityManagement.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.public void deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes the specified group. The group must not contain any users or have any attached policies.
deleteGroup
in interface AmazonIdentityManagement
deleteGroupRequest
- Container for the necessary parameters to
execute the DeleteGroup service method on AmazonIdentityManagement.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.public 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. 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 .
getRole
in interface AmazonIdentityManagement
getRoleRequest
- Container for the necessary parameters to
execute the GetRole service method on AmazonIdentityManagement.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.public ListRolePoliciesResult listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
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.
listRolePolicies
in interface AmazonIdentityManagement
listRolePoliciesRequest
- Container for the necessary parameters
to execute the ListRolePolicies service method on
AmazonIdentityManagement.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.public ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list.
Although each user is limited to a small number of signing
certificates, you can still paginate the results using the
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.
listSigningCertificates
in interface AmazonIdentityManagement
listSigningCertificatesRequest
- Container for the necessary
parameters to execute the ListSigningCertificates service method on
AmazonIdentityManagement.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.public UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest)
Uploads an X.509 signing certificate and associates it with the
specified user. Some AWS services use X.509 signing certificates to
validate requests that are signed with a corresponding private key.
When you upload the certificate, its default status is
Active
.
If the 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.
uploadSigningCertificate
in interface AmazonIdentityManagement
uploadSigningCertificateRequest
- Container for the necessary
parameters to execute the UploadSigningCertificate service method on
AmazonIdentityManagement.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.public void deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
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 .
deleteInstanceProfile
in interface AmazonIdentityManagement
deleteInstanceProfileRequest
- Container for the necessary
parameters to execute the DeleteInstanceProfile service method on
AmazonIdentityManagement.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.public GetSAMLProviderResult getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the provider was created or updated.
NOTE:This operation requires Signature Version 4.
getSAMLProvider
in interface AmazonIdentityManagement
getSAMLProviderRequest
- Container for the necessary parameters
to execute the GetSAMLProvider service method on
AmazonIdentityManagement.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.public CreateRoleResult createRole(CreateRoleRequest createRoleRequest)
Creates a new role for your AWS account. For more information about roles, go to Working with Roles . For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in 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.
createRole
in interface AmazonIdentityManagement
createRoleRequest
- Container for the necessary parameters to
execute the CreateRole service method on AmazonIdentityManagement.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.public void updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
Changes the password for the specified user.
updateLoginProfile
in interface AmazonIdentityManagement
updateLoginProfileRequest
- Container for the necessary
parameters to execute the UpdateLoginProfile service method on
AmazonIdentityManagement.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.public 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.
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.
deleteLoginProfile
in interface AmazonIdentityManagement
deleteLoginProfileRequest
- Container for the necessary
parameters to execute the DeleteLoginProfile service method on
AmazonIdentityManagement.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.public void changePassword(ChangePasswordRequest changePasswordRequest)
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 .
changePassword
in interface AmazonIdentityManagement
changePasswordRequest
- Container for the necessary parameters to
execute the ChangePassword service method on AmazonIdentityManagement.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.public GetServerCertificateResult getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
Retrieves information about the specified server certificate.
getServerCertificate
in interface AmazonIdentityManagement
getServerCertificateRequest
- Container for the necessary
parameters to execute the GetServerCertificate service method on
AmazonIdentityManagement.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.public void putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
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.
putGroupPolicy
in interface AmazonIdentityManagement
putGroupPolicyRequest
- Container for the necessary parameters to
execute the PutGroupPolicy service method on AmazonIdentityManagement.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.public void deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
Deletes the specified signing certificate associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this API to manage root credentials even if the AWS account has no associated users.
deleteSigningCertificate
in interface AmazonIdentityManagement
deleteSigningCertificateRequest
- Container for the necessary
parameters to execute the DeleteSigningCertificate service method on
AmazonIdentityManagement.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.public ListUserPoliciesResult listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest)
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.
listUserPolicies
in interface AmazonIdentityManagement
listUserPoliciesRequest
- Container for the necessary parameters
to execute the ListUserPolicies service method on
AmazonIdentityManagement.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.public ListAccessKeysResult listAccessKeys(ListAccessKeysRequest listAccessKeysRequest)
Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still
paginate the results using the 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.
listAccessKeys
in interface AmazonIdentityManagement
listAccessKeysRequest
- Container for the necessary parameters to
execute the ListAccessKeys service method on AmazonIdentityManagement.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.public ListGroupsForUserResult listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the groups the specified user belongs to.
You can paginate the results using the MaxItems
and
Marker
parameters.
listGroupsForUser
in interface AmazonIdentityManagement
listGroupsForUserRequest
- Container for the necessary parameters
to execute the ListGroupsForUser service method on
AmazonIdentityManagement.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.public void addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles . For more information about instance profiles, go to About Instance Profiles .
addRoleToInstanceProfile
in interface AmazonIdentityManagement
addRoleToInstanceProfileRequest
- Container for the necessary
parameters to execute the AddRoleToInstanceProfile service method on
AmazonIdentityManagement.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.public GetGroupPolicyResult getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
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 .
getGroupPolicy
in interface AmazonIdentityManagement
getGroupPolicyRequest
- Container for the necessary parameters to
execute the GetGroupPolicy service method on AmazonIdentityManagement.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.public GetRolePolicyResult getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
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 .
getRolePolicy
in interface AmazonIdentityManagement
getRolePolicyRequest
- Container for the necessary parameters to
execute the GetRolePolicy service method on AmazonIdentityManagement.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.public ListInstanceProfilesForRoleResult listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles .
You can paginate the results using the MaxItems
and
Marker
parameters.
listInstanceProfilesForRole
in interface AmazonIdentityManagement
listInstanceProfilesForRoleRequest
- Container for the necessary
parameters to execute the ListInstanceProfilesForRole service method
on AmazonIdentityManagement.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.public ListVirtualMFADevicesResult listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
Lists the virtual MFA devices under the AWS account by assignment
status. If you do not specify an assignment status, the action returns
a list of all virtual MFA devices. Assignment status can be
Assigned
,
Unassigned
, or Any
.
You can paginate the results using the MaxItems
and
Marker
parameters.
listVirtualMFADevices
in interface AmazonIdentityManagement
listVirtualMFADevicesRequest
- Container for the necessary
parameters to execute the ListVirtualMFADevices service method on
AmazonIdentityManagement.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.public void deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
Deletes the specified policy associated with the specified role.
deleteRolePolicy
in interface AmazonIdentityManagement
deleteRolePolicyRequest
- Container for the necessary parameters
to execute the DeleteRolePolicy service method on
AmazonIdentityManagement.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.public CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates a new instance profile. For information about instance profiles, go to About Instance Profiles .
For information about the number of instance profiles you can create, see Limitations on IAM Entities in Using AWS Identity and Access Management .
createInstanceProfile
in interface AmazonIdentityManagement
createInstanceProfileRequest
- Container for the necessary
parameters to execute the CreateInstanceProfile service method on
AmazonIdentityManagement.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.public ListGroupPoliciesResult listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest)
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.
listGroupPolicies
in interface AmazonIdentityManagement
listGroupPoliciesRequest
- Container for the necessary parameters
to execute the ListGroupPolicies service method on
AmazonIdentityManagement.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.public 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. For more information about managing passwords, see Managing Passwords in Using IAM .
createLoginProfile
in interface AmazonIdentityManagement
createLoginProfileRequest
- Container for the necessary
parameters to execute the CreateLoginProfile service method on
AmazonIdentityManagement.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.public void removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
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 .
removeRoleFromInstanceProfile
in interface AmazonIdentityManagement
removeRoleFromInstanceProfileRequest
- Container for the
necessary parameters to execute the RemoveRoleFromInstanceProfile
service method on AmazonIdentityManagement.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.public void updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
Updates the password policy settings for the account. For more information about using a password policy, go to Managing an IAM Password Policy .
updateAccountPasswordPolicy
in interface AmazonIdentityManagement
updateAccountPasswordPolicyRequest
- Container for the necessary
parameters to execute the UpdateAccountPasswordPolicy service method
on AmazonIdentityManagement.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.public void updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
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 .
updateAssumeRolePolicy
in interface AmazonIdentityManagement
updateAssumeRolePolicyRequest
- Container for the necessary
parameters to execute the UpdateAssumeRolePolicy service method on
AmazonIdentityManagement.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.public GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles . For more information about ARNs, go to ARNs .
getInstanceProfile
in interface AmazonIdentityManagement
getInstanceProfileRequest
- Container for the necessary
parameters to execute the GetInstanceProfile service method on
AmazonIdentityManagement.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.public ListRolesResult listRoles(ListRolesRequest listRolesRequest)
Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles .
You can paginate the results using the 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 .
listRoles
in interface AmazonIdentityManagement
listRolesRequest
- Container for the necessary parameters to
execute the ListRoles service method on AmazonIdentityManagement.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.public GetAccountSummaryResult getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest)
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 .
getAccountSummary
in interface AmazonIdentityManagement
getAccountSummaryRequest
- Container for the necessary parameters
to execute the GetAccountSummary service method on
AmazonIdentityManagement.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.public CreateSAMLProviderResult createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest)
Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
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.
createSAMLProvider
in interface AmazonIdentityManagement
createSAMLProviderRequest
- Container for the necessary
parameters to execute the CreateSAMLProvider service method on
AmazonIdentityManagement.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.public GetAccountPasswordPolicyResult getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest)
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy .
getAccountPasswordPolicy
in interface AmazonIdentityManagement
getAccountPasswordPolicyRequest
- Container for the necessary
parameters to execute the GetAccountPasswordPolicy service method on
AmazonIdentityManagement.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.public 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.
listGroups
in interface AmazonIdentityManagement
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.public 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.
listServerCertificates
in interface AmazonIdentityManagement
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.public ListSAMLProvidersResult listSAMLProviders() throws AmazonServiceException, AmazonClientException
Lists the SAML providers in the account.
NOTE:This operation requires Signature Version 4.
listSAMLProviders
in interface AmazonIdentityManagement
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.public 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.
listUsers
in interface AmazonIdentityManagement
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.public void deleteAccountPasswordPolicy() throws AmazonServiceException, AmazonClientException
Deletes the password policy for the AWS account.
deleteAccountPasswordPolicy
in interface AmazonIdentityManagement
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.public 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.
createAccessKey
in interface AmazonIdentityManagement
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.public 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.
getUser
in interface AmazonIdentityManagement
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.public 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.
listMFADevices
in interface AmazonIdentityManagement
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.public 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.
listInstanceProfiles
in interface AmazonIdentityManagement
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.public 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.
listAccountAliases
in interface AmazonIdentityManagement
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.public 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.
listSigningCertificates
in interface AmazonIdentityManagement
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.public 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.
listAccessKeys
in interface AmazonIdentityManagement
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.public 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.
listVirtualMFADevices
in interface AmazonIdentityManagement
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.public 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 .
listRoles
in interface AmazonIdentityManagement
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.public 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 .
getAccountSummary
in interface AmazonIdentityManagement
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.public 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 .
getAccountPasswordPolicy
in interface AmazonIdentityManagement
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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonIdentityManagement
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.