@ThreadSafe public class AmazonIdentityManagementClient extends AmazonWebServiceClient implements AmazonIdentityManagement
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.
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:
LOGGING_AWS_REQUEST_METRIC
Constructor and Description |
---|
AmazonIdentityManagementClient()
Constructs a new client to invoke service methods on IAM.
|
AmazonIdentityManagementClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on IAM using the
specified AWS account credentials.
|
AmazonIdentityManagementClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on IAM using the
specified AWS account credentials and client configuration options.
|
AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on IAM using the
specified AWS account credentials provider.
|
AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on IAM using the
specified AWS account credentials provider and client configuration
options.
|
AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on IAM using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AmazonIdentityManagementClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on IAM.
|
Modifier and Type | Method and Description |
---|---|
void |
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 provider.
|
void |
addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
Adds the specified role to the specified instance profile.
|
void |
addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
Adds the specified user to the specified group.
|
void |
attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest)
Attaches the specified managed policy to the specified group.
|
void |
attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest)
Attaches the specified managed policy to the specified role.
|
void |
attachUserPolicy(AttachUserPolicyRequest attachUserPolicyRequest)
Attaches the specified managed policy to the specified user.
|
void |
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.
|
void |
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 entity to describe an identity provider (IdP) that
supports SAML 2.0.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a new user for your AWS account.
|
CreateVirtualMFADeviceResult |
createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest)
Creates a new virtual MFA device for the AWS account.
|
void |
deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with
the user name for which it was originally enabled.
|
void |
deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
Deletes the access key associated with the specified user.
|
void |
deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
Deletes the specified AWS account alias.
|
void |
deleteAccountPasswordPolicy()
Simplified method form for invoking the DeleteAccountPasswordPolicy
operation.
|
void |
deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account.
|
void |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes the specified group.
|
void |
deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
Deletes the specified inline policy that is embedded in the specified
group.
|
void |
deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile.
|
void |
deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
Deletes the password for the specified user, which terminates the user's
ability to access AWS services through the AWS Management Console.
|
void |
deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest deleteOpenIDConnectProviderRequest)
Deletes an IAM OpenID Connect identity provider.
|
void |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified managed policy.
|
void |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified managed policy.
|
void |
deleteRole(DeleteRoleRequest deleteRoleRequest)
Deletes the specified role.
|
void |
deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
Deletes the specified inline policy that is embedded in the specified
role.
|
void |
deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
Deletes a SAML provider.
|
void |
deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest)
Deletes the specified server certificate.
|
void |
deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
Deletes the specified signing certificate associated with the specified
user.
|
void |
deleteSSHPublicKey(DeleteSSHPublicKeyRequest deleteSSHPublicKeyRequest)
Deletes the specified SSH public key.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user.
|
void |
deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
Deletes the specified inline policy that is embedded in the specified
user.
|
void |
deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
Deletes a virtual MFA device.
|
void |
detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest)
Removes the specified managed policy from the specified group.
|
void |
detachRolePolicy(DetachRolePolicyRequest detachRolePolicyRequest)
Removes the specified managed policy from the specified role.
|
void |
detachUserPolicy(DetachUserPolicyRequest detachUserPolicyRequest)
Removes the specified managed policy from the specified user.
|
void |
enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified
user name.
|
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 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
Condition elements in the input policies. |
GetContextKeysForPrincipalPolicyResult |
getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in
Condition elements in all of the IAM policies attached to
the specified IAM entity. |
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 users that are in the specified group.
|
GetGroupPolicyResult |
getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
Retrieves the specified inline policy document that is embedded in the
specified group.
|
GetInstanceProfileResult |
getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
Retrieves information about the specified instance profile, including the
instance profile's path, GUID, ARN, and role.
|
GetLoginProfileResult |
getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
Retrieves the user name and password-creation date for the specified
user.
|
GetOpenIDConnectProviderResult |
getOpenIDConnectProvider(GetOpenIDConnectProviderRequest getOpenIDConnectProviderRequest)
Returns information about the specified OpenID Connect provider.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Retrieves information about the specified managed policy, including the
policy's default version and the total number of users, groups, and roles
that the policy is attached to.
|
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 policy granting permission to assume the role.
|
GetRolePolicyResult |
getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
Retrieves the specified inline policy document that is embedded with the
specified role.
|
GetSAMLProviderResult |
getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the
provider was created or updated.
|
GetServerCertificateResult |
getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
Retrieves information about the specified server certificate.
|
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 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 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 user.
|
ListAccountAliasesResult |
listAccountAliases()
Simplified method form for invoking the ListAccountAliases operation.
|
ListAccountAliasesResult |
listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the account (Note: you can have
only one).
|
ListAttachedGroupPoliciesResult |
listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified group.
|
ListAttachedRolePoliciesResult |
listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified role.
|
ListAttachedUserPoliciesResult |
listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified user.
|
ListEntitiesForPolicyResult |
listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest)
Lists all 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
group.
|
ListGroupsResult |
listGroups()
Simplified method form for invoking the ListGroups operation.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups that have the specified path prefix.
|
ListGroupsForUserResult |
listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the groups the specified user belongs to.
|
ListInstanceProfilesResult |
listInstanceProfiles()
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 role.
|
ListMFADevicesResult |
listMFADevices()
Simplified method form for invoking the ListMFADevices operation.
|
ListMFADevicesResult |
listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices.
|
ListOpenIDConnectProvidersResult |
listOpenIDConnectProviders()
Simplified method form for invoking the ListOpenIDConnectProviders
operation.
|
ListOpenIDConnectProvidersResult |
listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest listOpenIDConnectProvidersRequest)
Lists information about the OpenID Connect providers 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 to your account,
including your own customer 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 set as the policy's default version.
|
ListRolePoliciesResult |
listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified
role.
|
ListRolesResult |
listRoles()
Simplified method form for invoking the ListRoles operation.
|
ListRolesResult |
listRoles(ListRolesRequest listRolesRequest)
Lists the roles that have the specified path prefix.
|
ListSAMLProvidersResult |
listSAMLProviders()
Simplified method form for invoking the ListSAMLProviders operation.
|
ListSAMLProvidersResult |
listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
Lists the SAML providers in the account.
|
ListServerCertificatesResult |
listServerCertificates()
Simplified method form for invoking the ListServerCertificates operation.
|
ListServerCertificatesResult |
listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates 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 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 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 under the AWS account by assignment status.
|
void |
putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
Adds (or updates) an inline policy document that is embedded in the
specified group.
|
void |
putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
Adds (or updates) an inline policy document that is embedded in the
specified role.
|
void |
putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
Adds (or updates) an inline policy document that is embedded in the
specified user.
|
void |
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 provider.
|
void |
removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
Removes the specified role from the specified instance profile.
|
void |
removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
Removes the specified user from the specified group.
|
void |
resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
Synchronizes the specified MFA device with AWS servers.
|
void |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's
default (operative) version.
|
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.
|
void |
updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest)
Changes the status of the specified access key from Active to Inactive,
or vice versa.
|
void |
updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
Updates the password policy settings for the AWS account.
|
void |
updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
Updates the policy that grants an entity permission to assume a role.
|
void |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the name and/or the path of the specified group.
|
void |
updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
Changes the password for the specified user.
|
void |
updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest updateOpenIDConnectProviderThumbprintRequest)
Replaces the existing list of server certificate thumbprints with a new
list.
|
UpdateSAMLProviderResult |
updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider.
|
void |
updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
Updates the name and/or the path of the specified server certificate.
|
void |
updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
Changes the status of the specified signing certificate from active to
disabled, or vice versa.
|
void |
updateSSHPublicKey(UpdateSSHPublicKeyRequest updateSSHPublicKeyRequest)
Sets the status of the specified SSH public key to active or inactive.
|
void |
updateUser(UpdateUserRequest updateUserRequest)
Updates the name and/or the path of the specified user.
|
UploadServerCertificateResult |
uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest)
Uploads a server certificate entity for the AWS account.
|
UploadSigningCertificateResult |
uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest)
Uploads an X.509 signing certificate and associates it with the specified
user.
|
UploadSSHPublicKeyResult |
uploadSSHPublicKey(UploadSSHPublicKeyRequest uploadSSHPublicKeyRequest)
Uploads an SSH public key and associates it with the specified IAM user.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
public AmazonIdentityManagementClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonIdentityManagementClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to IAM (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonIdentityManagementClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonIdentityManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to IAM (ex: proxy settings, retry counts, etc.).public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to IAM (ex: proxy settings, retry counts, etc.).public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to IAM (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic void 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 provider.
This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
addClientIDToOpenIDConnectProvider
in interface AmazonIdentityManagement
addClientIDToOpenIDConnectProviderRequest
- 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.public void addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
addRoleToInstanceProfile
in interface AmazonIdentityManagement
addRoleToInstanceProfileRequest
- 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.public void addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
Adds the specified user to the specified group.
addUserToGroup
in interface AmazonIdentityManagement
addUserToGroupRequest
- 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.public void attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest)
Attaches the specified managed policy to the specified group.
You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.
For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
attachGroupPolicy
in interface AmazonIdentityManagement
attachGroupPolicyRequest
- 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.public void attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest)
Attaches the specified managed policy to the specified role.
When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.
Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
attachRolePolicy
in interface AmazonIdentityManagement
attachRolePolicyRequest
- 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.public void 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, refer to Managed Policies and Inline Policies in the IAM User Guide.
attachUserPolicy
in interface AmazonIdentityManagement
attachUserPolicyRequest
- 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.public void 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.
changePassword
in interface AmazonIdentityManagement
changePasswordRequest
- 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.public CreateAccessKeyResult createAccessKey(CreateAccessKeyRequest createAccessKeyRequest)
Creates a new AWS secret access key and corresponding AWS access key ID
for the specified user. The default status for new keys is
Active
.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this 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.
createAccessKey
in interface AmazonIdentityManagement
createAccessKeyRequest
- 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.public CreateAccessKeyResult createAccessKey()
AmazonIdentityManagement
createAccessKey
in interface AmazonIdentityManagement
AmazonIdentityManagement.createAccessKey(CreateAccessKeyRequest)
public void 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.
createAccountAlias
in interface AmazonIdentityManagement
createAccountAliasRequest
- 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.public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
createGroup
in interface AmazonIdentityManagement
createGroupRequest
- 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.public CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.
For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide.
createInstanceProfile
in interface AmazonIdentityManagement
createInstanceProfileRequest
- 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.public CreateLoginProfileResult createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest)
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide.
createLoginProfile
in interface AmazonIdentityManagement
createLoginProfileRequest
- 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.public 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.
createOpenIDConnectProvider
in interface AmazonIdentityManagement
createOpenIDConnectProviderRequest
- 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.public 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, refer to Managed Policies and Inline Policies in the IAM User Guide.
createPolicy
in interface AmazonIdentityManagement
createPolicyRequest
- 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.public 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 operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
createPolicyVersion
in interface AmazonIdentityManagement
createPolicyVersionRequest
- 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.public CreateRoleResult createRole(CreateRoleRequest createRoleRequest)
Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide.
createRole
in interface AmazonIdentityManagement
createRoleRequest
- 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.public CreateSAMLProviderResult createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest)
Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
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.
createSAMLProvider
in interface AmazonIdentityManagement
createSAMLProviderRequest
- 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.public CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a new user for your AWS account.
For information about limitations on the number of users you can create, see Limitations on IAM Entities in the IAM User Guide.
createUser
in interface AmazonIdentityManagement
createUserRequest
- 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.public CreateVirtualMFADeviceResult createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest)
Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the Using IAM guide.
createVirtualMFADevice
in interface AmazonIdentityManagement
createVirtualMFADeviceRequest
- 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.public void deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
deactivateMFADevice
in interface AmazonIdentityManagement
deactivateMFADeviceRequest
- 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.public void deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
Deletes the access key associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
deleteAccessKey
in interface AmazonIdentityManagement
deleteAccessKeyRequest
- 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.public void deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
deleteAccountAlias
in interface AmazonIdentityManagement
deleteAccountAliasRequest
- 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.public void deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account.
deleteAccountPasswordPolicy
in interface AmazonIdentityManagement
deleteAccountPasswordPolicyRequest
- 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.public void deleteAccountPasswordPolicy()
AmazonIdentityManagement
deleteAccountPasswordPolicy
in interface AmazonIdentityManagement
AmazonIdentityManagement.deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest)
public void deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes the specified group. The group must not contain any users or have any attached policies.
deleteGroup
in interface AmazonIdentityManagement
deleteGroupRequest
- 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.public void deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
Deletes the specified inline policy that is embedded in the specified group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
deleteGroupPolicy
in interface AmazonIdentityManagement
deleteGroupPolicyRequest
- 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.public void deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile. The instance profile must not have an associated role.
For more information about instance profiles, go to About Instance Profiles.
deleteInstanceProfile
in interface AmazonIdentityManagement
deleteInstanceProfileRequest
- 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.public void deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console.
deleteLoginProfile
in interface AmazonIdentityManagement
deleteLoginProfileRequest
- 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.public void deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest deleteOpenIDConnectProviderRequest)
Deletes an IAM OpenID Connect identity provider.
Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail.
This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted.
deleteOpenIDConnectProvider
in interface AmazonIdentityManagement
deleteOpenIDConnectProviderRequest
- 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.public void deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified managed policy.
Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:
For information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
deletePolicy
in interface AmazonIdentityManagement
deletePolicyRequest
- 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.public void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified managed policy.
You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, refer to Versioning for Managed Policies in the IAM User Guide.
deletePolicyVersion
in interface AmazonIdentityManagement
deletePolicyVersionRequest
- 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.public void deleteRole(DeleteRoleRequest deleteRoleRequest)
Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.
deleteRole
in interface AmazonIdentityManagement
deleteRoleRequest
- 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.public void deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
Deletes the specified inline policy that is embedded in the specified role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
deleteRolePolicy
in interface AmazonIdentityManagement
deleteRolePolicyRequest
- 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.public void deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
Deletes a SAML provider.
Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail.
deleteSAMLProvider
in interface AmazonIdentityManagement
deleteSAMLProviderRequest
- 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.public void 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.
deleteSSHPublicKey
in interface AmazonIdentityManagement
deleteSSHPublicKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that
does not exist. The error message describes the entity.public void 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.
deleteServerCertificate
in interface AmazonIdentityManagement
deleteServerCertificateRequest
- 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.public void deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
Deletes the specified signing certificate associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
deleteSigningCertificate
in interface AmazonIdentityManagement
deleteSigningCertificateRequest
- 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.public void deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.
deleteUser
in interface AmazonIdentityManagement
deleteUserRequest
- 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.public void deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
Deletes the specified inline policy that is embedded in the specified user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
deleteUserPolicy
in interface AmazonIdentityManagement
deleteUserPolicyRequest
- 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.public void deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
Deletes a virtual MFA device.
deleteVirtualMFADevice
in interface AmazonIdentityManagement
deleteVirtualMFADeviceRequest
- 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.public void detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest)
Removes the specified managed policy from the specified group.
A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
detachGroupPolicy
in interface AmazonIdentityManagement
detachGroupPolicyRequest
- 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.public void 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, refer to Managed Policies and Inline Policies in the IAM User Guide.
detachRolePolicy
in interface AmazonIdentityManagement
detachRolePolicyRequest
- 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.public void 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, refer to Managed Policies and Inline Policies in the IAM User Guide.
detachUserPolicy
in interface AmazonIdentityManagement
detachUserPolicyRequest
- 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.public void enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.
enableMFADevice
in interface AmazonIdentityManagement
enableMFADeviceRequest
- 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.public 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.
generateCredentialReport
in interface AmazonIdentityManagement
generateCredentialReportRequest
- 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.public GenerateCredentialReportResult generateCredentialReport()
AmazonIdentityManagement
generateCredentialReport
in interface AmazonIdentityManagement
AmazonIdentityManagement.generateCredentialReport(GenerateCredentialReportRequest)
public 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.
getAccessKeyLastUsed
in interface AmazonIdentityManagement
getAccessKeyLastUsedRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that
does not exist. The error message describes the entity.public GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
You can optionally filter the results using the Filter
parameter. You can paginate the results using the MaxItems
and Marker
parameters.
getAccountAuthorizationDetails
in interface AmazonIdentityManagement
getAccountAuthorizationDetailsRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails()
AmazonIdentityManagement
getAccountAuthorizationDetails
in interface AmazonIdentityManagement
AmazonIdentityManagement.getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest)
public GetAccountPasswordPolicyResult getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest)
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
getAccountPasswordPolicy
in interface AmazonIdentityManagement
getAccountPasswordPolicyRequest
- 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.public GetAccountPasswordPolicyResult getAccountPasswordPolicy()
AmazonIdentityManagement
getAccountPasswordPolicy
in interface AmazonIdentityManagement
AmazonIdentityManagement.getAccountPasswordPolicy(GetAccountPasswordPolicyRequest)
public 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.
getAccountSummary
in interface AmazonIdentityManagement
getAccountSummaryRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public GetAccountSummaryResult getAccountSummary()
AmazonIdentityManagement
getAccountSummary
in interface AmazonIdentityManagement
AmazonIdentityManagement.getAccountSummary(GetAccountSummaryRequest)
public GetContextKeysForCustomPolicyResult getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest)
Gets a list of all of the context keys referenced in
Condition
elements in the input policies. The policies are
supplied as a list of one or more strings. To get the context keys from
policies associated with an IAM user, group, or role, use
GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by AWS and its services that
provide details about the context of an API query request, and can be
evaluated by using the Condition
element of an IAM policy.
Use GetContextKeysForCustomPolicy to understand what key names and values
you must supply when you call SimulateCustomPolicy. Note that all
parameters are shown in unencoded form here for clarity, but must be URL
encoded to be included as a part of a real HTML request.
getContextKeysForCustomPolicy
in interface AmazonIdentityManagement
getContextKeysForCustomPolicyRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value
was supplied for an input parameter.public GetContextKeysForPrincipalPolicyResult getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in
Condition
elements in all of the IAM policies attached to
the specified IAM entity. The entity can be an IAM user, group, or role.
If you specify a user, then the request also includes all of the policies
attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that
provide details about the context of an API query request, and can be
evaluated by using the Condition
element of an IAM policy.
Use GetContextKeysForPrincipalPolicy to understand what key names and
values you must supply when you call SimulatePrincipalPolicy.
getContextKeysForPrincipalPolicy
in interface AmazonIdentityManagement
getContextKeysForPrincipalPolicyRequest
- 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.public 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.
getCredentialReport
in interface AmazonIdentityManagement
getCredentialReportRequest
- 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.public GetCredentialReportResult getCredentialReport()
AmazonIdentityManagement
getCredentialReport
in interface AmazonIdentityManagement
AmazonIdentityManagement.getCredentialReport(GetCredentialReportRequest)
public GetGroupResult getGroup(GetGroupRequest getGroupRequest)
Returns a list of users that are in the specified group. You can paginate
the results using the MaxItems
and Marker
parameters.
getGroup
in interface AmazonIdentityManagement
getGroupRequest
- 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.public GetGroupPolicyResult getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified group.
A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
getGroupPolicy
in interface AmazonIdentityManagement
getGroupPolicyRequest
- 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.public GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles. For more information about ARNs, go to ARNs.
getInstanceProfile
in interface AmazonIdentityManagement
getInstanceProfileRequest
- 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.public GetLoginProfileResult getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
Retrieves the user name and password-creation date for the specified
user. If the user has not been assigned a password, the action returns a
404 (NoSuchEntity
) error.
getLoginProfile
in interface AmazonIdentityManagement
getLoginProfileRequest
- 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.public GetOpenIDConnectProviderResult getOpenIDConnectProvider(GetOpenIDConnectProviderRequest getOpenIDConnectProviderRequest)
Returns information about the specified OpenID Connect provider.
getOpenIDConnectProvider
in interface AmazonIdentityManagement
getOpenIDConnectProviderRequest
- 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.public GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use GetPolicyVersion.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
getPolicy
in interface AmazonIdentityManagement
getPolicyRequest
- 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.public 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, refer to Managed Policies and Inline Policies in the IAM User Guide.
getPolicyVersion
in interface AmazonIdentityManagement
getPolicyVersionRequest
- 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.public GetRoleResult getRole(GetRoleRequest getRoleRequest)
Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles.
getRole
in interface AmazonIdentityManagement
getRoleRequest
- 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.public GetRolePolicyResult getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
Retrieves the specified inline policy document that is embedded with the specified role.
A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
getRolePolicy
in interface AmazonIdentityManagement
getRolePolicyRequest
- 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.public GetSAMLProviderResult getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the provider was created or updated.
getSAMLProvider
in interface AmazonIdentityManagement
getSAMLProviderRequest
- 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.public 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.
getSSHPublicKey
in interface AmazonIdentityManagement
getSSHPublicKeyRequest
- 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.public GetServerCertificateResult getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
Retrieves information about the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
getServerCertificate
in interface AmazonIdentityManagement
getServerCertificateRequest
- 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.public GetUserResult getUser(GetUserRequest getUserRequest)
Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request.
getUser
in interface AmazonIdentityManagement
getUserRequest
- 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.public GetUserResult getUser()
AmazonIdentityManagement
getUser
in interface AmazonIdentityManagement
AmazonIdentityManagement.getUser(GetUserRequest)
public GetUserPolicyResult getUserPolicy(GetUserPolicyRequest getUserPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified user.
A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
getUserPolicy
in interface AmazonIdentityManagement
getUserPolicyRequest
- 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.public ListAccessKeysResult listAccessKeys(ListAccessKeysRequest listAccessKeysRequest)
Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still
paginate the results using the MaxItems
and
Marker
parameters.
If the UserName
field is not specified, the UserName is
determined implicitly based on the AWS access key ID used to sign the
request. Because this action works for access keys under the AWS account,
you can use this action to manage root credentials even if the AWS
account has no associated users.
listAccessKeys
in interface AmazonIdentityManagement
listAccessKeysRequest
- 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.public ListAccessKeysResult listAccessKeys()
AmazonIdentityManagement
listAccessKeys
in interface AmazonIdentityManagement
AmazonIdentityManagement.listAccessKeys(ListAccessKeysRequest)
public ListAccountAliasesResult listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
listAccountAliases
in interface AmazonIdentityManagement
listAccountAliasesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListAccountAliasesResult listAccountAliases()
AmazonIdentityManagement
listAccountAliases
in interface AmazonIdentityManagement
AmazonIdentityManagement.listAccountAliases(ListAccountAliasesRequest)
public ListAttachedGroupPoliciesResult listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified group.
A group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems
and
Marker
parameters. You can use the PathPrefix
parameter to limit the list of policies to only those matching the
specified path prefix. If there are no policies attached to the specified
group (or none that match the specified path prefix), the action returns
an empty list.
listAttachedGroupPolicies
in interface AmazonIdentityManagement
listAttachedGroupPoliciesRequest
- 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.public ListAttachedRolePoliciesResult listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified role.
A role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems
and
Marker
parameters. You can use the PathPrefix
parameter to limit the list of policies to only those matching the
specified path prefix. If there are no policies attached to the specified
role (or none that match the specified path prefix), the action returns
an empty list.
listAttachedRolePolicies
in interface AmazonIdentityManagement
listAttachedRolePoliciesRequest
- 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.public ListAttachedUserPoliciesResult listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified user.
A user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems
and
Marker
parameters. You can use the PathPrefix
parameter to limit the list of policies to only those matching the
specified path prefix. If there are no policies attached to the specified
group (or none that match the specified path prefix), the action returns
an empty list.
listAttachedUserPolicies
in interface AmazonIdentityManagement
listAttachedUserPoliciesRequest
- 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.public ListEntitiesForPolicyResult listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest)
Lists all users, groups, and roles that the specified managed policy is attached to.
You can use the optional EntityFilter
parameter to limit the
results to a particular type of entity (users, groups, or roles). For
example, to list only the roles that are attached to the specified
policy, set EntityFilter
to Role
.
You can paginate the results using the MaxItems
and
Marker
parameters.
listEntitiesForPolicy
in interface AmazonIdentityManagement
listEntitiesForPolicyRequest
- 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.public ListGroupPoliciesResult listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified group.
A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems
and
Marker
parameters. If there are no inline policies embedded
with the specified group, the action returns an empty list.
listGroupPolicies
in interface AmazonIdentityManagement
listGroupPoliciesRequest
- 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.public ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems
and
Marker
parameters.
listGroups
in interface AmazonIdentityManagement
listGroupsRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListGroupsResult listGroups()
AmazonIdentityManagement
listGroups
in interface AmazonIdentityManagement
AmazonIdentityManagement.listGroups(ListGroupsRequest)
public ListGroupsForUserResult listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the groups the specified user belongs to.
You can paginate the results using the MaxItems
and
Marker
parameters.
listGroupsForUser
in interface AmazonIdentityManagement
listGroupsForUserRequest
- 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.public ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems
and
Marker
parameters.
listInstanceProfiles
in interface AmazonIdentityManagement
listInstanceProfilesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListInstanceProfilesResult listInstanceProfiles()
AmazonIdentityManagement
listInstanceProfiles
in interface AmazonIdentityManagement
AmazonIdentityManagement.listInstanceProfiles(ListInstanceProfilesRequest)
public ListInstanceProfilesForRoleResult listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems
and
Marker
parameters.
listInstanceProfilesForRole
in interface AmazonIdentityManagement
listInstanceProfilesForRoleRequest
- 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.public ListMFADevicesResult listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.
You can paginate the results using the MaxItems
and
Marker
parameters.
listMFADevices
in interface AmazonIdentityManagement
listMFADevicesRequest
- 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.public ListMFADevicesResult listMFADevices()
AmazonIdentityManagement
listMFADevices
in interface AmazonIdentityManagement
AmazonIdentityManagement.listMFADevices(ListMFADevicesRequest)
public ListOpenIDConnectProvidersResult listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest listOpenIDConnectProvidersRequest)
Lists information about the OpenID Connect providers in the AWS account.
listOpenIDConnectProviders
in interface AmazonIdentityManagement
listOpenIDConnectProvidersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListOpenIDConnectProvidersResult listOpenIDConnectProviders()
AmazonIdentityManagement
listOpenIDConnectProviders
in interface AmazonIdentityManagement
AmazonIdentityManagement.listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest)
public ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional
OnlyAttached
, Scope
, and
PathPrefix
parameters. For example, to list only the
customer managed policies in your AWS account, set Scope
to
Local
. To list only AWS managed policies, set
Scope
to AWS
.
You can paginate the results using the MaxItems
and
Marker
parameters.
For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
listPolicies
in interface AmazonIdentityManagement
listPoliciesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListPoliciesResult listPolicies()
AmazonIdentityManagement
listPolicies
in interface AmazonIdentityManagement
AmazonIdentityManagement.listPolicies(ListPoliciesRequest)
public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version.
For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
listPolicyVersions
in interface AmazonIdentityManagement
listPolicyVersionsRequest
- 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.public ListRolePoliciesResult listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified role.
A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems
and
Marker
parameters. If there are no inline policies embedded
with the specified role, the action returns an empty list.
listRolePolicies
in interface AmazonIdentityManagement
listRolePoliciesRequest
- 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.public ListRolesResult listRoles(ListRolesRequest listRolesRequest)
Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.
You can paginate the results using the MaxItems
and
Marker
parameters.
listRoles
in interface AmazonIdentityManagement
listRolesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListRolesResult listRoles()
AmazonIdentityManagement
listRoles
in interface AmazonIdentityManagement
AmazonIdentityManagement.listRoles(ListRolesRequest)
public ListSAMLProvidersResult listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
Lists the SAML providers in the account.
listSAMLProviders
in interface AmazonIdentityManagement
listSAMLProvidersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListSAMLProvidersResult listSAMLProviders()
AmazonIdentityManagement
listSAMLProviders
in interface AmazonIdentityManagement
AmazonIdentityManagement.listSAMLProviders(ListSAMLProvidersRequest)
public 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
and
Marker
parameters.
listSSHPublicKeys
in interface AmazonIdentityManagement
listSSHPublicKeysRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that
does not exist. The error message describes the entity.public ListSSHPublicKeysResult listSSHPublicKeys()
AmazonIdentityManagement
listSSHPublicKeys
in interface AmazonIdentityManagement
AmazonIdentityManagement.listSSHPublicKeys(ListSSHPublicKeysRequest)
public ListServerCertificatesResult listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems
and
Marker
parameters.
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.
listServerCertificates
in interface AmazonIdentityManagement
listServerCertificatesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListServerCertificatesResult listServerCertificates()
AmazonIdentityManagement
listServerCertificates
in interface AmazonIdentityManagement
AmazonIdentityManagement.listServerCertificates(ListServerCertificatesRequest)
public ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates,
you can still paginate the results using the MaxItems
and
Marker
parameters.
If the UserName
field is not specified, the user name is
determined implicitly based on the AWS access key ID used to sign the
request. Because this action works for access keys under the AWS account,
you can use this action to manage root credentials even if the AWS
account has no associated users.
listSigningCertificates
in interface AmazonIdentityManagement
listSigningCertificatesRequest
- 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.public ListSigningCertificatesResult listSigningCertificates()
AmazonIdentityManagement
listSigningCertificates
in interface AmazonIdentityManagement
AmazonIdentityManagement.listSigningCertificates(ListSigningCertificatesRequest)
public ListUserPoliciesResult listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified user.
A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems
and
Marker
parameters. If there are no inline policies embedded
with the specified user, the action returns an empty list.
listUserPolicies
in interface AmazonIdentityManagement
listUserPoliciesRequest
- 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.public 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
and
Marker
parameters.
listUsers
in interface AmazonIdentityManagement
listUsersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error,
exception or failure.public ListUsersResult listUsers()
AmazonIdentityManagement
listUsers
in interface AmazonIdentityManagement
AmazonIdentityManagement.listUsers(ListUsersRequest)
public ListVirtualMFADevicesResult listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
Lists the virtual MFA devices under the AWS account by assignment status.
If you do not specify an assignment status, the action returns a list of
all virtual MFA devices. Assignment status can be Assigned
,
Unassigned
, or Any
.
You can paginate the results using the MaxItems
and
Marker
parameters.
listVirtualMFADevices
in interface AmazonIdentityManagement
listVirtualMFADevicesRequest
- public ListVirtualMFADevicesResult listVirtualMFADevices()
AmazonIdentityManagement
listVirtualMFADevices
in interface AmazonIdentityManagement
AmazonIdentityManagement.listVirtualMFADevices(ListVirtualMFADevicesRequest)
public void putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
Adds (or updates) an inline policy document that is embedded in the specified group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.
PutGroupPolicy
. For general
information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. putGroupPolicy
in interface AmazonIdentityManagement
putGroupPolicyRequest
- 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.public void putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
Adds (or updates) an inline policy document that is embedded in the specified role.
When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.
PutRolePolicy
. For general information
about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. putRolePolicy
in interface AmazonIdentityManagement
putRolePolicyRequest
- 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.public void putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
Adds (or updates) an inline policy document that is embedded in the specified user.
A user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.
PutUserPolicy
. For general information
about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. putUserPolicy
in interface AmazonIdentityManagement
putUserPolicyRequest
- 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.public void 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 provider.
This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously.
removeClientIDFromOpenIDConnectProvider
in interface AmazonIdentityManagement
removeClientIDFromOpenIDConnectProviderRequest
- 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.public void removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
Removes the specified role from the specified instance profile.
For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
removeRoleFromInstanceProfile
in interface AmazonIdentityManagement
removeRoleFromInstanceProfileRequest
- 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.public void removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
Removes the specified user from the specified group.
removeUserFromGroup
in interface AmazonIdentityManagement
removeUserFromGroupRequest
- 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.public void resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
Synchronizes the specified MFA device with AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
resyncMFADevice
in interface AmazonIdentityManagement
resyncMFADeviceRequest
- 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.public void 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, refer to Managed Policies and Inline Policies in the IAM User Guide.
setDefaultPolicyVersion
in interface AmazonIdentityManagement
setDefaultPolicyVersionRequest
- 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.public 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
and
Marker
parameters to paginate the results.
simulateCustomPolicy
in interface AmazonIdentityManagement
simulateCustomPolicyRequest
- 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.public 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
and
Marker
parameters to paginate the results.
simulatePrincipalPolicy
in interface AmazonIdentityManagement
simulatePrincipalPolicyRequest
- 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.public void updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest)
Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.
If the UserName
field is not specified, the UserName is
determined implicitly based on the AWS access key ID used to sign the
request. Because this action works for access keys under the AWS account,
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.
updateAccessKey
in interface AmazonIdentityManagement
updateAccessKeyRequest
- 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.public void 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.
updateAccountPasswordPolicy
in interface AmazonIdentityManagement
updateAccountPasswordPolicyRequest
- 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.public void updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
Updates the policy that grants an entity permission to assume a role. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
updateAssumeRolePolicy
in interface AmazonIdentityManagement
updateAssumeRolePolicyRequest
- 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.public void updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the name and/or the path of the specified group.
updateGroup
in interface AmazonIdentityManagement
updateGroupRequest
- 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.public void updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
Changes the password for the specified user.
Users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.
updateLoginProfile
in interface AmazonIdentityManagement
updateLoginProfileRequest
- 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.public void updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest updateOpenIDConnectProviderThumbprintRequest)
Replaces the existing list of server certificate thumbprints with a new list.
The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated.
UpdateOpenIDConnectProviderThumbprint
action to
highly-privileged users. updateOpenIDConnectProviderThumbprint
in interface AmazonIdentityManagement
updateOpenIDConnectProviderThumbprintRequest
- 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.public UpdateSAMLProviderResult updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider.
updateSAMLProvider
in interface AmazonIdentityManagement
updateSAMLProviderRequest
- 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.public void updateSSHPublicKey(UpdateSSHPublicKeyRequest updateSSHPublicKeyRequest)
Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
updateSSHPublicKey
in interface AmazonIdentityManagement
updateSSHPublicKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that
does not exist. The error message describes the entity.public void updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
Updates the name and/or the path of the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
updateServerCertificate
in interface AmazonIdentityManagement
updateServerCertificateRequest
- 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.public void updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow.
If the UserName
field is not specified, the UserName is
determined implicitly based on the AWS access key ID used to sign the
request. Because this action works for access keys under the AWS account,
you can use this action to manage root credentials even if the AWS
account has no associated users.
updateSigningCertificate
in interface AmazonIdentityManagement
updateSigningCertificateRequest
- 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.public void updateUser(UpdateUserRequest updateUserRequest)
Updates the name and/or the path of the specified user.
updateUser
in interface AmazonIdentityManagement
updateUserRequest
- 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.public 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.
uploadSSHPublicKey
in interface AmazonIdentityManagement
uploadSSHPublicKeyRequest
- 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.public UploadServerCertificateResult uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest)
Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
For 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.
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. uploadServerCertificate
in interface AmazonIdentityManagement
uploadServerCertificateRequest
- 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.public UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest)
Uploads an X.509 signing certificate and associates it with the specified
user. Some AWS services use X.509 signing certificates to validate
requests that are signed with a corresponding private key. When you
upload the certificate, its default status is Active
.
If the UserName
field is not specified, the user name is
determined implicitly based on the AWS access key ID used to sign the
request. Because this action works for access keys under the AWS account,
you can use this action to manage root credentials even if the AWS
account has no associated users.
UploadSigningCertificate
. For information about setting up
signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For
general information about using the Query API with IAM, go to Making Query Requests in the Using IAMguide. uploadSigningCertificate
in interface AmazonIdentityManagement
uploadSigningCertificateRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonIdentityManagement
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.