@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonIdentityManagement extends Object implements AmazonIdentityManagement
AmazonIdentityManagement
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddClientIDToOpenIDConnectProviderResult |
addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest request)
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM
OpenID Connect (OIDC) provider resource.
|
AddRoleToInstanceProfileResult |
addRoleToInstanceProfile(AddRoleToInstanceProfileRequest request)
Adds the specified IAM role to the specified instance profile.
|
AddUserToGroupResult |
addUserToGroup(AddUserToGroupRequest request)
Adds the specified user to the specified group.
|
AttachGroupPolicyResult |
attachGroupPolicy(AttachGroupPolicyRequest request)
Attaches the specified managed policy to the specified IAM group.
|
AttachRolePolicyResult |
attachRolePolicy(AttachRolePolicyRequest request)
Attaches the specified managed policy to the specified IAM role.
|
AttachUserPolicyResult |
attachUserPolicy(AttachUserPolicyRequest request)
Attaches the specified managed policy to the specified user.
|
ChangePasswordResult |
changePassword(ChangePasswordRequest request)
Changes the password of the IAM user who is calling this action.
|
CreateAccessKeyResult |
createAccessKey()
Simplified method form for invoking the CreateAccessKey operation.
|
CreateAccessKeyResult |
createAccessKey(CreateAccessKeyRequest request)
Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
|
CreateAccountAliasResult |
createAccountAlias(CreateAccountAliasRequest request)
Creates an alias for your AWS account.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a new group.
|
CreateInstanceProfileResult |
createInstanceProfile(CreateInstanceProfileRequest request)
Creates a new instance profile.
|
CreateLoginProfileResult |
createLoginProfile(CreateLoginProfileRequest request)
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS
Management Console.
|
CreateOpenIDConnectProviderResult |
createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest request)
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest request)
Creates a new managed policy for your AWS account.
|
CreatePolicyVersionResult |
createPolicyVersion(CreatePolicyVersionRequest request)
Creates a new version of the specified managed policy.
|
CreateRoleResult |
createRole(CreateRoleRequest request)
Creates a new role for your AWS account.
|
CreateSAMLProviderResult |
createSAMLProvider(CreateSAMLProviderRequest request)
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
|
CreateServiceLinkedRoleResult |
createServiceLinkedRole(CreateServiceLinkedRoleRequest request)
Creates an IAM role that is linked to a specific AWS service.
|
CreateServiceSpecificCredentialResult |
createServiceSpecificCredential(CreateServiceSpecificCredentialRequest request)
Generates a set of credentials consisting of a user name and password that can be used to access the service
specified in the request.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a new IAM user for your AWS account.
|
CreateVirtualMFADeviceResult |
createVirtualMFADevice(CreateVirtualMFADeviceRequest request)
Creates a new virtual MFA device for the AWS account.
|
DeactivateMFADeviceResult |
deactivateMFADevice(DeactivateMFADeviceRequest request)
Deactivates the specified MFA device and removes it from association with the user name for which it was
originally enabled.
|
DeleteAccessKeyResult |
deleteAccessKey(DeleteAccessKeyRequest request)
Deletes the access key pair associated with the specified IAM user.
|
DeleteAccountAliasResult |
deleteAccountAlias(DeleteAccountAliasRequest request)
Deletes the specified AWS account alias.
|
DeleteAccountPasswordPolicyResult |
deleteAccountPasswordPolicy()
Simplified method form for invoking the DeleteAccountPasswordPolicy operation.
|
DeleteAccountPasswordPolicyResult |
deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest request)
Deletes the password policy for the AWS account.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes the specified IAM group.
|
DeleteGroupPolicyResult |
deleteGroupPolicy(DeleteGroupPolicyRequest request)
Deletes the specified inline policy that is embedded in the specified IAM group.
|
DeleteInstanceProfileResult |
deleteInstanceProfile(DeleteInstanceProfileRequest request)
Deletes the specified instance profile.
|
DeleteLoginProfileResult |
deleteLoginProfile(DeleteLoginProfileRequest request)
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services
through the AWS Management Console.
|
DeleteOpenIDConnectProviderResult |
deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest request)
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Deletes the specified managed policy.
|
DeletePolicyVersionResult |
deletePolicyVersion(DeletePolicyVersionRequest request)
Deletes the specified version from the specified managed policy.
|
DeleteRoleResult |
deleteRole(DeleteRoleRequest request)
Deletes the specified role.
|
DeleteRolePolicyResult |
deleteRolePolicy(DeleteRolePolicyRequest request)
Deletes the specified inline policy that is embedded in the specified IAM role.
|
DeleteSAMLProviderResult |
deleteSAMLProvider(DeleteSAMLProviderRequest request)
Deletes a SAML provider resource in IAM.
|
DeleteServerCertificateResult |
deleteServerCertificate(DeleteServerCertificateRequest request)
Deletes the specified server certificate.
|
DeleteServiceLinkedRoleResult |
deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest request)
Submits a service-linked role deletion request and returns a
DeletionTaskId , which you can use to
check the status of the deletion. |
DeleteServiceSpecificCredentialResult |
deleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest request)
Deletes the specified service-specific credential.
|
DeleteSigningCertificateResult |
deleteSigningCertificate(DeleteSigningCertificateRequest request)
Deletes a signing certificate associated with the specified IAM user.
|
DeleteSSHPublicKeyResult |
deleteSSHPublicKey(DeleteSSHPublicKeyRequest request)
Deletes the specified SSH public key.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes the specified IAM user.
|
DeleteUserPolicyResult |
deleteUserPolicy(DeleteUserPolicyRequest request)
Deletes the specified inline policy that is embedded in the specified IAM user.
|
DeleteVirtualMFADeviceResult |
deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest request)
Deletes a virtual MFA device.
|
DetachGroupPolicyResult |
detachGroupPolicy(DetachGroupPolicyRequest request)
Removes the specified managed policy from the specified IAM group.
|
DetachRolePolicyResult |
detachRolePolicy(DetachRolePolicyRequest request)
Removes the specified managed policy from the specified role.
|
DetachUserPolicyResult |
detachUserPolicy(DetachUserPolicyRequest request)
Removes the specified managed policy from the specified user.
|
EnableMFADeviceResult |
enableMFADevice(EnableMFADeviceRequest request)
Enables the specified MFA device and associates it with the specified IAM user.
|
GenerateCredentialReportResult |
generateCredentialReport()
Simplified method form for invoking the GenerateCredentialReport operation.
|
GenerateCredentialReportResult |
generateCredentialReport(GenerateCredentialReportRequest request)
Generates a credential report for the AWS account.
|
GetAccessKeyLastUsedResult |
getAccessKeyLastUsed(GetAccessKeyLastUsedRequest request)
Retrieves information about when the specified access key was last used.
|
GetAccountAuthorizationDetailsResult |
getAccountAuthorizationDetails()
Simplified method form for invoking the GetAccountAuthorizationDetails operation.
|
GetAccountAuthorizationDetailsResult |
getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest request)
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their
relationships to one another.
|
GetAccountPasswordPolicyResult |
getAccountPasswordPolicy()
Simplified method form for invoking the GetAccountPasswordPolicy operation.
|
GetAccountPasswordPolicyResult |
getAccountPasswordPolicy(GetAccountPasswordPolicyRequest request)
Retrieves the password policy for the AWS account.
|
GetAccountSummaryResult |
getAccountSummary()
Simplified method form for invoking the GetAccountSummary operation.
|
GetAccountSummaryResult |
getAccountSummary(GetAccountSummaryRequest request)
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContextKeysForCustomPolicyResult |
getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest request)
Gets a list of all of the context keys referenced in the input policies.
|
GetContextKeysForPrincipalPolicyResult |
getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest request)
Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM
entity.
|
GetCredentialReportResult |
getCredentialReport()
Simplified method form for invoking the GetCredentialReport operation.
|
GetCredentialReportResult |
getCredentialReport(GetCredentialReportRequest request)
Retrieves a credential report for the AWS account.
|
GetGroupResult |
getGroup(GetGroupRequest request)
Returns a list of IAM users that are in the specified IAM group.
|
GetGroupPolicyResult |
getGroupPolicy(GetGroupPolicyRequest request)
Retrieves the specified inline policy document that is embedded in the specified IAM group.
|
GetInstanceProfileResult |
getInstanceProfile(GetInstanceProfileRequest request)
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and
role.
|
GetLoginProfileResult |
getLoginProfile(GetLoginProfileRequest request)
Retrieves the user name and password-creation date for the specified IAM user.
|
GetOpenIDConnectProviderResult |
getOpenIDConnectProvider(GetOpenIDConnectProviderRequest request)
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
|
GetPolicyResult |
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.
|
GetPolicyVersionResult |
getPolicyVersion(GetPolicyVersionRequest request)
Retrieves information about the specified version of the specified managed policy, including the policy document.
|
GetRoleResult |
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.
|
GetRolePolicyResult |
getRolePolicy(GetRolePolicyRequest request)
Retrieves the specified inline policy document that is embedded with the specified IAM role.
|
GetSAMLProviderResult |
getSAMLProvider(GetSAMLProviderRequest request)
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created
or updated.
|
GetServerCertificateResult |
getServerCertificate(GetServerCertificateRequest request)
Retrieves information about the specified server certificate stored in IAM.
|
GetServiceLinkedRoleDeletionStatusResult |
getServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest request)
Retrieves the status of your service-linked role deletion.
|
GetSSHPublicKeyResult |
getSSHPublicKey(GetSSHPublicKeyRequest request)
Retrieves the specified SSH public key, including metadata about the key.
|
GetUserResult |
getUser()
Simplified method form for invoking the GetUser operation.
|
GetUserResult |
getUser(GetUserRequest request)
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
|
GetUserPolicyResult |
getUserPolicy(GetUserPolicyRequest request)
Retrieves the specified inline policy document that is embedded in the specified IAM user.
|
ListAccessKeysResult |
listAccessKeys()
Simplified method form for invoking the ListAccessKeys operation.
|
ListAccessKeysResult |
listAccessKeys(ListAccessKeysRequest request)
Returns information about the access key IDs associated with the specified IAM user.
|
ListAccountAliasesResult |
listAccountAliases()
Simplified method form for invoking the ListAccountAliases operation.
|
ListAccountAliasesResult |
listAccountAliases(ListAccountAliasesRequest request)
Lists the account alias associated with the AWS account (Note: you can have only one).
|
ListAttachedGroupPoliciesResult |
listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest request)
Lists all managed policies that are attached to the specified IAM group.
|
ListAttachedRolePoliciesResult |
listAttachedRolePolicies(ListAttachedRolePoliciesRequest request)
Lists all managed policies that are attached to the specified IAM role.
|
ListAttachedUserPoliciesResult |
listAttachedUserPolicies(ListAttachedUserPoliciesRequest request)
Lists all managed policies that are attached to the specified IAM user.
|
ListEntitiesForPolicyResult |
listEntitiesForPolicy(ListEntitiesForPolicyRequest request)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
|
ListGroupPoliciesResult |
listGroupPolicies(ListGroupPoliciesRequest request)
Lists the names of the inline policies that are embedded in the specified IAM group.
|
ListGroupsResult |
listGroups()
Simplified method form for invoking the ListGroups operation.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Lists the IAM groups that have the specified path prefix.
|
ListGroupsForUserResult |
listGroupsForUser(ListGroupsForUserRequest request)
Lists the IAM groups that the specified IAM user belongs to.
|
ListInstanceProfilesResult |
listInstanceProfiles()
Simplified method form for invoking the ListInstanceProfiles operation.
|
ListInstanceProfilesResult |
listInstanceProfiles(ListInstanceProfilesRequest request)
Lists the instance profiles that have the specified path prefix.
|
ListInstanceProfilesForRoleResult |
listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest request)
Lists the instance profiles that have the specified associated IAM role.
|
ListMFADevicesResult |
listMFADevices()
Simplified method form for invoking the ListMFADevices operation.
|
ListMFADevicesResult |
listMFADevices(ListMFADevicesRequest request)
Lists the MFA devices for an IAM user.
|
ListOpenIDConnectProvidersResult |
listOpenIDConnectProviders()
Simplified method form for invoking the ListOpenIDConnectProviders operation.
|
ListOpenIDConnectProvidersResult |
listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest request)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
|
ListPoliciesResult |
listPolicies()
Simplified method form for invoking the ListPolicies operation.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest 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.
|
ListPolicyVersionsResult |
listPolicyVersions(ListPolicyVersionsRequest request)
Lists information about the versions of the specified managed policy, including the version that is currently set
as the policy's default version.
|
ListRolePoliciesResult |
listRolePolicies(ListRolePoliciesRequest request)
Lists the names of the inline policies that are embedded in the specified IAM role.
|
ListRolesResult |
listRoles()
Simplified method form for invoking the ListRoles operation.
|
ListRolesResult |
listRoles(ListRolesRequest request)
Lists the IAM roles that have the specified path prefix.
|
ListSAMLProvidersResult |
listSAMLProviders()
Simplified method form for invoking the ListSAMLProviders operation.
|
ListSAMLProvidersResult |
listSAMLProviders(ListSAMLProvidersRequest request)
Lists the SAML provider resource objects defined in IAM in the account.
|
ListServerCertificatesResult |
listServerCertificates()
Simplified method form for invoking the ListServerCertificates operation.
|
ListServerCertificatesResult |
listServerCertificates(ListServerCertificatesRequest request)
Lists the server certificates stored in IAM that have the specified path prefix.
|
ListServiceSpecificCredentialsResult |
listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest request)
Returns information about the service-specific credentials associated with the specified IAM user.
|
ListSigningCertificatesResult |
listSigningCertificates()
Simplified method form for invoking the ListSigningCertificates operation.
|
ListSigningCertificatesResult |
listSigningCertificates(ListSigningCertificatesRequest request)
Returns information about the signing certificates associated with the specified IAM user.
|
ListSSHPublicKeysResult |
listSSHPublicKeys()
Simplified method form for invoking the ListSSHPublicKeys operation.
|
ListSSHPublicKeysResult |
listSSHPublicKeys(ListSSHPublicKeysRequest request)
Returns information about the SSH public keys associated with the specified IAM user.
|
ListUserPoliciesResult |
listUserPolicies(ListUserPoliciesRequest request)
Lists the names of the inline policies embedded in the specified IAM user.
|
ListUsersResult |
listUsers()
Simplified method form for invoking the ListUsers operation.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Lists the IAM users that have the specified path prefix.
|
ListVirtualMFADevicesResult |
listVirtualMFADevices()
Simplified method form for invoking the ListVirtualMFADevices operation.
|
ListVirtualMFADevicesResult |
listVirtualMFADevices(ListVirtualMFADevicesRequest request)
Lists the virtual MFA devices defined in the AWS account by assignment status.
|
PutGroupPolicyResult |
putGroupPolicy(PutGroupPolicyRequest request)
Adds or updates an inline policy document that is embedded in the specified IAM group.
|
PutRolePolicyResult |
putRolePolicy(PutRolePolicyRequest request)
Adds or updates an inline policy document that is embedded in the specified IAM role.
|
PutUserPolicyResult |
putUserPolicy(PutUserPolicyRequest request)
Adds or updates an inline policy document that is embedded in the specified IAM user.
|
RemoveClientIDFromOpenIDConnectProviderResult |
removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest request)
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified
IAM OpenID Connect (OIDC) provider resource object.
|
RemoveRoleFromInstanceProfileResult |
removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest request)
Removes the specified IAM role from the specified EC2 instance profile.
|
RemoveUserFromGroupResult |
removeUserFromGroup(RemoveUserFromGroupRequest request)
Removes the specified user from the specified group.
|
ResetServiceSpecificCredentialResult |
resetServiceSpecificCredential(ResetServiceSpecificCredentialRequest request)
Resets the password for a service-specific credential.
|
ResyncMFADeviceResult |
resyncMFADevice(ResyncMFADeviceRequest request)
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
|
SetDefaultPolicyVersionResult |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)
Sets the specified version of the specified policy as the policy's default (operative) version.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("iam.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonIdentityManagement.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.
|
SimulateCustomPolicyResult |
simulateCustomPolicy(SimulateCustomPolicyRequest request)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and
AWS resources to determine the policies' effective permissions.
|
SimulatePrincipalPolicyResult |
simulatePrincipalPolicy(SimulatePrincipalPolicyRequest request)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources
to determine the policies' effective permissions.
|
UpdateAccessKeyResult |
updateAccessKey(UpdateAccessKeyRequest request)
Changes the status of the specified access key from Active to Inactive, or vice versa.
|
UpdateAccountPasswordPolicyResult |
updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest request)
Updates the password policy settings for the AWS account.
|
UpdateAssumeRolePolicyResult |
updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest request)
Updates the policy that grants an IAM entity permission to assume a role.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Updates the name and/or the path of the specified IAM group.
|
UpdateLoginProfileResult |
updateLoginProfile(UpdateLoginProfileRequest request)
Changes the password for the specified IAM user.
|
UpdateOpenIDConnectProviderThumbprintResult |
updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest request)
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider
resource object with a new list of thumbprints.
|
UpdateRoleDescriptionResult |
updateRoleDescription(UpdateRoleDescriptionRequest request)
Modifies the description of a role.
|
UpdateSAMLProviderResult |
updateSAMLProvider(UpdateSAMLProviderRequest request)
Updates the metadata document for an existing SAML provider resource object.
|
UpdateServerCertificateResult |
updateServerCertificate(UpdateServerCertificateRequest request)
Updates the name and/or the path of the specified server certificate stored in IAM.
|
UpdateServiceSpecificCredentialResult |
updateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest request)
Sets the status of a service-specific credential to
Active or Inactive . |
UpdateSigningCertificateResult |
updateSigningCertificate(UpdateSigningCertificateRequest request)
Changes the status of the specified user signing certificate from active to disabled, or vice versa.
|
UpdateSSHPublicKeyResult |
updateSSHPublicKey(UpdateSSHPublicKeyRequest request)
Sets the status of an IAM user's SSH public key to active or inactive.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates the name and/or the path of the specified IAM user.
|
UploadServerCertificateResult |
uploadServerCertificate(UploadServerCertificateRequest request)
Uploads a server certificate entity for the AWS account.
|
UploadSigningCertificateResult |
uploadSigningCertificate(UploadSigningCertificateRequest request)
Uploads an X.509 signing certificate and associates it with the specified IAM user.
|
UploadSSHPublicKeyResult |
uploadSSHPublicKey(UploadSSHPublicKeyRequest request)
Uploads an SSH public key and associates it with the specified IAM user.
|
AmazonIdentityManagementWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonIdentityManagement
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.
setEndpoint
in interface AmazonIdentityManagement
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.public void setRegion(Region region)
AmazonIdentityManagement
AmazonIdentityManagement.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.
setRegion
in interface AmazonIdentityManagement
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddClientIDToOpenIDConnectProviderResult addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest request)
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.
addClientIDToOpenIDConnectProvider
in interface AmazonIdentityManagement
public AddRoleToInstanceProfileResult addRoleToInstanceProfile(AddRoleToInstanceProfileRequest request)
AmazonIdentityManagement
Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased.
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.
addRoleToInstanceProfile
in interface AmazonIdentityManagement
public AddUserToGroupResult addUserToGroup(AddUserToGroupRequest request)
AmazonIdentityManagement
Adds the specified user to the specified group.
addUserToGroup
in interface AmazonIdentityManagement
public AttachGroupPolicyResult attachGroupPolicy(AttachGroupPolicyRequest request)
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.
attachGroupPolicy
in interface AmazonIdentityManagement
public AttachRolePolicyResult attachRolePolicy(AttachRolePolicyRequest request)
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.
attachRolePolicy
in interface AmazonIdentityManagement
public AttachUserPolicyResult attachUserPolicy(AttachUserPolicyRequest request)
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.
attachUserPolicy
in interface AmazonIdentityManagement
public ChangePasswordResult changePassword(ChangePasswordRequest request)
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.
changePassword
in interface AmazonIdentityManagement
public CreateAccessKeyResult createAccessKey(CreateAccessKeyRequest request)
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.
createAccessKey
in interface AmazonIdentityManagement
public CreateAccessKeyResult createAccessKey()
AmazonIdentityManagement
createAccessKey
in interface AmazonIdentityManagement
AmazonIdentityManagement.createAccessKey(CreateAccessKeyRequest)
public CreateAccountAliasResult createAccountAlias(CreateAccountAliasRequest request)
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.
createAccountAlias
in interface AmazonIdentityManagement
public CreateGroupResult createGroup(CreateGroupRequest request)
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.
createGroup
in interface AmazonIdentityManagement
public CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest request)
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.
createInstanceProfile
in interface AmazonIdentityManagement
public CreateLoginProfileResult createLoginProfile(CreateLoginProfileRequest request)
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.
createLoginProfile
in interface AmazonIdentityManagement
public CreateOpenIDConnectProviderResult createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest request)
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.
createOpenIDConnectProvider
in interface AmazonIdentityManagement
public CreatePolicyResult createPolicy(CreatePolicyRequest request)
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.
createPolicy
in interface AmazonIdentityManagement
public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)
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.
createPolicyVersion
in interface AmazonIdentityManagement
public CreateRoleResult createRole(CreateRoleRequest request)
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.
createRole
in interface AmazonIdentityManagement
public CreateSAMLProviderResult createSAMLProvider(CreateSAMLProviderRequest request)
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.
createSAMLProvider
in interface AmazonIdentityManagement
public CreateServiceLinkedRoleResult createServiceLinkedRole(CreateServiceLinkedRoleRequest request)
AmazonIdentityManagement
Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed.
The name of the role is autogenerated by combining the string that you specify for the
AWSServiceName
parameter with the string that you specify for the CustomSuffix
parameter. The resulting name must be unique in your account or the request fails.
To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role.
createServiceLinkedRole
in interface AmazonIdentityManagement
public CreateServiceSpecificCredentialResult createServiceSpecificCredential(CreateServiceSpecificCredentialRequest request)
AmazonIdentityManagement
Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.
You can have a maximum of two sets of service-specific credentials for each supported service per user.
The only supported service at this time is AWS CodeCommit.
You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide.
createServiceSpecificCredential
in interface AmazonIdentityManagement
public CreateUserResult createUser(CreateUserRequest request)
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.
createUser
in interface AmazonIdentityManagement
public CreateVirtualMFADeviceResult createVirtualMFADevice(CreateVirtualMFADeviceRequest request)
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.
createVirtualMFADevice
in interface AmazonIdentityManagement
public DeactivateMFADeviceResult deactivateMFADevice(DeactivateMFADeviceRequest request)
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.
deactivateMFADevice
in interface AmazonIdentityManagement
public DeleteAccessKeyResult deleteAccessKey(DeleteAccessKeyRequest request)
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.
deleteAccessKey
in interface AmazonIdentityManagement
public DeleteAccountAliasResult deleteAccountAlias(DeleteAccountAliasRequest request)
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.
deleteAccountAlias
in interface AmazonIdentityManagement
public DeleteAccountPasswordPolicyResult deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest request)
AmazonIdentityManagement
Deletes the password policy for the AWS account. There are no parameters.
deleteAccountPasswordPolicy
in interface AmazonIdentityManagement
public DeleteAccountPasswordPolicyResult deleteAccountPasswordPolicy()
AmazonIdentityManagement
deleteAccountPasswordPolicy
in interface AmazonIdentityManagement
AmazonIdentityManagement.deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest)
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AmazonIdentityManagement
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
deleteGroup
in interface AmazonIdentityManagement
public DeleteGroupPolicyResult deleteGroupPolicy(DeleteGroupPolicyRequest request)
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.
deleteGroupPolicy
in interface AmazonIdentityManagement
public DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest request)
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.
deleteInstanceProfile
in interface AmazonIdentityManagement
public DeleteLoginProfileResult deleteLoginProfile(DeleteLoginProfileRequest request)
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.
deleteLoginProfile
in interface AmazonIdentityManagement
public DeleteOpenIDConnectProviderResult deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest request)
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.
deleteOpenIDConnectProvider
in interface AmazonIdentityManagement
public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
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.
deletePolicy
in interface AmazonIdentityManagement
public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)
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.
deletePolicyVersion
in interface AmazonIdentityManagement
public DeleteRoleResult deleteRole(DeleteRoleRequest request)
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.
deleteRole
in interface AmazonIdentityManagement
public DeleteRolePolicyResult deleteRolePolicy(DeleteRolePolicyRequest request)
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.
deleteRolePolicy
in interface AmazonIdentityManagement
public DeleteSAMLProviderResult deleteSAMLProvider(DeleteSAMLProviderRequest request)
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.
deleteSAMLProvider
in interface AmazonIdentityManagement
public DeleteSSHPublicKeyResult deleteSSHPublicKey(DeleteSSHPublicKeyRequest request)
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.
deleteSSHPublicKey
in interface AmazonIdentityManagement
public DeleteServerCertificateResult deleteServerCertificate(DeleteServerCertificateRequest request)
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.
deleteServerCertificate
in interface AmazonIdentityManagement
public DeleteServiceLinkedRoleResult deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest request)
AmazonIdentityManagement
Submits a service-linked role deletion request and returns a DeletionTaskId
, which you can use to
check the status of the deletion. Before you call this operation, confirm that the role has no active sessions
and that any resources used by the role in the linked service are deleted. If you call this operation more than
once for the same service-linked role and an earlier deletion task is not complete, then the
DeletionTaskId
of the earlier request is returned.
If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus API operation returns the reason for the failure, including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service.
For more information about service-linked roles, see Roles Terms and Concepts: AWS Service-Linked Role in the IAM User Guide.
deleteServiceLinkedRole
in interface AmazonIdentityManagement
public DeleteServiceSpecificCredentialResult deleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest request)
AmazonIdentityManagement
Deletes the specified service-specific credential.
deleteServiceSpecificCredential
in interface AmazonIdentityManagement
public DeleteSigningCertificateResult deleteSigningCertificate(DeleteSigningCertificateRequest request)
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.
deleteSigningCertificate
in interface AmazonIdentityManagement
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonIdentityManagement
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
deleteUser
in interface AmazonIdentityManagement
public DeleteUserPolicyResult deleteUserPolicy(DeleteUserPolicyRequest request)
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.
deleteUserPolicy
in interface AmazonIdentityManagement
public DeleteVirtualMFADeviceResult deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest request)
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.
deleteVirtualMFADevice
in interface AmazonIdentityManagement
public DetachGroupPolicyResult detachGroupPolicy(DetachGroupPolicyRequest request)
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.
detachGroupPolicy
in interface AmazonIdentityManagement
public DetachRolePolicyResult detachRolePolicy(DetachRolePolicyRequest request)
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.
detachRolePolicy
in interface AmazonIdentityManagement
public DetachUserPolicyResult detachUserPolicy(DetachUserPolicyRequest request)
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.
detachUserPolicy
in interface AmazonIdentityManagement
public EnableMFADeviceResult enableMFADevice(EnableMFADeviceRequest request)
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.
enableMFADevice
in interface AmazonIdentityManagement
public GenerateCredentialReportResult generateCredentialReport(GenerateCredentialReportRequest request)
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.
generateCredentialReport
in interface AmazonIdentityManagement
public GenerateCredentialReportResult generateCredentialReport()
AmazonIdentityManagement
generateCredentialReport
in interface AmazonIdentityManagement
AmazonIdentityManagement.generateCredentialReport(GenerateCredentialReportRequest)
public GetAccessKeyLastUsedResult getAccessKeyLastUsed(GetAccessKeyLastUsedRequest request)
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.
getAccessKeyLastUsed
in interface AmazonIdentityManagement
public GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest request)
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
the MaxItems
and Marker
parameters.
getAccountAuthorizationDetails
in interface AmazonIdentityManagement
public GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails()
AmazonIdentityManagement
getAccountAuthorizationDetails
in interface AmazonIdentityManagement
AmazonIdentityManagement.getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest)
public GetAccountPasswordPolicyResult getAccountPasswordPolicy(GetAccountPasswordPolicyRequest request)
AmazonIdentityManagement
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
getAccountPasswordPolicy
in interface AmazonIdentityManagement
public GetAccountPasswordPolicyResult getAccountPasswordPolicy()
AmazonIdentityManagement
getAccountPasswordPolicy
in interface AmazonIdentityManagement
AmazonIdentityManagement.getAccountPasswordPolicy(GetAccountPasswordPolicyRequest)
public GetAccountSummaryResult getAccountSummary(GetAccountSummaryRequest request)
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.
getAccountSummary
in interface AmazonIdentityManagement
public GetAccountSummaryResult getAccountSummary()
AmazonIdentityManagement
getAccountSummary
in interface AmazonIdentityManagement
AmazonIdentityManagement.getAccountSummary(GetAccountSummaryRequest)
public GetContextKeysForCustomPolicyResult getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest request)
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.
getContextKeysForCustomPolicy
in interface AmazonIdentityManagement
public GetContextKeysForPrincipalPolicyResult getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest request)
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.
getContextKeysForPrincipalPolicy
in interface AmazonIdentityManagement
public GetCredentialReportResult getCredentialReport(GetCredentialReportRequest request)
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.
getCredentialReport
in interface AmazonIdentityManagement
public GetCredentialReportResult getCredentialReport()
AmazonIdentityManagement
getCredentialReport
in interface AmazonIdentityManagement
AmazonIdentityManagement.getCredentialReport(GetCredentialReportRequest)
public GetGroupResult getGroup(GetGroupRequest request)
AmazonIdentityManagement
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
and Marker
parameters.
getGroup
in interface AmazonIdentityManagement
public GetGroupPolicyResult getGroupPolicy(GetGroupPolicyRequest request)
AmazonIdentityManagement
Retrieves the specified inline policy document that is embedded in the specified IAM group.
Policies returned by this API are URL-encoded compliant with RFC
3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you
use Java, you can use the decode
method of the java.net.URLDecoder
utility class in the
Java SDK. Other languages and SDKs provide similar functionality.
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.
getGroupPolicy
in interface AmazonIdentityManagement
public GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest request)
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.
getInstanceProfile
in interface AmazonIdentityManagement
public GetLoginProfileResult getLoginProfile(GetLoginProfileRequest request)
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.
getLoginProfile
in interface AmazonIdentityManagement
public GetOpenIDConnectProviderResult getOpenIDConnectProvider(GetOpenIDConnectProviderRequest request)
AmazonIdentityManagement
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
getOpenIDConnectProvider
in interface AmazonIdentityManagement
public GetPolicyResult getPolicy(GetPolicyRequest request)
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.
getPolicy
in interface AmazonIdentityManagement
public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest request)
AmazonIdentityManagement
Retrieves information about the specified version of the specified managed policy, including the policy document.
Policies returned by this API are URL-encoded compliant with RFC
3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you
use Java, you can use the decode
method of the java.net.URLDecoder
utility class in the
Java SDK. Other languages and SDKs provide similar functionality.
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.
getPolicyVersion
in interface AmazonIdentityManagement
public GetRoleResult getRole(GetRoleRequest request)
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.
Policies returned by this API are URL-encoded compliant with RFC
3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you
use Java, you can use the decode
method of the java.net.URLDecoder
utility class in the
Java SDK. Other languages and SDKs provide similar functionality.
getRole
in interface AmazonIdentityManagement
public GetRolePolicyResult getRolePolicy(GetRolePolicyRequest request)
AmazonIdentityManagement
Retrieves the specified inline policy document that is embedded with the specified IAM role.
Policies returned by this API are URL-encoded compliant with RFC
3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you
use Java, you can use the decode
method of the java.net.URLDecoder
utility class in the
Java SDK. Other languages and SDKs provide similar functionality.
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.
getRolePolicy
in interface AmazonIdentityManagement
public GetSAMLProviderResult getSAMLProvider(GetSAMLProviderRequest request)
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.
getSAMLProvider
in interface AmazonIdentityManagement
public GetSSHPublicKeyResult getSSHPublicKey(GetSSHPublicKeyRequest request)
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.
getSSHPublicKey
in interface AmazonIdentityManagement
public GetServerCertificateResult getServerCertificate(GetServerCertificateRequest request)
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.
getServerCertificate
in interface AmazonIdentityManagement
public GetServiceLinkedRoleDeletionStatusResult getServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest request)
AmazonIdentityManagement
Retrieves the status of your service-linked role deletion. After you use the DeleteServiceLinkedRole API
operation to submit a service-linked role for deletion, you can use the DeletionTaskId
parameter in
GetServiceLinkedRoleDeletionStatus
to check the status of the deletion. If the deletion fails, this
operation returns the reason that it failed.
getServiceLinkedRoleDeletionStatus
in interface AmazonIdentityManagement
public GetUserResult getUser(GetUserRequest request)
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.
getUser
in interface AmazonIdentityManagement
public GetUserResult getUser()
AmazonIdentityManagement
getUser
in interface AmazonIdentityManagement
AmazonIdentityManagement.getUser(GetUserRequest)
public GetUserPolicyResult getUserPolicy(GetUserPolicyRequest request)
AmazonIdentityManagement
Retrieves the specified inline policy document that is embedded in the specified IAM user.
Policies returned by this API are URL-encoded compliant with RFC
3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you
use Java, you can use the decode
method of the java.net.URLDecoder
utility class in the
Java SDK. Other languages and SDKs provide similar functionality.
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.
getUserPolicy
in interface AmazonIdentityManagement
public ListAccessKeysResult listAccessKeys(ListAccessKeysRequest request)
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
and Marker
parameters.
If the UserName
field is not specified, the UserName is determined implicitly based on the AWS
access key ID used to sign the request. Because this action works for access keys under the AWS account, you can
use this action to manage root credentials even if the AWS account has no associated users.
To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.
listAccessKeys
in interface AmazonIdentityManagement
public ListAccessKeysResult listAccessKeys()
AmazonIdentityManagement
listAccessKeys
in interface AmazonIdentityManagement
AmazonIdentityManagement.listAccessKeys(ListAccessKeysRequest)
public ListAccountAliasesResult listAccountAliases(ListAccountAliasesRequest request)
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.
listAccountAliases
in interface AmazonIdentityManagement
public ListAccountAliasesResult listAccountAliases()
AmazonIdentityManagement
listAccountAliases
in interface AmazonIdentityManagement
AmazonIdentityManagement.listAccountAliases(ListAccountAliasesRequest)
public ListAttachedGroupPoliciesResult listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest request)
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
and Marker
parameters. You can use the
PathPrefix
parameter to limit the list of policies to only those matching the specified path prefix.
If there are no policies attached to the specified group (or none that match the specified path prefix), the
action returns an empty list.
listAttachedGroupPolicies
in interface AmazonIdentityManagement
public ListAttachedRolePoliciesResult listAttachedRolePolicies(ListAttachedRolePoliciesRequest request)
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
and Marker
parameters. You can use the
PathPrefix
parameter to limit the list of policies to only those matching the specified path prefix.
If there are no policies attached to the specified role (or none that match the specified path prefix), the
action returns an empty list.
listAttachedRolePolicies
in interface AmazonIdentityManagement
public ListAttachedUserPoliciesResult listAttachedUserPolicies(ListAttachedUserPoliciesRequest request)
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
and Marker
parameters. You can use the
PathPrefix
parameter to limit the list of policies to only those matching the specified path prefix.
If there are no policies attached to the specified group (or none that match the specified path prefix), the
action returns an empty list.
listAttachedUserPolicies
in interface AmazonIdentityManagement
public ListEntitiesForPolicyResult listEntitiesForPolicy(ListEntitiesForPolicyRequest request)
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, set
EntityFilter
to Role
.
You can paginate the results using the MaxItems
and Marker
parameters.
listEntitiesForPolicy
in interface AmazonIdentityManagement
public ListGroupPoliciesResult listGroupPolicies(ListGroupPoliciesRequest request)
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
and Marker
parameters. If there are no
inline policies embedded with the specified group, the action returns an empty list.
listGroupPolicies
in interface AmazonIdentityManagement
public ListGroupsResult listGroups(ListGroupsRequest request)
AmazonIdentityManagement
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
listGroups
in interface AmazonIdentityManagement
public ListGroupsResult listGroups()
AmazonIdentityManagement
listGroups
in interface AmazonIdentityManagement
AmazonIdentityManagement.listGroups(ListGroupsRequest)
public ListGroupsForUserResult listGroupsForUser(ListGroupsForUserRequest request)
AmazonIdentityManagement
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
listGroupsForUser
in interface AmazonIdentityManagement
public ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest request)
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
and Marker
parameters.
listInstanceProfiles
in interface AmazonIdentityManagement
public ListInstanceProfilesResult listInstanceProfiles()
AmazonIdentityManagement
listInstanceProfiles
in interface AmazonIdentityManagement
AmazonIdentityManagement.listInstanceProfiles(ListInstanceProfilesRequest)
public ListInstanceProfilesForRoleResult listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest request)
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
and Marker
parameters.
listInstanceProfilesForRole
in interface AmazonIdentityManagement
public ListMFADevicesResult listMFADevices(ListMFADevicesRequest request)
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
and Marker
parameters.
listMFADevices
in interface AmazonIdentityManagement
public ListMFADevicesResult listMFADevices()
AmazonIdentityManagement
listMFADevices
in interface AmazonIdentityManagement
AmazonIdentityManagement.listMFADevices(ListMFADevicesRequest)
public ListOpenIDConnectProvidersResult listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest request)
AmazonIdentityManagement
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
listOpenIDConnectProviders
in interface AmazonIdentityManagement
public ListOpenIDConnectProvidersResult listOpenIDConnectProviders()
AmazonIdentityManagement
listOpenIDConnectProviders
in interface AmazonIdentityManagement
AmazonIdentityManagement.listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest)
public ListPoliciesResult listPolicies(ListPoliciesRequest request)
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
, and PathPrefix
parameters. For example, to list only the customer managed
policies in your AWS account, set Scope
to Local
. To list only AWS managed policies,
set Scope
to AWS
.
You can paginate the results using the MaxItems
and Marker
parameters.
For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
listPolicies
in interface AmazonIdentityManagement
public ListPoliciesResult listPolicies()
AmazonIdentityManagement
listPolicies
in interface AmazonIdentityManagement
AmazonIdentityManagement.listPolicies(ListPoliciesRequest)
public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest request)
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.
listPolicyVersions
in interface AmazonIdentityManagement
public ListRolePoliciesResult listRolePolicies(ListRolePoliciesRequest request)
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
and Marker
parameters. If there are no
inline policies embedded with the specified role, the action returns an empty list.
listRolePolicies
in interface AmazonIdentityManagement
public ListRolesResult listRoles(ListRolesRequest request)
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
and Marker
parameters.
listRoles
in interface AmazonIdentityManagement
public ListRolesResult listRoles()
AmazonIdentityManagement
listRoles
in interface AmazonIdentityManagement
AmazonIdentityManagement.listRoles(ListRolesRequest)
public ListSAMLProvidersResult listSAMLProviders(ListSAMLProvidersRequest request)
AmazonIdentityManagement
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
listSAMLProviders
in interface AmazonIdentityManagement
public ListSAMLProvidersResult listSAMLProviders()
AmazonIdentityManagement
listSAMLProviders
in interface AmazonIdentityManagement
AmazonIdentityManagement.listSAMLProviders(ListSAMLProvidersRequest)
public ListSSHPublicKeysResult listSSHPublicKeys(ListSSHPublicKeysRequest request)
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
and Marker
parameters.
listSSHPublicKeys
in interface AmazonIdentityManagement
public ListSSHPublicKeysResult listSSHPublicKeys()
AmazonIdentityManagement
listSSHPublicKeys
in interface AmazonIdentityManagement
AmazonIdentityManagement.listSSHPublicKeys(ListSSHPublicKeysRequest)
public ListServerCertificatesResult listServerCertificates(ListServerCertificatesRequest request)
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
and Marker
parameters.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
listServerCertificates
in interface AmazonIdentityManagement
public ListServerCertificatesResult listServerCertificates()
AmazonIdentityManagement
listServerCertificates
in interface AmazonIdentityManagement
AmazonIdentityManagement.listServerCertificates(ListServerCertificatesRequest)
public ListServiceSpecificCredentialsResult listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest request)
AmazonIdentityManagement
Returns information about the service-specific credentials associated with the specified IAM user. If there are none, the action returns an empty list. The service-specific credentials returned by this action are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide.
listServiceSpecificCredentials
in interface AmazonIdentityManagement
public ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest request)
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
and Marker
parameters.
If the UserName
field is not specified, the user name is determined implicitly based on the AWS
access key ID used to sign the request 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.
listSigningCertificates
in interface AmazonIdentityManagement
public ListSigningCertificatesResult listSigningCertificates()
AmazonIdentityManagement
listSigningCertificates
in interface AmazonIdentityManagement
AmazonIdentityManagement.listSigningCertificates(ListSigningCertificatesRequest)
public ListUserPoliciesResult listUserPolicies(ListUserPoliciesRequest request)
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
and Marker
parameters. If there are no
inline policies embedded with the specified user, the action returns an empty list.
listUserPolicies
in interface AmazonIdentityManagement
public ListUsersResult listUsers(ListUsersRequest request)
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
and Marker
parameters.
listUsers
in interface AmazonIdentityManagement
public ListUsersResult listUsers()
AmazonIdentityManagement
listUsers
in interface AmazonIdentityManagement
AmazonIdentityManagement.listUsers(ListUsersRequest)
public ListVirtualMFADevicesResult listVirtualMFADevices(ListVirtualMFADevicesRequest request)
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
, or Any
.
You can paginate the results using the MaxItems
and Marker
parameters.
listVirtualMFADevices
in interface AmazonIdentityManagement
public ListVirtualMFADevicesResult listVirtualMFADevices()
AmazonIdentityManagement
listVirtualMFADevices
in interface AmazonIdentityManagement
AmazonIdentityManagement.listVirtualMFADevices(ListVirtualMFADevicesRequest)
public PutGroupPolicyResult putGroupPolicy(PutGroupPolicyRequest request)
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.
putGroupPolicy
in interface AmazonIdentityManagement
public PutRolePolicyResult putRolePolicy(PutRolePolicyRequest request)
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.
putRolePolicy
in interface AmazonIdentityManagement
public PutUserPolicyResult putUserPolicy(PutUserPolicyRequest request)
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.
putUserPolicy
in interface AmazonIdentityManagement
public RemoveClientIDFromOpenIDConnectProviderResult removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest request)
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.
removeClientIDFromOpenIDConnectProvider
in interface AmazonIdentityManagement
public RemoveRoleFromInstanceProfileResult removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest request)
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 might 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.
removeRoleFromInstanceProfile
in interface AmazonIdentityManagement
public RemoveUserFromGroupResult removeUserFromGroup(RemoveUserFromGroupRequest request)
AmazonIdentityManagement
Removes the specified user from the specified group.
removeUserFromGroup
in interface AmazonIdentityManagement
public ResetServiceSpecificCredentialResult resetServiceSpecificCredential(ResetServiceSpecificCredentialRequest request)
AmazonIdentityManagement
Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.
resetServiceSpecificCredential
in interface AmazonIdentityManagement
public ResyncMFADeviceResult resyncMFADevice(ResyncMFADeviceRequest request)
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.
resyncMFADevice
in interface AmazonIdentityManagement
public SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)
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.
setDefaultPolicyVersion
in interface AmazonIdentityManagement
public SimulateCustomPolicyResult simulateCustomPolicy(SimulateCustomPolicyRequest request)
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
and Marker
parameters to paginate the
results.
simulateCustomPolicy
in interface AmazonIdentityManagement
public SimulatePrincipalPolicyResult simulatePrincipalPolicy(SimulatePrincipalPolicyRequest request)
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
and Marker
parameters to paginate the
results.
simulatePrincipalPolicy
in interface AmazonIdentityManagement
public UpdateAccessKeyResult updateAccessKey(UpdateAccessKeyRequest request)
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.
updateAccessKey
in interface AmazonIdentityManagement
public UpdateAccountPasswordPolicyResult updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest request)
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.
updateAccountPasswordPolicy
in interface AmazonIdentityManagement
public UpdateAssumeRolePolicyResult updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest request)
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.
updateAssumeRolePolicy
in interface AmazonIdentityManagement
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
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.
updateGroup
in interface AmazonIdentityManagement
public UpdateLoginProfileResult updateLoginProfile(UpdateLoginProfileRequest request)
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.
updateLoginProfile
in interface AmazonIdentityManagement
public UpdateOpenIDConnectProviderThumbprintResult updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest request)
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.
updateOpenIDConnectProviderThumbprint
in interface AmazonIdentityManagement
public UpdateRoleDescriptionResult updateRoleDescription(UpdateRoleDescriptionRequest request)
AmazonIdentityManagement
Modifies the description of a role.
updateRoleDescription
in interface AmazonIdentityManagement
public UpdateSAMLProviderResult updateSAMLProvider(UpdateSAMLProviderRequest request)
AmazonIdentityManagement
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
updateSAMLProvider
in interface AmazonIdentityManagement
public UpdateSSHPublicKeyResult updateSSHPublicKey(UpdateSSHPublicKeyRequest request)
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.
updateSSHPublicKey
in interface AmazonIdentityManagement
public UpdateServerCertificateResult updateServerCertificate(UpdateServerCertificateRequest request)
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.
updateServerCertificate
in interface AmazonIdentityManagement
public UpdateServiceSpecificCredentialResult updateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest request)
AmazonIdentityManagement
Sets the status of a service-specific credential to Active
or Inactive
.
Service-specific credentials that are inactive cannot be used for authentication to the service. This action can
be used to disable a user’s service-specific credential as part of a credential rotation work flow.
updateServiceSpecificCredential
in interface AmazonIdentityManagement
public UpdateSigningCertificateResult updateSigningCertificate(UpdateSigningCertificateRequest request)
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.
updateSigningCertificate
in interface AmazonIdentityManagement
public UpdateUserResult updateUser(UpdateUserRequest request)
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.
updateUser
in interface AmazonIdentityManagement
public UploadSSHPublicKeyResult uploadSSHPublicKey(UploadSSHPublicKeyRequest request)
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.
uploadSSHPublicKey
in interface AmazonIdentityManagement
public UploadServerCertificateResult uploadServerCertificate(UploadServerCertificateRequest request)
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.
We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide.
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.
uploadServerCertificate
in interface AmazonIdentityManagement
public UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest request)
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.
uploadSigningCertificate
in interface AmazonIdentityManagement
public void shutdown()
AmazonIdentityManagement
shutdown
in interface AmazonIdentityManagement
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonIdentityManagement
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.
getCachedResponseMetadata
in interface AmazonIdentityManagement
request
- The originally executed request.public AmazonIdentityManagementWaiters waiters()
waiters
in interface AmazonIdentityManagement
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.