Interface AmazonIdentityManagement
-
- All Known Subinterfaces:
AmazonIdentityManagementAsync
- All Known Implementing Classes:
AbstractAmazonIdentityManagement
,AbstractAmazonIdentityManagementAsync
,AmazonIdentityManagementAsyncClient
,AmazonIdentityManagementClient
public interface AmazonIdentityManagement
Interface for accessing IAM.AWS Identity and Access Management AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
Additional Resources
For more information, see the following:
-
AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.
-
IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.
-
Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddClientIDToOpenIDConnectProviderResult
addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest addClientIDToOpenIDConnectProviderRequest)
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.AddRoleToInstanceProfileResult
addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
Adds the specified IAM role to the specified instance profile.AddUserToGroupResult
addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
Adds the specified user to the specified group.AttachGroupPolicyResult
attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest)
Attaches the specified managed policy to the specified IAM group.AttachRolePolicyResult
attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest)
Attaches the specified managed policy to the specified IAM role.AttachUserPolicyResult
attachUserPolicy(AttachUserPolicyRequest attachUserPolicyRequest)
Attaches the specified managed policy to the specified user.ChangePasswordResult
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password of the IAM user who is calling this action.CreateAccessKeyResult
createAccessKey()
Simplified method form for invoking the CreateAccessKey operation.CreateAccessKeyResult
createAccessKey(CreateAccessKeyRequest createAccessKeyRequest)
Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.CreateAccountAliasResult
createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest)
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.CreateOpenIDConnectProviderResult
createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest createOpenIDConnectProviderRequest)
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).CreatePolicyResult
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates a new managed policy for your AWS account.CreatePolicyVersionResult
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified managed policy.CreateRoleResult
createRole(CreateRoleRequest createRoleRequest)
Creates a new role for your AWS account.CreateSAMLProviderResult
createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest)
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.CreateUserResult
createUser(CreateUserRequest createUserRequest)
Creates a new IAM user for your AWS account.CreateVirtualMFADeviceResult
createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest)
Creates a new virtual MFA device for the AWS account.DeactivateMFADeviceResult
deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.DeleteAccessKeyResult
deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
Deletes the access key pair associated with the specified IAM user.DeleteAccountAliasResult
deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
Deletes the specified AWS account alias.DeleteAccountPasswordPolicyResult
deleteAccountPasswordPolicy()
Simplified method form for invoking the DeleteAccountPasswordPolicy operation.DeleteAccountPasswordPolicyResult
deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account.DeleteGroupResult
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes the specified IAM group.DeleteGroupPolicyResult
deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM group.DeleteInstanceProfileResult
deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile.DeleteLoginProfileResult
deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.DeleteOpenIDConnectProviderResult
deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest deleteOpenIDConnectProviderRequest)
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.DeletePolicyResult
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified managed policy.DeletePolicyVersionResult
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version from the specified managed policy.DeleteRoleResult
deleteRole(DeleteRoleRequest deleteRoleRequest)
Deletes the specified role.DeleteRolePolicyResult
deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM role.DeleteSAMLProviderResult
deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
Deletes a SAML provider resource in IAM.DeleteServerCertificateResult
deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest)
Deletes the specified server certificate.DeleteSigningCertificateResult
deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
Deletes a signing certificate associated with the specified IAM user.DeleteSSHPublicKeyResult
deleteSSHPublicKey(DeleteSSHPublicKeyRequest deleteSSHPublicKeyRequest)
Deletes the specified SSH public key.DeleteUserResult
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified IAM user.DeleteUserPolicyResult
deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM user.DeleteVirtualMFADeviceResult
deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
Deletes a virtual MFA device.DetachGroupPolicyResult
detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest)
Removes the specified managed policy from the specified IAM group.DetachRolePolicyResult
detachRolePolicy(DetachRolePolicyRequest detachRolePolicyRequest)
Removes the specified managed policy from the specified role.DetachUserPolicyResult
detachUserPolicy(DetachUserPolicyRequest detachUserPolicyRequest)
Removes the specified managed policy from the specified user.EnableMFADeviceResult
enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified IAM user.GenerateCredentialReportResult
generateCredentialReport()
Simplified method form for invoking the GenerateCredentialReport operation.GenerateCredentialReportResult
generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest)
Generates a credential report for the AWS account.GetAccessKeyLastUsedResult
getAccessKeyLastUsed(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest)
Retrieves information about when the specified access key was last used.GetAccountAuthorizationDetailsResult
getAccountAuthorizationDetails()
Simplified method form for invoking the GetAccountAuthorizationDetails operation.GetAccountAuthorizationDetailsResult
getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another.GetAccountPasswordPolicyResult
getAccountPasswordPolicy()
Simplified method form for invoking the GetAccountPasswordPolicy operation.GetAccountPasswordPolicyResult
getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest)
Retrieves the password policy for the AWS account.GetAccountSummaryResult
getAccountSummary()
Simplified method form for invoking the GetAccountSummary operation.GetAccountSummaryResult
getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest)
Retrieves information about IAM entity usage and IAM quotas in the AWS account.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.GetContextKeysForCustomPolicyResult
getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest)
Gets a list of all of the context keys referenced in the input policies.GetContextKeysForPrincipalPolicyResult
getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity.GetCredentialReportResult
getCredentialReport()
Simplified method form for invoking the GetCredentialReport operation.GetCredentialReportResult
getCredentialReport(GetCredentialReportRequest getCredentialReportRequest)
Retrieves a credential report for the AWS account.GetGroupResult
getGroup(GetGroupRequest getGroupRequest)
Returns a list of IAM users that are in the specified IAM group.GetGroupPolicyResult
getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM 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 IAM user.GetOpenIDConnectProviderResult
getOpenIDConnectProvider(GetOpenIDConnectProviderRequest getOpenIDConnectProviderRequest)
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.GetPolicyResult
getPolicy(GetPolicyRequest getPolicyRequest)
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached.GetPolicyVersionResult
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Retrieves information about the specified version of the specified managed policy, including the policy document.GetRoleResult
getRole(GetRoleRequest getRoleRequest)
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role.GetRolePolicyResult
getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
Retrieves the specified inline policy document that is embedded with the specified IAM role.GetSAMLProviderResult
getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.GetServerCertificateResult
getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
Retrieves information about the specified server certificate stored in IAM.GetSSHPublicKeyResult
getSSHPublicKey(GetSSHPublicKeyRequest getSSHPublicKeyRequest)
Retrieves the specified SSH public key, including metadata about the key.GetUserResult
getUser()
Simplified method form for invoking the GetUser operation.GetUserResult
getUser(GetUserRequest getUserRequest)
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.GetUserPolicyResult
getUserPolicy(GetUserPolicyRequest getUserPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM user.ListAccessKeysResult
listAccessKeys()
Simplified method form for invoking the ListAccessKeys operation.ListAccessKeysResult
listAccessKeys(ListAccessKeysRequest listAccessKeysRequest)
Returns information about the access key IDs associated with the specified IAM user.ListAccountAliasesResult
listAccountAliases()
Simplified method form for invoking the ListAccountAliases operation.ListAccountAliasesResult
listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the AWS account (Note: you can have only one).ListAttachedGroupPoliciesResult
listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified IAM group.ListAttachedRolePoliciesResult
listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified IAM role.ListAttachedUserPoliciesResult
listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified IAM user.ListEntitiesForPolicyResult
listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.ListGroupPoliciesResult
listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM group.ListGroupsResult
listGroups()
Simplified method form for invoking the ListGroups operation.ListGroupsResult
listGroups(ListGroupsRequest listGroupsRequest)
Lists the IAM groups that have the specified path prefix.ListGroupsForUserResult
listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the IAM groups that the specified IAM user belongs to.ListInstanceProfilesResult
listInstanceProfiles()
Simplified method form for invoking the ListInstanceProfiles operation.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 IAM role.ListMFADevicesResult
listMFADevices()
Simplified method form for invoking the ListMFADevices operation.ListMFADevicesResult
listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices for an IAM user.ListOpenIDConnectProvidersResult
listOpenIDConnectProviders()
Simplified method form for invoking the ListOpenIDConnectProviders operation.ListOpenIDConnectProvidersResult
listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest listOpenIDConnectProvidersRequest)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.ListPoliciesResult
listPolicies()
Simplified method form for invoking the ListPolicies operation.ListPoliciesResult
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.ListPolicyVersionsResult
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.ListRolePoliciesResult
listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM role.ListRolesResult
listRoles()
Simplified method form for invoking the ListRoles operation.ListRolesResult
listRoles(ListRolesRequest listRolesRequest)
Lists the IAM roles that have the specified path prefix.ListSAMLProvidersResult
listSAMLProviders()
Simplified method form for invoking the ListSAMLProviders operation.ListSAMLProvidersResult
listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
Lists the SAML provider resource objects defined in IAM in the account.ListServerCertificatesResult
listServerCertificates()
Simplified method form for invoking the ListServerCertificates operation.ListServerCertificatesResult
listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates stored in IAM that have the specified path prefix.ListSigningCertificatesResult
listSigningCertificates()
Simplified method form for invoking the ListSigningCertificates operation.ListSigningCertificatesResult
listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified IAM user.ListSSHPublicKeysResult
listSSHPublicKeys()
Simplified method form for invoking the ListSSHPublicKeys operation.ListSSHPublicKeysResult
listSSHPublicKeys(ListSSHPublicKeysRequest listSSHPublicKeysRequest)
Returns information about the SSH public keys associated with the specified IAM user.ListUserPoliciesResult
listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified IAM user.ListUsersResult
listUsers()
Simplified method form for invoking the ListUsers operation.ListUsersResult
listUsers(ListUsersRequest listUsersRequest)
Lists the IAM users that have the specified path prefix.ListVirtualMFADevicesResult
listVirtualMFADevices()
Simplified method form for invoking the ListVirtualMFADevices operation.ListVirtualMFADevicesResult
listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
Lists the virtual MFA devices defined in the AWS account by assignment status.PutGroupPolicyResult
putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM group.PutRolePolicyResult
putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM role.PutUserPolicyResult
putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM user.RemoveClientIDFromOpenIDConnectProviderResult
removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest removeClientIDFromOpenIDConnectProviderRequest)
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.RemoveRoleFromInstanceProfileResult
removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
Removes the specified IAM role from the specified EC2 instance profile.RemoveUserFromGroupResult
removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
Removes the specified user from the specified group.ResyncMFADeviceResult
resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.SetDefaultPolicyVersionResult
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("iam.amazonaws.com").void
setRegion(Region region)
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.SimulateCustomPolicyResult
simulateCustomPolicy(SimulateCustomPolicyRequest simulateCustomPolicyRequest)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions.SimulatePrincipalPolicyResult
simulatePrincipalPolicy(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions.UpdateAccessKeyResult
updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest)
Changes the status of the specified access key from Active to Inactive, or vice versa.UpdateAccountPasswordPolicyResult
updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
Updates the password policy settings for the AWS account.UpdateAssumeRolePolicyResult
updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
Updates the policy that grants an IAM entity permission to assume a role.UpdateGroupResult
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the name and/or the path of the specified IAM group.UpdateLoginProfileResult
updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
Changes the password for the specified IAM user.UpdateOpenIDConnectProviderThumbprintResult
updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest updateOpenIDConnectProviderThumbprintRequest)
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.UpdateSAMLProviderResult
updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider resource object.UpdateServerCertificateResult
updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
Updates the name and/or the path of the specified server certificate stored in IAM.UpdateSigningCertificateResult
updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
Changes the status of the specified user signing certificate from active to disabled, or vice versa.UpdateSSHPublicKeyResult
updateSSHPublicKey(UpdateSSHPublicKeyRequest updateSSHPublicKeyRequest)
Sets the status of an IAM user's SSH public key to active or inactive.UpdateUserResult
updateUser(UpdateUserRequest updateUserRequest)
Updates the name and/or the path of the specified IAM 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 IAM user.UploadSSHPublicKeyResult
uploadSSHPublicKey(UploadSSHPublicKeyRequest uploadSSHPublicKeyRequest)
Uploads an SSH public key and associates it with the specified IAM user.
-
-
-
Method Detail
-
setEndpoint
void setEndpoint(String endpoint)
Overrides the default endpoint for this client ("iam.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "iam.amazonaws.com") or a full URL, including the protocol (ex: "iam.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
endpoint
- The endpoint (ex: "iam.amazonaws.com") or a full URL, including the protocol (ex: "iam.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
void setRegion(Region region)
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
addClientIDToOpenIDConnectProvider
AddClientIDToOpenIDConnectProviderResult addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest addClientIDToOpenIDConnectProviderRequest)
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
- Parameters:
addClientIDToOpenIDConnectProviderRequest
-- Returns:
- Result of the AddClientIDToOpenIDConnectProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
addRoleToInstanceProfile
AddRoleToInstanceProfileResult addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
Adds the specified IAM role to the specified instance profile.
The caller of this API must be granted the
PassRole
permission on the IAM role by a permission policy.For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
- Parameters:
addRoleToInstanceProfileRequest
-- Returns:
- Result of the AddRoleToInstanceProfile operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
addUserToGroup
AddUserToGroupResult addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
Adds the specified user to the specified group.
- Parameters:
addUserToGroupRequest
-- Returns:
- Result of the AddUserToGroup operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
attachGroupPolicy
AttachGroupPolicyResult attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest)
Attaches the specified managed policy to the specified IAM group.
You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
attachGroupPolicyRequest
-- Returns:
- Result of the AttachGroupPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
attachRolePolicy
AttachRolePolicyResult attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest)
Attaches the specified managed policy to the specified IAM role.
When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.
Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
attachRolePolicyRequest
-- Returns:
- Result of the AttachRolePolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
attachUserPolicy
AttachUserPolicyResult attachUserPolicy(AttachUserPolicyRequest attachUserPolicyRequest)
Attaches the specified managed policy to the specified user.
You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
attachUserPolicyRequest
-- Returns:
- Result of the AttachUserPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
changePassword
ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password of the IAM user who is calling this action. The root account password is not affected by this action.
To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.
- Parameters:
changePasswordRequest
-- Returns:
- Result of the ChangePassword operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidUserTypeException
- The request was rejected because the type of user for the transaction was incorrect.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the account password policy.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createAccessKey
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 action to manage root credentials even if the AWS account has no associated users.
For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.
To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.
- Parameters:
createAccessKeyRequest
-- Returns:
- Result of the CreateAccessKey operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createAccessKey
CreateAccessKeyResult createAccessKey()
Simplified method form for invoking the CreateAccessKey operation.- See Also:
createAccessKey(CreateAccessKeyRequest)
-
createAccountAlias
CreateAccountAliasResult createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest)
Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
- Parameters:
createAccountAliasRequest
-- Returns:
- Result of the CreateAccountAlias operation returned by the service.
- Throws:
EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createGroup
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
- Parameters:
createGroupRequest
-- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createInstanceProfile
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 the IAM User Guide.
- Parameters:
createInstanceProfileRequest
-- Returns:
- Result of the CreateInstanceProfile operation returned by the service.
- Throws:
EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createLoginProfile
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 the IAM User Guide.
- Parameters:
createLoginProfileRequest
-- Returns:
- Result of the CreateLoginProfile operation returned by the service.
- Throws:
EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the account password policy.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createOpenIDConnectProvider
CreateOpenIDConnectProviderResult createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest createOpenIDConnectProviderRequest)
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider.
When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.
Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the CreateOpenIDConnectProvider action to highly-privileged users.
- Parameters:
createOpenIDConnectProviderRequest
-- Returns:
- Result of the CreateOpenIDConnectProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createPolicy
CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest)
Creates a new managed policy for your AWS account.
This operation creates a policy version with a version identifier of
v1
and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide.For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
createPolicyRequest
-- Returns:
- Result of the CreatePolicy operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createPolicyVersion
CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
- Parameters:
createPolicyVersionRequest
-- Returns:
- Result of the CreatePolicyVersion operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createRole
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 the IAM User Guide.
- Parameters:
createRoleRequest
-- Returns:
- Result of the CreateRole operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createSAMLProvider
CreateSAMLProviderResult createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest)
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider resource, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.
- Parameters:
createSAMLProviderRequest
-- Returns:
- Result of the CreateSAMLProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createUser
CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a new IAM user for your AWS account.
For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.
- Parameters:
createUserRequest
-- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
createVirtualMFADevice
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 the IAM User Guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
- Parameters:
createVirtualMFADeviceRequest
-- Returns:
- Result of the CreateVirtualMFADevice operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deactivateMFADevice
DeactivateMFADeviceResult deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
- Parameters:
deactivateMFADeviceRequest
-- Returns:
- Result of the DeactivateMFADevice operation returned by the service.
- Throws:
EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteAccessKey
DeleteAccessKeyResult deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
Deletes the access key pair associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
- Parameters:
deleteAccessKeyRequest
-- Returns:
- Result of the DeleteAccessKey operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteAccountAlias
DeleteAccountAliasResult 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 the IAM User Guide.
- Parameters:
deleteAccountAliasRequest
-- Returns:
- Result of the DeleteAccountAlias operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteAccountPasswordPolicy
DeleteAccountPasswordPolicyResult deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account. There are no parameters.
- Parameters:
deleteAccountPasswordPolicyRequest
-- Returns:
- Result of the DeleteAccountPasswordPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteAccountPasswordPolicy
DeleteAccountPasswordPolicyResult deleteAccountPasswordPolicy()
Simplified method form for invoking the DeleteAccountPasswordPolicy operation.
-
deleteGroup
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
- Parameters:
deleteGroupRequest
-- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteGroupPolicy
DeleteGroupPolicyResult deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
deleteGroupPolicyRequest
-- Returns:
- Result of the DeleteGroupPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteInstanceProfile
DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile. The instance profile must not have an associated role.
Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
For more information about instance profiles, go to About Instance Profiles.
- Parameters:
deleteInstanceProfileRequest
-- Returns:
- Result of the DeleteInstanceProfile operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteLoginProfile
DeleteLoginProfileResult deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.
Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
- Parameters:
deleteLoginProfileRequest
-- Returns:
- Result of the DeleteLoginProfile operation returned by the service.
- Throws:
EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteOpenIDConnectProvider
DeleteOpenIDConnectProviderResult deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest deleteOpenIDConnectProviderRequest)
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This action is idempotent; it does not fail or return an error if you call the action for a provider that does not exist.
- Parameters:
deleteOpenIDConnectProviderRequest
-- Returns:
- Result of the DeleteOpenIDConnectProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deletePolicy
DeletePolicyResult deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:
-
Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy APIs. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
-
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
-
Delete the policy (this automatically deletes the policy's default version) using this API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
deletePolicyRequest
-- Returns:
- Result of the DeletePolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
-
deletePolicyVersion
DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide.
- Parameters:
deletePolicyVersionRequest
-- Returns:
- Result of the DeletePolicyVersion operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteRole
DeleteRoleResult 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.
Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
- Parameters:
deleteRoleRequest
-- Returns:
- Result of the DeleteRole operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteRolePolicy
DeleteRolePolicyResult deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
deleteRolePolicyRequest
-- Returns:
- Result of the DeleteRolePolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteSAMLProvider
DeleteSAMLProviderResult deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
- Parameters:
deleteSAMLProviderRequest
-- Returns:
- Result of the DeleteSAMLProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteSSHPublicKey
DeleteSSHPublicKeyResult deleteSSHPublicKey(DeleteSSHPublicKeyRequest deleteSSHPublicKeyRequest)
Deletes the specified SSH public key.
The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
- Parameters:
deleteSSHPublicKeyRequest
-- Returns:
- Result of the DeleteSSHPublicKey operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
-
deleteServerCertificate
DeleteServerCertificateResult deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest)
Deletes the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
- Parameters:
deleteServerCertificateRequest
-- Returns:
- Result of the DeleteServerCertificate operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteSigningCertificate
DeleteSigningCertificateResult deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
Deletes a signing certificate associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated IAM users.
- Parameters:
deleteSigningCertificateRequest
-- Returns:
- Result of the DeleteSigningCertificate operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteUser
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
- Parameters:
deleteUserRequest
-- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteUserPolicy
DeleteUserPolicyResult deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
deleteUserPolicyRequest
-- Returns:
- Result of the DeleteUserPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
deleteVirtualMFADevice
DeleteVirtualMFADeviceResult deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
Deletes a virtual MFA device.
You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
- Parameters:
deleteVirtualMFADeviceRequest
-- Returns:
- Result of the DeleteVirtualMFADevice operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
detachGroupPolicy
DetachGroupPolicyResult detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest)
Removes the specified managed policy from the specified IAM group.
A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
detachGroupPolicyRequest
-- Returns:
- Result of the DetachGroupPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
detachRolePolicy
DetachRolePolicyResult detachRolePolicy(DetachRolePolicyRequest detachRolePolicyRequest)
Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
detachRolePolicyRequest
-- Returns:
- Result of the DetachRolePolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
detachUserPolicy
DetachUserPolicyResult detachUserPolicy(DetachUserPolicyRequest detachUserPolicyRequest)
Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
detachUserPolicyRequest
-- Returns:
- Result of the DetachUserPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
enableMFADevice
EnableMFADeviceResult enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.
- Parameters:
enableMFADeviceRequest
-- Returns:
- Result of the EnableMFADevice operation returned by the service.
- Throws:
EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.InvalidAuthenticationCodeException
- The request was rejected because the authentication code was not recognized. The error message describes the specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
generateCredentialReport
GenerateCredentialReportResult generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest)
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
- Parameters:
generateCredentialReportRequest
-- Returns:
- Result of the GenerateCredentialReport operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
generateCredentialReport
GenerateCredentialReportResult generateCredentialReport()
Simplified method form for invoking the GenerateCredentialReport operation.
-
getAccessKeyLastUsed
GetAccessKeyLastUsedResult getAccessKeyLastUsed(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest)
Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.
- Parameters:
getAccessKeyLastUsedRequest
-- Returns:
- Result of the GetAccessKeyLastUsed operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
-
getAccountAuthorizationDetails
GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
You can optionally filter the results using the
Filter
parameter. You can paginate the results using theMaxItems
andMarker
parameters.- Parameters:
getAccountAuthorizationDetailsRequest
-- Returns:
- Result of the GetAccountAuthorizationDetails operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getAccountAuthorizationDetails
GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails()
Simplified method form for invoking the GetAccountAuthorizationDetails operation.
-
getAccountPasswordPolicy
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.
- Parameters:
getAccountPasswordPolicyRequest
-- Returns:
- Result of the GetAccountPasswordPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getAccountPasswordPolicy
GetAccountPasswordPolicyResult getAccountPasswordPolicy()
Simplified method form for invoking the GetAccountPasswordPolicy operation.
-
getAccountSummary
GetAccountSummaryResult getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest)
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide.
- Parameters:
getAccountSummaryRequest
-- Returns:
- Result of the GetAccountSummary operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getAccountSummary
GetAccountSummaryResult getAccountSummary()
Simplified method form for invoking the GetAccountSummary operation.
-
getContextKeysForCustomPolicy
GetContextKeysForCustomPolicyResult getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest)
Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
- Parameters:
getContextKeysForCustomPolicyRequest
-- Returns:
- Result of the GetContextKeysForCustomPolicy operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
getContextKeysForPrincipalPolicy
GetContextKeysForPrincipalPolicyResult getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
- Parameters:
getContextKeysForPrincipalPolicyRequest
-- Returns:
- Result of the GetContextKeysForPrincipalPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
getCredentialReport
GetCredentialReportResult getCredentialReport(GetCredentialReportRequest getCredentialReportRequest)
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
- Parameters:
getCredentialReportRequest
-- Returns:
- Result of the GetCredentialReport operation returned by the service.
- Throws:
CredentialReportNotPresentException
- The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.CredentialReportExpiredException
- The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the IAM User Guide.CredentialReportNotReadyException
- The request was rejected because the credential report is still being generated.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getCredentialReport
GetCredentialReportResult getCredentialReport()
Simplified method form for invoking the GetCredentialReport operation.
-
getGroup
GetGroupResult getGroup(GetGroupRequest getGroupRequest)
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
getGroupRequest
-- Returns:
- Result of the GetGroup operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getGroupPolicy
GetGroupPolicyResult getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
getGroupPolicyRequest
-- Returns:
- Result of the GetGroupPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getInstanceProfile
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, see About Instance Profiles in the IAM User Guide.
- Parameters:
getInstanceProfileRequest
-- Returns:
- Result of the GetInstanceProfile operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getLoginProfile
GetLoginProfileResult getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the action returns a 404 (
NoSuchEntity
) error.- Parameters:
getLoginProfileRequest
-- Returns:
- Result of the GetLoginProfile operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getOpenIDConnectProvider
GetOpenIDConnectProviderResult getOpenIDConnectProvider(GetOpenIDConnectProviderRequest getOpenIDConnectProviderRequest)
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
- Parameters:
getOpenIDConnectProviderRequest
-- Returns:
- Result of the GetOpenIDConnectProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getPolicy
GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
getPolicyRequest
-- Returns:
- Result of the GetPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getPolicyVersion
GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Retrieves information about the specified version of the specified managed policy, including the policy document.
To list the available versions for a policy, use ListPolicyVersions.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
- Parameters:
getPolicyVersionRequest
-- Returns:
- Result of the GetPolicyVersion operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getRole
GetRoleResult getRole(GetRoleRequest getRoleRequest)
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.
- Parameters:
getRoleRequest
-- Returns:
- Result of the GetRole operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getRolePolicy
GetRolePolicyResult getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
Retrieves the specified inline policy document that is embedded with the specified IAM role.
An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For more information about roles, see Using Roles to Delegate Permissions and Federate Identities.
- Parameters:
getRolePolicyRequest
-- Returns:
- Result of the GetRolePolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getSAMLProvider
GetSAMLProviderResult getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
This operation requires Signature Version 4.
- Parameters:
getSAMLProviderRequest
-- Returns:
- Result of the GetSAMLProvider operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getSSHPublicKey
GetSSHPublicKeyResult getSSHPublicKey(GetSSHPublicKeyRequest getSSHPublicKeyRequest)
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
- Parameters:
getSSHPublicKeyRequest
-- Returns:
- Result of the GetSSHPublicKey operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.UnrecognizedPublicKeyEncodingException
- The request was rejected because the public key encoding format is unsupported or unrecognized.
-
getServerCertificate
GetServerCertificateResult getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
- Parameters:
getServerCertificateRequest
-- Returns:
- Result of the GetServerCertificate operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getUser
GetUserResult getUser(GetUserRequest getUserRequest)
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API.
- Parameters:
getUserRequest
-- Returns:
- Result of the GetUser operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
getUser
GetUserResult getUser()
Simplified method form for invoking the GetUser operation.- See Also:
getUser(GetUserRequest)
-
getUserPolicy
GetUserPolicyResult getUserPolicy(GetUserPolicyRequest getUserPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
getUserPolicyRequest
-- Returns:
- Result of the GetUserPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listAccessKeys
ListAccessKeysResult listAccessKeys(ListAccessKeysRequest listAccessKeysRequest)
Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the
MaxItems
andMarker
parameters.If the
UserName
field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.
- Parameters:
listAccessKeysRequest
-- Returns:
- Result of the ListAccessKeys operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listAccessKeys
ListAccessKeysResult listAccessKeys()
Simplified method form for invoking the ListAccessKeys operation.- See Also:
listAccessKeys(ListAccessKeysRequest)
-
listAccountAliases
ListAccountAliasesResult listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
- Parameters:
listAccountAliasesRequest
-- Returns:
- Result of the ListAccountAliases operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listAccountAliases
ListAccountAliasesResult listAccountAliases()
Simplified method form for invoking the ListAccountAliases operation.
-
listAttachedGroupPolicies
ListAttachedGroupPoliciesResult listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified IAM group.
An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.- Parameters:
listAttachedGroupPoliciesRequest
-- Returns:
- Result of the ListAttachedGroupPolicies operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listAttachedRolePolicies
ListAttachedRolePoliciesResult listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified IAM role.
An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list.- Parameters:
listAttachedRolePoliciesRequest
-- Returns:
- Result of the ListAttachedRolePolicies operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listAttachedUserPolicies
ListAttachedUserPoliciesResult listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified IAM user.
An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.- Parameters:
listAttachedUserPoliciesRequest
-- Returns:
- Result of the ListAttachedUserPolicies operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listEntitiesForPolicy
ListEntitiesForPolicyResult listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional
EntityFilter
parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, setEntityFilter
toRole
.You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listEntitiesForPolicyRequest
-- Returns:
- Result of the ListEntitiesForPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listGroupPolicies
ListGroupPoliciesResult listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified group, the action returns an empty list.- Parameters:
listGroupPoliciesRequest
-- Returns:
- Result of the ListGroupPolicies operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listGroups
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listGroupsRequest
-- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listGroups
ListGroupsResult listGroups()
Simplified method form for invoking the ListGroups operation.- See Also:
listGroups(ListGroupsRequest)
-
listGroupsForUser
ListGroupsForUserResult listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listGroupsForUserRequest
-- Returns:
- Result of the ListGroupsForUser operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listInstanceProfiles
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
andMarker
parameters.- Parameters:
listInstanceProfilesRequest
-- Returns:
- Result of the ListInstanceProfiles operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listInstanceProfiles
ListInstanceProfilesResult listInstanceProfiles()
Simplified method form for invoking the ListInstanceProfiles operation.
-
listInstanceProfilesForRole
ListInstanceProfilesForRoleResult listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated IAM role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listInstanceProfilesForRoleRequest
-- Returns:
- Result of the ListInstanceProfilesForRole operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listMFADevices
ListMFADevicesResult listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listMFADevicesRequest
-- Returns:
- Result of the ListMFADevices operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listMFADevices
ListMFADevicesResult listMFADevices()
Simplified method form for invoking the ListMFADevices operation.- See Also:
listMFADevices(ListMFADevicesRequest)
-
listOpenIDConnectProviders
ListOpenIDConnectProvidersResult listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest listOpenIDConnectProvidersRequest)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
- Parameters:
listOpenIDConnectProvidersRequest
-- Returns:
- Result of the ListOpenIDConnectProviders operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listOpenIDConnectProviders
ListOpenIDConnectProvidersResult listOpenIDConnectProviders()
Simplified method form for invoking the ListOpenIDConnectProviders operation.
-
listPolicies
ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional
OnlyAttached
,Scope
, andPathPrefix
parameters. For example, to list only the customer managed policies in your AWS account, setScope
toLocal
. To list only AWS managed policies, setScope
toAWS
.You can paginate the results using the
MaxItems
andMarker
parameters.For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
listPoliciesRequest
-- Returns:
- Result of the ListPolicies operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listPolicies
ListPoliciesResult listPolicies()
Simplified method form for invoking the ListPolicies operation.- See Also:
listPolicies(ListPoliciesRequest)
-
listPolicyVersions
ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
listPolicyVersionsRequest
-- Returns:
- Result of the ListPolicyVersions operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listRolePolicies
ListRolePoliciesResult listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified role, the action returns an empty list.- Parameters:
listRolePoliciesRequest
-- Returns:
- Result of the ListRolePolicies operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listRoles
ListRolesResult listRoles(ListRolesRequest listRolesRequest)
Lists the IAM roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listRolesRequest
-- Returns:
- Result of the ListRoles operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listRoles
ListRolesResult listRoles()
Simplified method form for invoking the ListRoles operation.- See Also:
listRoles(ListRolesRequest)
-
listSAMLProviders
ListSAMLProvidersResult listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
- Parameters:
listSAMLProvidersRequest
-- Returns:
- Result of the ListSAMLProviders operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listSAMLProviders
ListSAMLProvidersResult listSAMLProviders()
Simplified method form for invoking the ListSAMLProviders operation.
-
listSSHPublicKeys
ListSSHPublicKeysResult listSSHPublicKeys(ListSSHPublicKeysRequest listSSHPublicKeysRequest)
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.
The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listSSHPublicKeysRequest
-- Returns:
- Result of the ListSSHPublicKeys operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
-
listSSHPublicKeys
ListSSHPublicKeysResult listSSHPublicKeys()
Simplified method form for invoking the ListSSHPublicKeys operation.
-
listServerCertificates
ListServerCertificatesResult listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the
MaxItems
andMarker
parameters.For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
- Parameters:
listServerCertificatesRequest
-- Returns:
- Result of the ListServerCertificates operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listServerCertificates
ListServerCertificatesResult listServerCertificates()
Simplified method form for invoking the ListServerCertificates operation.
-
listSigningCertificates
ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified IAM user. If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the
MaxItems
andMarker
parameters.If the
UserName
field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.- Parameters:
listSigningCertificatesRequest
-- Returns:
- Result of the ListSigningCertificates operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listSigningCertificates
ListSigningCertificatesResult listSigningCertificates()
Simplified method form for invoking the ListSigningCertificates operation.
-
listUserPolicies
ListUserPoliciesResult listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified user, the action returns an empty list.- Parameters:
listUserPoliciesRequest
-- Returns:
- Result of the ListUserPolicies operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listUsers
ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listUsersRequest
-- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
listUsers
ListUsersResult listUsers()
Simplified method form for invoking the ListUsers operation.- See Also:
listUsers(ListUsersRequest)
-
listVirtualMFADevices
ListVirtualMFADevicesResult listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be
Assigned
,Unassigned
, orAny
.You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listVirtualMFADevicesRequest
-- Returns:
- Result of the ListVirtualMFADevices operation returned by the service.
-
listVirtualMFADevices
ListVirtualMFADevicesResult listVirtualMFADevices()
Simplified method form for invoking the ListVirtualMFADevices operation.
-
putGroupPolicy
PutGroupPolicyResult putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling
PutGroupPolicy
. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Parameters:
putGroupPolicyRequest
-- Returns:
- Result of the PutGroupPolicy operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
putRolePolicy
PutRolePolicyResult putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling
PutRolePolicy
. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Parameters:
putRolePolicyRequest
-- Returns:
- Result of the PutRolePolicy operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
putUserPolicy
PutUserPolicyResult putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling
PutUserPolicy
. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Parameters:
putUserPolicyRequest
-- Returns:
- Result of the PutUserPolicy operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
removeClientIDFromOpenIDConnectProvider
RemoveClientIDFromOpenIDConnectProviderResult removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest removeClientIDFromOpenIDConnectProviderRequest)
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This action is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
- Parameters:
removeClientIDFromOpenIDConnectProviderRequest
-- Returns:
- Result of the RemoveClientIDFromOpenIDConnectProvider operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
removeRoleFromInstanceProfile
RemoveRoleFromInstanceProfileResult removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
Removes the specified IAM role from the specified EC2 instance profile.
Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance break any applications running on the instance.
For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
- Parameters:
removeRoleFromInstanceProfileRequest
-- Returns:
- Result of the RemoveRoleFromInstanceProfile operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
removeUserFromGroup
RemoveUserFromGroupResult removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
Removes the specified user from the specified group.
- Parameters:
removeUserFromGroupRequest
-- Returns:
- Result of the RemoveUserFromGroup operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
resyncMFADevice
ResyncMFADeviceResult resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
- Parameters:
resyncMFADeviceRequest
-- Returns:
- Result of the ResyncMFADevice operation returned by the service.
- Throws:
InvalidAuthenticationCodeException
- The request was rejected because the authentication code was not recognized. The error message describes the specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
setDefaultPolicyVersion
SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.
This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Parameters:
setDefaultPolicyVersionRequest
-- Returns:
- Result of the SetDefaultPolicyVersion operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
simulateCustomPolicy
SimulateCustomPolicyResult simulateCustomPolicy(SimulateCustomPolicyRequest simulateCustomPolicyRequest)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.
If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the
Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.If the output is long, you can use
MaxItems
andMarker
parameters to paginate the results.- Parameters:
simulateCustomPolicyRequest
-- Returns:
- Result of the SimulateCustomPolicy operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure.
-
simulatePrincipalPolicy
SimulatePrincipalPolicyResult simulatePrincipalPolicy(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to .
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.
The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the
Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.If the output is long, you can use the
MaxItems
andMarker
parameters to paginate the results.- Parameters:
simulatePrincipalPolicyRequest
-- Returns:
- Result of the SimulatePrincipalPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure.
-
updateAccessKey
UpdateAccessKeyResult 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, you can use this action to manage root credentials even if the AWS account has no associated users.For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide.
- Parameters:
updateAccessKeyRequest
-- Returns:
- Result of the UpdateAccessKey operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateAccountPasswordPolicy
UpdateAccountPasswordPolicyResult updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
Updates the password policy settings for the AWS account.
This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value.
For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide.
- Parameters:
updateAccountPasswordPolicyRequest
-- Returns:
- Result of the UpdateAccountPasswordPolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateAssumeRolePolicy
UpdateAssumeRolePolicyResult updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
- Parameters:
updateAssumeRolePolicyRequest
-- Returns:
- Result of the UpdateAssumeRolePolicy operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateGroup
UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.
To change an IAM group name the requester must have appropriate permissions on both the source object and the target object. For example, to change "Managers" to "MGRs", the entity making the request must have permission on both "Managers" and "MGRs", or must have permission on all (*). For more information about permissions, see Permissions and Policies.
- Parameters:
updateGroupRequest
-- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateLoginProfile
UpdateLoginProfileResult updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
Changes the password for the specified IAM user.
IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.
- Parameters:
updateLoginProfileRequest
-- Returns:
- Result of the UpdateLoginProfile operation returned by the service.
- Throws:
EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the account password policy.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateOpenIDConnectProviderThumbprint
UpdateOpenIDConnectProviderThumbprintResult updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest updateOpenIDConnectProviderThumbprintRequest)
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Because trust for the OIDC provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the
UpdateOpenIDConnectProviderThumbprint
action to highly-privileged users.- Parameters:
updateOpenIDConnectProviderThumbprintRequest
-- Returns:
- Result of the UpdateOpenIDConnectProviderThumbprint operation returned by the service.
- Throws:
InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateSAMLProvider
UpdateSAMLProviderResult updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
- Parameters:
updateSAMLProviderRequest
-- Returns:
- Result of the UpdateSAMLProvider operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateSSHPublicKey
UpdateSSHPublicKeyResult updateSSHPublicKey(UpdateSSHPublicKeyRequest updateSSHPublicKeyRequest)
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
- Parameters:
updateSSHPublicKeyRequest
-- Returns:
- Result of the UpdateSSHPublicKey operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
-
updateServerCertificate
UpdateServerCertificateResult updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide.
To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from "ProductionCert" to "ProdCert", the entity making the request must have permission on "ProductionCert" and "ProdCert", or must have permission on all (*). For more information about permissions, see Access Management in the IAM User Guide.
- Parameters:
updateServerCertificateRequest
-- Returns:
- Result of the UpdateServerCertificate operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateSigningCertificate
UpdateSigningCertificateResult updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the
UserName
field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.- Parameters:
updateSigningCertificateRequest
-- Returns:
- Result of the UpdateSigningCertificate operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
updateUser
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide.
To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
- Parameters:
updateUserRequest
-- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
uploadSSHPublicKey
UploadSSHPublicKeyResult uploadSSHPublicKey(UploadSSHPublicKeyRequest uploadSSHPublicKeyRequest)
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
- Parameters:
uploadSSHPublicKeyRequest
-- Returns:
- Result of the UploadSSHPublicKey operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.InvalidPublicKeyException
- The request was rejected because the public key is malformed or otherwise invalid.DuplicateSSHPublicKeyException
- The request was rejected because the SSH public key is already associated with the specified IAM user.UnrecognizedPublicKeyEncodingException
- The request was rejected because the public key encoding format is unsupported or unrecognized.
-
uploadServerCertificate
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 more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling
UploadServerCertificate
. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide.- Parameters:
uploadServerCertificateRequest
-- Returns:
- Result of the UploadServerCertificate operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedCertificateException
- The request was rejected because the certificate was malformed or expired. The error message describes the specific error.KeyPairMismatchException
- The request was rejected because the public key certificate and the private key do not match.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
uploadSigningCertificate
UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest)
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is
Active
.If the
UserName
field is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling
UploadSigningCertificate
. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Parameters:
uploadSigningCertificateRequest
-- Returns:
- Result of the UploadSigningCertificate operation returned by the service.
- Throws:
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedCertificateException
- The request was rejected because the certificate was malformed or expired. The error message describes the specific error.InvalidCertificateException
- The request was rejected because the certificate is invalid.DuplicateCertificateException
- The request was rejected because the same certificate is associated with an IAM user in the account.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.
-
shutdown
void shutdown()
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
-
getCachedResponseMetadata
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-