Class AbstractAmazonIdentityManagement
- All Implemented Interfaces:
AmazonIdentityManagement
- Direct Known Subclasses:
AbstractAmazonIdentityManagementAsync
AmazonIdentityManagement
. Convenient
method forms pass through to the corresponding overload that takes a request
object, which throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.Adds the specified IAM role to the specified instance profile.addUserToGroup
(AddUserToGroupRequest request) Adds the specified user to the specified group.Attaches the specified managed policy to the specified IAM group.attachRolePolicy
(AttachRolePolicyRequest request) Attaches the specified managed policy to the specified IAM role.attachUserPolicy
(AttachUserPolicyRequest request) Attaches the specified managed policy to the specified user.changePassword
(ChangePasswordRequest request) Changes the password of the IAM user who is calling this action.Simplified method form for invoking the CreateAccessKey operation.createAccessKey
(CreateAccessKeyRequest request) Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.Creates an alias for your AWS account.createGroup
(CreateGroupRequest request) Creates a new group.Creates a new instance profile.Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console.Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).createPolicy
(CreatePolicyRequest request) Creates a new managed policy for your AWS account.Creates a new version of the specified managed policy.createRole
(CreateRoleRequest request) Creates a new role for your AWS account.Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.createUser
(CreateUserRequest request) Creates a new IAM user for your AWS account.Creates a new virtual MFA device for the AWS account.Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.deleteAccessKey
(DeleteAccessKeyRequest request) Deletes the access key pair associated with the specified IAM user.Deletes the specified AWS account alias.Simplified method form for invoking the DeleteAccountPasswordPolicy operation.Deletes the password policy for the AWS account.deleteGroup
(DeleteGroupRequest request) Deletes the specified IAM group.Deletes the specified inline policy that is embedded in the specified IAM group.Deletes the specified instance profile.Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.Deletes an OpenID Connect identity provider (IdP) resource object in IAM.deletePolicy
(DeletePolicyRequest request) Deletes the specified managed policy.Deletes the specified version from the specified managed policy.deleteRole
(DeleteRoleRequest request) Deletes the specified role.deleteRolePolicy
(DeleteRolePolicyRequest request) Deletes the specified inline policy that is embedded in the specified IAM role.Deletes a SAML provider resource in IAM.Deletes the specified server certificate.Deletes a signing certificate associated with the specified IAM user.Deletes the specified SSH public key.deleteUser
(DeleteUserRequest request) Deletes the specified IAM user.deleteUserPolicy
(DeleteUserPolicyRequest request) Deletes the specified inline policy that is embedded in the specified IAM user.Deletes a virtual MFA device.Removes the specified managed policy from the specified IAM group.detachRolePolicy
(DetachRolePolicyRequest request) Removes the specified managed policy from the specified role.detachUserPolicy
(DetachUserPolicyRequest request) Removes the specified managed policy from the specified user.enableMFADevice
(EnableMFADeviceRequest request) Enables the specified MFA device and associates it with the specified IAM user.Simplified method form for invoking the GenerateCredentialReport operation.Generates a credential report for the AWS account.Retrieves information about when the specified access key was last used.Simplified method form for invoking the GetAccountAuthorizationDetails operation.Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another.Simplified method form for invoking the GetAccountPasswordPolicy operation.Retrieves the password policy for the AWS account.Simplified method form for invoking the GetAccountSummary operation.Retrieves information about IAM entity usage and IAM quotas in the AWS account.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.Gets a list of all of the context keys referenced in the input policies.Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity.Simplified method form for invoking the GetCredentialReport operation.Retrieves a credential report for the AWS account.getGroup
(GetGroupRequest request) Returns a list of IAM users that are in the specified IAM group.getGroupPolicy
(GetGroupPolicyRequest request) Retrieves the specified inline policy document that is embedded in the specified IAM group.Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role.getLoginProfile
(GetLoginProfileRequest request) Retrieves the user name and password-creation date for the specified IAM user.Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.getPolicy
(GetPolicyRequest request) Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached.getPolicyVersion
(GetPolicyVersionRequest request) Retrieves information about the specified version of the specified managed policy, including the policy document.getRole
(GetRoleRequest request) Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role.getRolePolicy
(GetRolePolicyRequest request) Retrieves the specified inline policy document that is embedded with the specified IAM role.getSAMLProvider
(GetSAMLProviderRequest request) Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.Retrieves information about the specified server certificate stored in IAM.getSSHPublicKey
(GetSSHPublicKeyRequest request) Retrieves the specified SSH public key, including metadata about the key.getUser()
Simplified method form for invoking the GetUser operation.getUser
(GetUserRequest request) Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.getUserPolicy
(GetUserPolicyRequest request) Retrieves the specified inline policy document that is embedded in the specified IAM user.Simplified method form for invoking the ListAccessKeys operation.listAccessKeys
(ListAccessKeysRequest request) Returns information about the access key IDs associated with the specified IAM user.Simplified method form for invoking the ListAccountAliases operation.Lists the account alias associated with the AWS account (Note: you can have only one).Lists all managed policies that are attached to the specified IAM group.Lists all managed policies that are attached to the specified IAM role.Lists all managed policies that are attached to the specified IAM user.Lists all IAM users, groups, and roles that the specified managed policy is attached to.Lists the names of the inline policies that are embedded in the specified IAM group.Simplified method form for invoking the ListGroups operation.listGroups
(ListGroupsRequest request) Lists the IAM groups that have the specified path prefix.Lists the IAM groups that the specified IAM user belongs to.Simplified method form for invoking the ListInstanceProfiles operation.Lists the instance profiles that have the specified path prefix.Lists the instance profiles that have the specified associated IAM role.Simplified method form for invoking the ListMFADevices operation.listMFADevices
(ListMFADevicesRequest request) Lists the MFA devices for an IAM user.Simplified method form for invoking the ListOpenIDConnectProviders operation.Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.Simplified method form for invoking the ListPolicies operation.listPolicies
(ListPoliciesRequest request) Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.listRolePolicies
(ListRolePoliciesRequest request) Lists the names of the inline policies that are embedded in the specified IAM role.Simplified method form for invoking the ListRoles operation.listRoles
(ListRolesRequest request) Lists the IAM roles that have the specified path prefix.Simplified method form for invoking the ListSAMLProviders operation.Lists the SAML provider resource objects defined in IAM in the account.Simplified method form for invoking the ListServerCertificates operation.Lists the server certificates stored in IAM that have the specified path prefix.Simplified method form for invoking the ListSigningCertificates operation.Returns information about the signing certificates associated with the specified IAM user.Simplified method form for invoking the ListSSHPublicKeys operation.Returns information about the SSH public keys associated with the specified IAM user.listUserPolicies
(ListUserPoliciesRequest request) Lists the names of the inline policies embedded in the specified IAM user.Simplified method form for invoking the ListUsers operation.listUsers
(ListUsersRequest request) Lists the IAM users that have the specified path prefix.Simplified method form for invoking the ListVirtualMFADevices operation.Lists the virtual MFA devices defined in the AWS account by assignment status.putGroupPolicy
(PutGroupPolicyRequest request) Adds or updates an inline policy document that is embedded in the specified IAM group.putRolePolicy
(PutRolePolicyRequest request) Adds or updates an inline policy document that is embedded in the specified IAM role.putUserPolicy
(PutUserPolicyRequest request) Adds or updates an inline policy document that is embedded in the specified IAM user.Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.Removes the specified IAM role from the specified EC2 instance profile.Removes the specified user from the specified group.resyncMFADevice
(ResyncMFADeviceRequest request) Synchronizes the specified MFA device with its IAM resource object on the AWS servers.Sets the specified version of the specified policy as the policy's default (operative) version.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("iam.amazonaws.com").void
An alternative toAmazonIdentityManagement.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.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.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.updateAccessKey
(UpdateAccessKeyRequest request) Changes the status of the specified access key from Active to Inactive, or vice versa.Updates the password policy settings for the AWS account.Updates the policy that grants an IAM entity permission to assume a role.updateGroup
(UpdateGroupRequest request) Updates the name and/or the path of the specified IAM group.Changes the password for the specified IAM user.Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.Updates the metadata document for an existing SAML provider resource object.Updates the name and/or the path of the specified server certificate stored in IAM.Changes the status of the specified user signing certificate from active to disabled, or vice versa.Sets the status of an IAM user's SSH public key to active or inactive.updateUser
(UpdateUserRequest request) Updates the name and/or the path of the specified IAM user.Uploads a server certificate entity for the AWS account.Uploads an X.509 signing certificate and associates it with the specified IAM user.Uploads an SSH public key and associates it with the specified IAM user.
-
Constructor Details
-
AbstractAmazonIdentityManagement
protected AbstractAmazonIdentityManagement()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonIdentityManagement
Overrides the default endpoint for this client ("iam.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "iam.amazonaws.com") or a full URL, including the protocol (ex: "iam.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonIdentityManagement
- Parameters:
endpoint
- The endpoint (ex: "iam.amazonaws.com") or a full URL, including the protocol (ex: "iam.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AmazonIdentityManagement
An alternative toAmazonIdentityManagement.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonIdentityManagement
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
addClientIDToOpenIDConnectProvider
public AddClientIDToOpenIDConnectProviderResult addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest request) Description copied from interface:AmazonIdentityManagement
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
- Specified by:
addClientIDToOpenIDConnectProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the AddClientIDToOpenIDConnectProvider operation returned by the service.
-
addRoleToInstanceProfile
public AddRoleToInstanceProfileResult addRoleToInstanceProfile(AddRoleToInstanceProfileRequest request) Description copied from interface:AmazonIdentityManagement
Adds the specified IAM role to the specified instance profile.
The caller of this API must be granted the
PassRole
permission on the IAM role by a permission policy.For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
- Specified by:
addRoleToInstanceProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the AddRoleToInstanceProfile operation returned by the service.
-
addUserToGroup
Description copied from interface:AmazonIdentityManagement
Adds the specified user to the specified group.
- Specified by:
addUserToGroup
in interfaceAmazonIdentityManagement
- Returns:
- Result of the AddUserToGroup operation returned by the service.
-
attachGroupPolicy
Description copied from interface:AmazonIdentityManagement
Attaches the specified managed policy to the specified IAM group.
You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
attachGroupPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the AttachGroupPolicy operation returned by the service.
-
attachRolePolicy
Description copied from interface:AmazonIdentityManagement
Attaches the specified managed policy to the specified IAM role.
When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.
Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
attachRolePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the AttachRolePolicy operation returned by the service.
-
attachUserPolicy
Description copied from interface:AmazonIdentityManagement
Attaches the specified managed policy to the specified user.
You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
attachUserPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the AttachUserPolicy operation returned by the service.
-
changePassword
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
changePassword
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ChangePassword operation returned by the service.
-
createAccessKey
Description copied from interface:AmazonIdentityManagement
Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is
Active
.If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.
To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.
- Specified by:
createAccessKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateAccessKey operation returned by the service.
-
createAccessKey
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the CreateAccessKey operation.- Specified by:
createAccessKey
in interfaceAmazonIdentityManagement
- See Also:
-
createAccountAlias
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
createAccountAlias
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateAccountAlias operation returned by the service.
-
createGroup
Description copied from interface:AmazonIdentityManagement
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
- Specified by:
createGroup
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateGroup operation returned by the service.
-
createInstanceProfile
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
createInstanceProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateInstanceProfile operation returned by the service.
-
createLoginProfile
Description copied from interface:AmazonIdentityManagement
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide.
- Specified by:
createLoginProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateLoginProfile operation returned by the service.
-
createOpenIDConnectProvider
public CreateOpenIDConnectProviderResult createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest request) Description copied from interface:AmazonIdentityManagement
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider.
When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.
Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the CreateOpenIDConnectProvider action to highly-privileged users.
- Specified by:
createOpenIDConnectProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateOpenIDConnectProvider operation returned by the service.
-
createPolicy
Description copied from interface:AmazonIdentityManagement
Creates a new managed policy for your AWS account.
This operation creates a policy version with a version identifier of
v1
and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide.For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
createPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreatePolicy operation returned by the service.
-
createPolicyVersion
Description copied from interface:AmazonIdentityManagement
Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
- Specified by:
createPolicyVersion
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreatePolicyVersion operation returned by the service.
-
createRole
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
createRole
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateRole operation returned by the service.
-
createSAMLProvider
Description copied from interface:AmazonIdentityManagement
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider resource, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.
- Specified by:
createSAMLProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateSAMLProvider operation returned by the service.
-
createUser
Description copied from interface:AmazonIdentityManagement
Creates a new IAM user for your AWS account.
For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.
- Specified by:
createUser
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateUser operation returned by the service.
-
createVirtualMFADevice
Description copied from interface:AmazonIdentityManagement
Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
- Specified by:
createVirtualMFADevice
in interfaceAmazonIdentityManagement
- Returns:
- Result of the CreateVirtualMFADevice operation returned by the service.
-
deactivateMFADevice
Description copied from interface:AmazonIdentityManagement
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
- Specified by:
deactivateMFADevice
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeactivateMFADevice operation returned by the service.
-
deleteAccessKey
Description copied from interface:AmazonIdentityManagement
Deletes the access key pair associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
- Specified by:
deleteAccessKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteAccessKey operation returned by the service.
-
deleteAccountAlias
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
deleteAccountAlias
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteAccountAlias operation returned by the service.
-
deleteAccountPasswordPolicy
public DeleteAccountPasswordPolicyResult deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest request) Description copied from interface:AmazonIdentityManagement
Deletes the password policy for the AWS account. There are no parameters.
- Specified by:
deleteAccountPasswordPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteAccountPasswordPolicy operation returned by the service.
-
deleteAccountPasswordPolicy
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the DeleteAccountPasswordPolicy operation.- Specified by:
deleteAccountPasswordPolicy
in interfaceAmazonIdentityManagement
- See Also:
-
deleteGroup
Description copied from interface:AmazonIdentityManagement
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
- Specified by:
deleteGroup
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteGroup operation returned by the service.
-
deleteGroupPolicy
Description copied from interface:AmazonIdentityManagement
Deletes the specified inline policy that is embedded in the specified IAM group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
deleteGroupPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteGroupPolicy operation returned by the service.
-
deleteInstanceProfile
Description copied from interface:AmazonIdentityManagement
Deletes the specified instance profile. The instance profile must not have an associated role.
Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
For more information about instance profiles, go to About Instance Profiles.
- Specified by:
deleteInstanceProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteInstanceProfile operation returned by the service.
-
deleteLoginProfile
Description copied from interface:AmazonIdentityManagement
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.
Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
- Specified by:
deleteLoginProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteLoginProfile operation returned by the service.
-
deleteOpenIDConnectProvider
public DeleteOpenIDConnectProviderResult deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest request) Description copied from interface:AmazonIdentityManagement
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This action is idempotent; it does not fail or return an error if you call the action for a provider that does not exist.
- Specified by:
deleteOpenIDConnectProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteOpenIDConnectProvider operation returned by the service.
-
deletePolicy
Description copied from interface:AmazonIdentityManagement
Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:
-
Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy APIs. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
-
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
-
Delete the policy (this automatically deletes the policy's default version) using this API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
deletePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeletePolicy operation returned by the service.
-
-
deletePolicyVersion
Description copied from interface:AmazonIdentityManagement
Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide.
- Specified by:
deletePolicyVersion
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeletePolicyVersion operation returned by the service.
-
deleteRole
Description copied from interface:AmazonIdentityManagement
Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.
Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
- Specified by:
deleteRole
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteRole operation returned by the service.
-
deleteRolePolicy
Description copied from interface:AmazonIdentityManagement
Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
deleteRolePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteRolePolicy operation returned by the service.
-
deleteSAMLProvider
Description copied from interface:AmazonIdentityManagement
Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
- Specified by:
deleteSAMLProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteSAMLProvider operation returned by the service.
-
deleteSSHPublicKey
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
deleteSSHPublicKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteSSHPublicKey operation returned by the service.
-
deleteServerCertificate
public DeleteServerCertificateResult deleteServerCertificate(DeleteServerCertificateRequest request) Description copied from interface:AmazonIdentityManagement
Deletes the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
- Specified by:
deleteServerCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteServerCertificate operation returned by the service.
-
deleteSigningCertificate
public DeleteSigningCertificateResult deleteSigningCertificate(DeleteSigningCertificateRequest request) Description copied from interface:AmazonIdentityManagement
Deletes a signing certificate associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated IAM users.
- Specified by:
deleteSigningCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteSigningCertificate operation returned by the service.
-
deleteUser
Description copied from interface:AmazonIdentityManagement
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
- Specified by:
deleteUser
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteUser operation returned by the service.
-
deleteUserPolicy
Description copied from interface:AmazonIdentityManagement
Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
deleteUserPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteUserPolicy operation returned by the service.
-
deleteVirtualMFADevice
Description copied from interface:AmazonIdentityManagement
Deletes a virtual MFA device.
You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
- Specified by:
deleteVirtualMFADevice
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DeleteVirtualMFADevice operation returned by the service.
-
detachGroupPolicy
Description copied from interface:AmazonIdentityManagement
Removes the specified managed policy from the specified IAM group.
A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
detachGroupPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DetachGroupPolicy operation returned by the service.
-
detachRolePolicy
Description copied from interface:AmazonIdentityManagement
Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
detachRolePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DetachRolePolicy operation returned by the service.
-
detachUserPolicy
Description copied from interface:AmazonIdentityManagement
Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
detachUserPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the DetachUserPolicy operation returned by the service.
-
enableMFADevice
Description copied from interface:AmazonIdentityManagement
Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.
- Specified by:
enableMFADevice
in interfaceAmazonIdentityManagement
- Returns:
- Result of the EnableMFADevice operation returned by the service.
-
generateCredentialReport
public GenerateCredentialReportResult generateCredentialReport(GenerateCredentialReportRequest request) Description copied from interface:AmazonIdentityManagement
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
- Specified by:
generateCredentialReport
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GenerateCredentialReport operation returned by the service.
-
generateCredentialReport
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the GenerateCredentialReport operation.- Specified by:
generateCredentialReport
in interfaceAmazonIdentityManagement
- See Also:
-
getAccessKeyLastUsed
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
getAccessKeyLastUsed
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetAccessKeyLastUsed operation returned by the service.
-
getAccountAuthorizationDetails
public GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest request) Description copied from interface:AmazonIdentityManagement
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
You can optionally filter the results using the
Filter
parameter. You can paginate the results using theMaxItems
andMarker
parameters.- Specified by:
getAccountAuthorizationDetails
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetAccountAuthorizationDetails operation returned by the service.
-
getAccountAuthorizationDetails
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the GetAccountAuthorizationDetails operation.- Specified by:
getAccountAuthorizationDetails
in interfaceAmazonIdentityManagement
- See Also:
-
getAccountPasswordPolicy
public GetAccountPasswordPolicyResult getAccountPasswordPolicy(GetAccountPasswordPolicyRequest request) Description copied from interface:AmazonIdentityManagement
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
- Specified by:
getAccountPasswordPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetAccountPasswordPolicy operation returned by the service.
-
getAccountPasswordPolicy
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the GetAccountPasswordPolicy operation.- Specified by:
getAccountPasswordPolicy
in interfaceAmazonIdentityManagement
- See Also:
-
getAccountSummary
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
getAccountSummary
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetAccountSummary operation returned by the service.
-
getAccountSummary
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the GetAccountSummary operation.- Specified by:
getAccountSummary
in interfaceAmazonIdentityManagement
- See Also:
-
getContextKeysForCustomPolicy
public GetContextKeysForCustomPolicyResult getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest request) Description copied from interface:AmazonIdentityManagement
Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
- Specified by:
getContextKeysForCustomPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetContextKeysForCustomPolicy operation returned by the service.
-
getContextKeysForPrincipalPolicy
public GetContextKeysForPrincipalPolicyResult getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest request) Description copied from interface:AmazonIdentityManagement
Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
- Specified by:
getContextKeysForPrincipalPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetContextKeysForPrincipalPolicy operation returned by the service.
-
getCredentialReport
Description copied from interface:AmazonIdentityManagement
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
- Specified by:
getCredentialReport
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetCredentialReport operation returned by the service.
-
getCredentialReport
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the GetCredentialReport operation.- Specified by:
getCredentialReport
in interfaceAmazonIdentityManagement
- See Also:
-
getGroup
Description copied from interface:AmazonIdentityManagement
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
getGroup
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetGroup operation returned by the service.
-
getGroupPolicy
Description copied from interface:AmazonIdentityManagement
Retrieves the specified inline policy document that is embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
getGroupPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetGroupPolicy operation returned by the service.
-
getInstanceProfile
Description copied from interface:AmazonIdentityManagement
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide.
- Specified by:
getInstanceProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetInstanceProfile operation returned by the service.
-
getLoginProfile
Description copied from interface:AmazonIdentityManagement
Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the action returns a 404 (
NoSuchEntity
) error.- Specified by:
getLoginProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetLoginProfile operation returned by the service.
-
getOpenIDConnectProvider
public GetOpenIDConnectProviderResult getOpenIDConnectProvider(GetOpenIDConnectProviderRequest request) Description copied from interface:AmazonIdentityManagement
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
- Specified by:
getOpenIDConnectProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetOpenIDConnectProvider operation returned by the service.
-
getPolicy
Description copied from interface:AmazonIdentityManagement
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
getPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetPolicy operation returned by the service.
-
getPolicyVersion
Description copied from interface:AmazonIdentityManagement
Retrieves information about the specified version of the specified managed policy, including the policy document.
To list the available versions for a policy, use ListPolicyVersions.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
- Specified by:
getPolicyVersion
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetPolicyVersion operation returned by the service.
-
getRole
Description copied from interface:AmazonIdentityManagement
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.
- Specified by:
getRole
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetRole operation returned by the service.
-
getRolePolicy
Description copied from interface:AmazonIdentityManagement
Retrieves the specified inline policy document that is embedded with the specified IAM role.
An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For more information about roles, see Using Roles to Delegate Permissions and Federate Identities.
- Specified by:
getRolePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetRolePolicy operation returned by the service.
-
getSAMLProvider
Description copied from interface:AmazonIdentityManagement
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
This operation requires Signature Version 4.
- Specified by:
getSAMLProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetSAMLProvider operation returned by the service.
-
getSSHPublicKey
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
getSSHPublicKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetSSHPublicKey operation returned by the service.
-
getServerCertificate
Description copied from interface:AmazonIdentityManagement
Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
- Specified by:
getServerCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetServerCertificate operation returned by the service.
-
getUser
Description copied from interface:AmazonIdentityManagement
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API.
- Specified by:
getUser
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetUser operation returned by the service.
-
getUser
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the GetUser operation.- Specified by:
getUser
in interfaceAmazonIdentityManagement
- See Also:
-
getUserPolicy
Description copied from interface:AmazonIdentityManagement
Retrieves the specified inline policy document that is embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
getUserPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the GetUserPolicy operation returned by the service.
-
listAccessKeys
Description copied from interface:AmazonIdentityManagement
Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the
MaxItems
andMarker
parameters.If the
UserName
field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.
- Specified by:
listAccessKeys
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListAccessKeys operation returned by the service.
-
listAccessKeys
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListAccessKeys operation.- Specified by:
listAccessKeys
in interfaceAmazonIdentityManagement
- See Also:
-
listAccountAliases
Description copied from interface:AmazonIdentityManagement
Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
- Specified by:
listAccountAliases
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListAccountAliases operation returned by the service.
-
listAccountAliases
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListAccountAliases operation.- Specified by:
listAccountAliases
in interfaceAmazonIdentityManagement
- See Also:
-
listAttachedGroupPolicies
public ListAttachedGroupPoliciesResult listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest request) Description copied from interface:AmazonIdentityManagement
Lists all managed policies that are attached to the specified IAM group.
An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.- Specified by:
listAttachedGroupPolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListAttachedGroupPolicies operation returned by the service.
-
listAttachedRolePolicies
public ListAttachedRolePoliciesResult listAttachedRolePolicies(ListAttachedRolePoliciesRequest request) Description copied from interface:AmazonIdentityManagement
Lists all managed policies that are attached to the specified IAM role.
An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list.- Specified by:
listAttachedRolePolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListAttachedRolePolicies operation returned by the service.
-
listAttachedUserPolicies
public ListAttachedUserPoliciesResult listAttachedUserPolicies(ListAttachedUserPoliciesRequest request) Description copied from interface:AmazonIdentityManagement
Lists all managed policies that are attached to the specified IAM user.
An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.- Specified by:
listAttachedUserPolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListAttachedUserPolicies operation returned by the service.
-
listEntitiesForPolicy
Description copied from interface:AmazonIdentityManagement
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional
EntityFilter
parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, setEntityFilter
toRole
.You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listEntitiesForPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListEntitiesForPolicy operation returned by the service.
-
listGroupPolicies
Description copied from interface:AmazonIdentityManagement
Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified group, the action returns an empty list.- Specified by:
listGroupPolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListGroupPolicies operation returned by the service.
-
listGroups
Description copied from interface:AmazonIdentityManagement
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listGroups
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListGroups operation returned by the service.
-
listGroups
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListGroups operation.- Specified by:
listGroups
in interfaceAmazonIdentityManagement
- See Also:
-
listGroupsForUser
Description copied from interface:AmazonIdentityManagement
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listGroupsForUser
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListGroupsForUser operation returned by the service.
-
listInstanceProfiles
Description copied from interface:AmazonIdentityManagement
Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listInstanceProfiles
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListInstanceProfiles operation returned by the service.
-
listInstanceProfiles
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListInstanceProfiles operation.- Specified by:
listInstanceProfiles
in interfaceAmazonIdentityManagement
- See Also:
-
listInstanceProfilesForRole
public ListInstanceProfilesForRoleResult listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest request) Description copied from interface:AmazonIdentityManagement
Lists the instance profiles that have the specified associated IAM role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listInstanceProfilesForRole
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListInstanceProfilesForRole operation returned by the service.
-
listMFADevices
Description copied from interface:AmazonIdentityManagement
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listMFADevices
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListMFADevices operation returned by the service.
-
listMFADevices
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListMFADevices operation.- Specified by:
listMFADevices
in interfaceAmazonIdentityManagement
- See Also:
-
listOpenIDConnectProviders
public ListOpenIDConnectProvidersResult listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest request) Description copied from interface:AmazonIdentityManagement
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
- Specified by:
listOpenIDConnectProviders
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListOpenIDConnectProviders operation returned by the service.
-
listOpenIDConnectProviders
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListOpenIDConnectProviders operation.- Specified by:
listOpenIDConnectProviders
in interfaceAmazonIdentityManagement
- See Also:
-
listPolicies
Description copied from interface:AmazonIdentityManagement
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional
OnlyAttached
,Scope
, andPathPrefix
parameters. For example, to list only the customer managed policies in your AWS account, setScope
toLocal
. To list only AWS managed policies, setScope
toAWS
.You can paginate the results using the
MaxItems
andMarker
parameters.For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
listPolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListPolicies operation returned by the service.
-
listPolicies
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListPolicies operation.- Specified by:
listPolicies
in interfaceAmazonIdentityManagement
- See Also:
-
listPolicyVersions
Description copied from interface:AmazonIdentityManagement
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
listPolicyVersions
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListPolicyVersions operation returned by the service.
-
listRolePolicies
Description copied from interface:AmazonIdentityManagement
Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified role, the action returns an empty list.- Specified by:
listRolePolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListRolePolicies operation returned by the service.
-
listRoles
Description copied from interface:AmazonIdentityManagement
Lists the IAM roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listRoles
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListRoles operation returned by the service.
-
listRoles
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListRoles operation.- Specified by:
listRoles
in interfaceAmazonIdentityManagement
- See Also:
-
listSAMLProviders
Description copied from interface:AmazonIdentityManagement
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
- Specified by:
listSAMLProviders
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListSAMLProviders operation returned by the service.
-
listSAMLProviders
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListSAMLProviders operation.- Specified by:
listSAMLProviders
in interfaceAmazonIdentityManagement
- See Also:
-
listSSHPublicKeys
Description copied from interface:AmazonIdentityManagement
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.
The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listSSHPublicKeys
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListSSHPublicKeys operation returned by the service.
-
listSSHPublicKeys
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListSSHPublicKeys operation.- Specified by:
listSSHPublicKeys
in interfaceAmazonIdentityManagement
- See Also:
-
listServerCertificates
Description copied from interface:AmazonIdentityManagement
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the
MaxItems
andMarker
parameters.For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
- Specified by:
listServerCertificates
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListServerCertificates operation returned by the service.
-
listServerCertificates
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListServerCertificates operation.- Specified by:
listServerCertificates
in interfaceAmazonIdentityManagement
- See Also:
-
listSigningCertificates
public ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest request) Description copied from interface:AmazonIdentityManagement
Returns information about the signing certificates associated with the specified IAM user. If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the
MaxItems
andMarker
parameters.If the
UserName
field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.- Specified by:
listSigningCertificates
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListSigningCertificates operation returned by the service.
-
listSigningCertificates
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListSigningCertificates operation.- Specified by:
listSigningCertificates
in interfaceAmazonIdentityManagement
- See Also:
-
listUserPolicies
Description copied from interface:AmazonIdentityManagement
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified user, the action returns an empty list.- Specified by:
listUserPolicies
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListUserPolicies operation returned by the service.
-
listUsers
Description copied from interface:AmazonIdentityManagement
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.
You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listUsers
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListUsers operation returned by the service.
-
listUsers
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListUsers operation.- Specified by:
listUsers
in interfaceAmazonIdentityManagement
- See Also:
-
listVirtualMFADevices
Description copied from interface:AmazonIdentityManagement
Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be
Assigned
,Unassigned
, orAny
.You can paginate the results using the
MaxItems
andMarker
parameters.- Specified by:
listVirtualMFADevices
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ListVirtualMFADevices operation returned by the service.
-
listVirtualMFADevices
Description copied from interface:AmazonIdentityManagement
Simplified method form for invoking the ListVirtualMFADevices operation.- Specified by:
listVirtualMFADevices
in interfaceAmazonIdentityManagement
- See Also:
-
putGroupPolicy
Description copied from interface:AmazonIdentityManagement
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling
PutGroupPolicy
. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Specified by:
putGroupPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the PutGroupPolicy operation returned by the service.
-
putRolePolicy
Description copied from interface:AmazonIdentityManagement
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling
PutRolePolicy
. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Specified by:
putRolePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the PutRolePolicy operation returned by the service.
-
putUserPolicy
Description copied from interface:AmazonIdentityManagement
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling
PutUserPolicy
. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Specified by:
putUserPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the PutUserPolicy operation returned by the service.
-
removeClientIDFromOpenIDConnectProvider
public RemoveClientIDFromOpenIDConnectProviderResult removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest request) Description copied from interface:AmazonIdentityManagement
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This action is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
- Specified by:
removeClientIDFromOpenIDConnectProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the RemoveClientIDFromOpenIDConnectProvider operation returned by the service.
-
removeRoleFromInstanceProfile
public RemoveRoleFromInstanceProfileResult removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest request) Description copied from interface:AmazonIdentityManagement
Removes the specified IAM role from the specified EC2 instance profile.
Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance break any applications running on the instance.
For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
- Specified by:
removeRoleFromInstanceProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the RemoveRoleFromInstanceProfile operation returned by the service.
-
removeUserFromGroup
Description copied from interface:AmazonIdentityManagement
Removes the specified user from the specified group.
- Specified by:
removeUserFromGroup
in interfaceAmazonIdentityManagement
- Returns:
- Result of the RemoveUserFromGroup operation returned by the service.
-
resyncMFADevice
Description copied from interface:AmazonIdentityManagement
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
- Specified by:
resyncMFADevice
in interfaceAmazonIdentityManagement
- Returns:
- Result of the ResyncMFADevice operation returned by the service.
-
setDefaultPolicyVersion
public SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request) Description copied from interface:AmazonIdentityManagement
Sets the specified version of the specified policy as the policy's default (operative) version.
This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
- Specified by:
setDefaultPolicyVersion
in interfaceAmazonIdentityManagement
- Returns:
- Result of the SetDefaultPolicyVersion operation returned by the service.
-
simulateCustomPolicy
Description copied from interface:AmazonIdentityManagement
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.
If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the
Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.If the output is long, you can use
MaxItems
andMarker
parameters to paginate the results.- Specified by:
simulateCustomPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the SimulateCustomPolicy operation returned by the service.
-
simulatePrincipalPolicy
public SimulatePrincipalPolicyResult simulatePrincipalPolicy(SimulatePrincipalPolicyRequest request) Description copied from interface:AmazonIdentityManagement
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to .
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.
The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the
Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.If the output is long, you can use the
MaxItems
andMarker
parameters to paginate the results.- Specified by:
simulatePrincipalPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the SimulatePrincipalPolicy operation returned by the service.
-
updateAccessKey
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
updateAccessKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateAccessKey operation returned by the service.
-
updateAccountPasswordPolicy
public UpdateAccountPasswordPolicyResult updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest request) Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
updateAccountPasswordPolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateAccountPasswordPolicy operation returned by the service.
-
updateAssumeRolePolicy
Description copied from interface:AmazonIdentityManagement
Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
- Specified by:
updateAssumeRolePolicy
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateAssumeRolePolicy operation returned by the service.
-
updateGroup
Description copied from interface:AmazonIdentityManagement
Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.
To change an IAM group name the requester must have appropriate permissions on both the source object and the target object. For example, to change "Managers" to "MGRs", the entity making the request must have permission on both "Managers" and "MGRs", or must have permission on all (*). For more information about permissions, see Permissions and Policies.
- Specified by:
updateGroup
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateGroup operation returned by the service.
-
updateLoginProfile
Description copied from interface:AmazonIdentityManagement
Changes the password for the specified IAM user.
IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.
- Specified by:
updateLoginProfile
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateLoginProfile operation returned by the service.
-
updateOpenIDConnectProviderThumbprint
public UpdateOpenIDConnectProviderThumbprintResult updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest request) Description copied from interface:AmazonIdentityManagement
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Because trust for the OIDC provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the
UpdateOpenIDConnectProviderThumbprint
action to highly-privileged users.- Specified by:
updateOpenIDConnectProviderThumbprint
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateOpenIDConnectProviderThumbprint operation returned by the service.
-
updateSAMLProvider
Description copied from interface:AmazonIdentityManagement
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
- Specified by:
updateSAMLProvider
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateSAMLProvider operation returned by the service.
-
updateSSHPublicKey
Description copied from interface:AmazonIdentityManagement
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
- Specified by:
updateSSHPublicKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateSSHPublicKey operation returned by the service.
-
updateServerCertificate
public UpdateServerCertificateResult updateServerCertificate(UpdateServerCertificateRequest request) Description copied from interface:AmazonIdentityManagement
Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide.
To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from "ProductionCert" to "ProdCert", the entity making the request must have permission on "ProductionCert" and "ProdCert", or must have permission on all (*). For more information about permissions, see Access Management in the IAM User Guide.
- Specified by:
updateServerCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateServerCertificate operation returned by the service.
-
updateSigningCertificate
public UpdateSigningCertificateResult updateSigningCertificate(UpdateSigningCertificateRequest request) Description copied from interface:AmazonIdentityManagement
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the
UserName
field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.- Specified by:
updateSigningCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateSigningCertificate operation returned by the service.
-
updateUser
Description copied from interface:AmazonIdentityManagement
Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide.
To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
- Specified by:
updateUser
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UpdateUser operation returned by the service.
-
uploadSSHPublicKey
Description copied from interface:AmazonIdentityManagement
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.
- Specified by:
uploadSSHPublicKey
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UploadSSHPublicKey operation returned by the service.
-
uploadServerCertificate
public UploadServerCertificateResult uploadServerCertificate(UploadServerCertificateRequest request) Description copied from interface:AmazonIdentityManagement
Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling
UploadServerCertificate
. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide.- Specified by:
uploadServerCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UploadServerCertificate operation returned by the service.
-
uploadSigningCertificate
public UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest request) Description copied from interface:AmazonIdentityManagement
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is
Active
.If the
UserName
field is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling
UploadSigningCertificate
. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.- Specified by:
uploadSigningCertificate
in interfaceAmazonIdentityManagement
- Returns:
- Result of the UploadSigningCertificate operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AmazonIdentityManagement
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAmazonIdentityManagement
-
getCachedResponseMetadata
Description copied from interface:AmazonIdentityManagement
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonIdentityManagement
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-