@Generated(value="software.amazon.awssdk:codegen") public interface IAMClient extends SdkClient, SdkAutoCloseable
builder()
method.
AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
Additional Resources
For more information, see the following:
AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.
IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.
Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddClientIDToOpenIDConnectProviderResponse |
addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest addClientIDToOpenIDConnectProviderRequest)
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM
OpenID Connect (OIDC) provider resource.
|
default AddClientIDToOpenIDConnectProviderResponse |
addClientIDToOpenIDConnectProvider(Consumer<AddClientIDToOpenIDConnectProviderRequest.Builder> addClientIDToOpenIDConnectProviderRequest)
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM
OpenID Connect (OIDC) provider resource.
|
default AddRoleToInstanceProfileResponse |
addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest)
Adds the specified IAM role to the specified instance profile.
|
default AddRoleToInstanceProfileResponse |
addRoleToInstanceProfile(Consumer<AddRoleToInstanceProfileRequest.Builder> addRoleToInstanceProfileRequest)
Adds the specified IAM role to the specified instance profile.
|
default AddUserToGroupResponse |
addUserToGroup(AddUserToGroupRequest addUserToGroupRequest)
Adds the specified user to the specified group.
|
default AddUserToGroupResponse |
addUserToGroup(Consumer<AddUserToGroupRequest.Builder> addUserToGroupRequest)
Adds the specified user to the specified group.
|
default AttachGroupPolicyResponse |
attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest)
Attaches the specified managed policy to the specified IAM group.
|
default AttachGroupPolicyResponse |
attachGroupPolicy(Consumer<AttachGroupPolicyRequest.Builder> attachGroupPolicyRequest)
Attaches the specified managed policy to the specified IAM group.
|
default AttachRolePolicyResponse |
attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest)
Attaches the specified managed policy to the specified IAM role.
|
default AttachRolePolicyResponse |
attachRolePolicy(Consumer<AttachRolePolicyRequest.Builder> attachRolePolicyRequest)
Attaches the specified managed policy to the specified IAM role.
|
default AttachUserPolicyResponse |
attachUserPolicy(AttachUserPolicyRequest attachUserPolicyRequest)
Attaches the specified managed policy to the specified user.
|
default AttachUserPolicyResponse |
attachUserPolicy(Consumer<AttachUserPolicyRequest.Builder> attachUserPolicyRequest)
Attaches the specified managed policy to the specified user.
|
static IAMClientBuilder |
builder()
Create a builder that can be used to configure and create a
IAMClient . |
default ChangePasswordResponse |
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password of the IAM user who is calling this action.
|
default ChangePasswordResponse |
changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest)
Changes the password of the IAM user who is calling this action.
|
static IAMClient |
create()
Create a
IAMClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAccessKeyResponse |
createAccessKey()
Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
|
default CreateAccessKeyResponse |
createAccessKey(Consumer<CreateAccessKeyRequest.Builder> createAccessKeyRequest)
Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
|
default CreateAccessKeyResponse |
createAccessKey(CreateAccessKeyRequest createAccessKeyRequest)
Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
|
default CreateAccountAliasResponse |
createAccountAlias(Consumer<CreateAccountAliasRequest.Builder> createAccountAliasRequest)
Creates an alias for your AWS account.
|
default CreateAccountAliasResponse |
createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest)
Creates an alias for your AWS account.
|
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a new group.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group.
|
default CreateInstanceProfileResponse |
createInstanceProfile(Consumer<CreateInstanceProfileRequest.Builder> createInstanceProfileRequest)
Creates a new instance profile.
|
default CreateInstanceProfileResponse |
createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates a new instance profile.
|
default CreateLoginProfileResponse |
createLoginProfile(Consumer<CreateLoginProfileRequest.Builder> createLoginProfileRequest)
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS
Management Console.
|
default CreateLoginProfileResponse |
createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest)
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS
Management Console.
|
default CreateOpenIDConnectProviderResponse |
createOpenIDConnectProvider(Consumer<CreateOpenIDConnectProviderRequest.Builder> createOpenIDConnectProviderRequest)
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
|
default CreateOpenIDConnectProviderResponse |
createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest createOpenIDConnectProviderRequest)
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
|
default CreatePolicyResponse |
createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest)
Creates a new managed policy for your AWS account.
|
default CreatePolicyResponse |
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates a new managed policy for your AWS account.
|
default CreatePolicyVersionResponse |
createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest)
Creates a new version of the specified managed policy.
|
default CreatePolicyVersionResponse |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified managed policy.
|
default CreateRoleResponse |
createRole(Consumer<CreateRoleRequest.Builder> createRoleRequest)
Creates a new role for your AWS account.
|
default CreateRoleResponse |
createRole(CreateRoleRequest createRoleRequest)
Creates a new role for your AWS account.
|
default CreateSAMLProviderResponse |
createSAMLProvider(Consumer<CreateSAMLProviderRequest.Builder> createSAMLProviderRequest)
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
|
default CreateSAMLProviderResponse |
createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest)
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
|
default CreateServiceLinkedRoleResponse |
createServiceLinkedRole(Consumer<CreateServiceLinkedRoleRequest.Builder> createServiceLinkedRoleRequest)
Creates an IAM role that is linked to a specific AWS service.
|
default CreateServiceLinkedRoleResponse |
createServiceLinkedRole(CreateServiceLinkedRoleRequest createServiceLinkedRoleRequest)
Creates an IAM role that is linked to a specific AWS service.
|
default CreateServiceSpecificCredentialResponse |
createServiceSpecificCredential(Consumer<CreateServiceSpecificCredentialRequest.Builder> createServiceSpecificCredentialRequest)
Generates a set of credentials consisting of a user name and password that can be used to access the service
specified in the request.
|
default CreateServiceSpecificCredentialResponse |
createServiceSpecificCredential(CreateServiceSpecificCredentialRequest createServiceSpecificCredentialRequest)
Generates a set of credentials consisting of a user name and password that can be used to access the service
specified in the request.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a new IAM user for your AWS account.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a new IAM user for your AWS account.
|
default CreateVirtualMFADeviceResponse |
createVirtualMFADevice(Consumer<CreateVirtualMFADeviceRequest.Builder> createVirtualMFADeviceRequest)
Creates a new virtual MFA device for the AWS account.
|
default CreateVirtualMFADeviceResponse |
createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest)
Creates a new virtual MFA device for the AWS account.
|
default DeactivateMFADeviceResponse |
deactivateMFADevice(Consumer<DeactivateMFADeviceRequest.Builder> deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with the user name for which it was
originally enabled.
|
default DeactivateMFADeviceResponse |
deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest)
Deactivates the specified MFA device and removes it from association with the user name for which it was
originally enabled.
|
default DeleteAccessKeyResponse |
deleteAccessKey(Consumer<DeleteAccessKeyRequest.Builder> deleteAccessKeyRequest)
Deletes the access key pair associated with the specified IAM user.
|
default DeleteAccessKeyResponse |
deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest)
Deletes the access key pair associated with the specified IAM user.
|
default DeleteAccountAliasResponse |
deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest)
Deletes the specified AWS account alias.
|
default DeleteAccountAliasResponse |
deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
Deletes the specified AWS account alias.
|
default DeleteAccountPasswordPolicyResponse |
deleteAccountPasswordPolicy()
Deletes the password policy for the AWS account.
|
default DeleteAccountPasswordPolicyResponse |
deleteAccountPasswordPolicy(Consumer<DeleteAccountPasswordPolicyRequest.Builder> deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account.
|
default DeleteAccountPasswordPolicyResponse |
deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the AWS account.
|
default DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes the specified IAM group.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes the specified IAM group.
|
default DeleteGroupPolicyResponse |
deleteGroupPolicy(Consumer<DeleteGroupPolicyRequest.Builder> deleteGroupPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM group.
|
default DeleteGroupPolicyResponse |
deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM group.
|
default DeleteInstanceProfileResponse |
deleteInstanceProfile(Consumer<DeleteInstanceProfileRequest.Builder> deleteInstanceProfileRequest)
Deletes the specified instance profile.
|
default DeleteInstanceProfileResponse |
deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile.
|
default DeleteLoginProfileResponse |
deleteLoginProfile(Consumer<DeleteLoginProfileRequest.Builder> deleteLoginProfileRequest)
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services
through the AWS Management Console.
|
default DeleteLoginProfileResponse |
deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services
through the AWS Management Console.
|
default DeleteOpenIDConnectProviderResponse |
deleteOpenIDConnectProvider(Consumer<DeleteOpenIDConnectProviderRequest.Builder> deleteOpenIDConnectProviderRequest)
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
|
default DeleteOpenIDConnectProviderResponse |
deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest deleteOpenIDConnectProviderRequest)
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
|
default DeletePolicyResponse |
deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest)
Deletes the specified managed policy.
|
default DeletePolicyResponse |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified managed policy.
|
default DeletePolicyVersionResponse |
deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest)
Deletes the specified version from the specified managed policy.
|
default DeletePolicyVersionResponse |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version from the specified managed policy.
|
default DeleteRoleResponse |
deleteRole(Consumer<DeleteRoleRequest.Builder> deleteRoleRequest)
Deletes the specified role.
|
default DeleteRoleResponse |
deleteRole(DeleteRoleRequest deleteRoleRequest)
Deletes the specified role.
|
default DeleteRolePolicyResponse |
deleteRolePolicy(Consumer<DeleteRolePolicyRequest.Builder> deleteRolePolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM role.
|
default DeleteRolePolicyResponse |
deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM role.
|
default DeleteSAMLProviderResponse |
deleteSAMLProvider(Consumer<DeleteSAMLProviderRequest.Builder> deleteSAMLProviderRequest)
Deletes a SAML provider resource in IAM.
|
default DeleteSAMLProviderResponse |
deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest)
Deletes a SAML provider resource in IAM.
|
default DeleteServerCertificateResponse |
deleteServerCertificate(Consumer<DeleteServerCertificateRequest.Builder> deleteServerCertificateRequest)
Deletes the specified server certificate.
|
default DeleteServerCertificateResponse |
deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest)
Deletes the specified server certificate.
|
default DeleteServiceLinkedRoleResponse |
deleteServiceLinkedRole(Consumer<DeleteServiceLinkedRoleRequest.Builder> deleteServiceLinkedRoleRequest)
Submits a service-linked role deletion request and returns a
DeletionTaskId , which you can use to
check the status of the deletion. |
default DeleteServiceLinkedRoleResponse |
deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest deleteServiceLinkedRoleRequest)
Submits a service-linked role deletion request and returns a
DeletionTaskId , which you can use to
check the status of the deletion. |
default DeleteServiceSpecificCredentialResponse |
deleteServiceSpecificCredential(Consumer<DeleteServiceSpecificCredentialRequest.Builder> deleteServiceSpecificCredentialRequest)
Deletes the specified service-specific credential.
|
default DeleteServiceSpecificCredentialResponse |
deleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest deleteServiceSpecificCredentialRequest)
Deletes the specified service-specific credential.
|
default DeleteSigningCertificateResponse |
deleteSigningCertificate(Consumer<DeleteSigningCertificateRequest.Builder> deleteSigningCertificateRequest)
Deletes a signing certificate associated with the specified IAM user.
|
default DeleteSigningCertificateResponse |
deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest)
Deletes a signing certificate associated with the specified IAM user.
|
default DeleteSSHPublicKeyResponse |
deleteSSHPublicKey(Consumer<DeleteSSHPublicKeyRequest.Builder> deleteSSHPublicKeyRequest)
Deletes the specified SSH public key.
|
default DeleteSSHPublicKeyResponse |
deleteSSHPublicKey(DeleteSSHPublicKeyRequest deleteSSHPublicKeyRequest)
Deletes the specified SSH public key.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the specified IAM user.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified IAM user.
|
default DeleteUserPolicyResponse |
deleteUserPolicy(Consumer<DeleteUserPolicyRequest.Builder> deleteUserPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM user.
|
default DeleteUserPolicyResponse |
deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest)
Deletes the specified inline policy that is embedded in the specified IAM user.
|
default DeleteVirtualMFADeviceResponse |
deleteVirtualMFADevice(Consumer<DeleteVirtualMFADeviceRequest.Builder> deleteVirtualMFADeviceRequest)
Deletes a virtual MFA device.
|
default DeleteVirtualMFADeviceResponse |
deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest)
Deletes a virtual MFA device.
|
default DetachGroupPolicyResponse |
detachGroupPolicy(Consumer<DetachGroupPolicyRequest.Builder> detachGroupPolicyRequest)
Removes the specified managed policy from the specified IAM group.
|
default DetachGroupPolicyResponse |
detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest)
Removes the specified managed policy from the specified IAM group.
|
default DetachRolePolicyResponse |
detachRolePolicy(Consumer<DetachRolePolicyRequest.Builder> detachRolePolicyRequest)
Removes the specified managed policy from the specified role.
|
default DetachRolePolicyResponse |
detachRolePolicy(DetachRolePolicyRequest detachRolePolicyRequest)
Removes the specified managed policy from the specified role.
|
default DetachUserPolicyResponse |
detachUserPolicy(Consumer<DetachUserPolicyRequest.Builder> detachUserPolicyRequest)
Removes the specified managed policy from the specified user.
|
default DetachUserPolicyResponse |
detachUserPolicy(DetachUserPolicyRequest detachUserPolicyRequest)
Removes the specified managed policy from the specified user.
|
default EnableMFADeviceResponse |
enableMFADevice(Consumer<EnableMFADeviceRequest.Builder> enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified IAM user.
|
default EnableMFADeviceResponse |
enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest)
Enables the specified MFA device and associates it with the specified IAM user.
|
default GenerateCredentialReportResponse |
generateCredentialReport()
Generates a credential report for the AWS account.
|
default GenerateCredentialReportResponse |
generateCredentialReport(Consumer<GenerateCredentialReportRequest.Builder> generateCredentialReportRequest)
Generates a credential report for the AWS account.
|
default GenerateCredentialReportResponse |
generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest)
Generates a credential report for the AWS account.
|
default GetAccessKeyLastUsedResponse |
getAccessKeyLastUsed(Consumer<GetAccessKeyLastUsedRequest.Builder> getAccessKeyLastUsedRequest)
Retrieves information about when the specified access key was last used.
|
default GetAccessKeyLastUsedResponse |
getAccessKeyLastUsed(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest)
Retrieves information about when the specified access key was last used.
|
default GetAccountAuthorizationDetailsResponse |
getAccountAuthorizationDetails()
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their
relationships to one another.
|
default GetAccountAuthorizationDetailsResponse |
getAccountAuthorizationDetails(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their
relationships to one another.
|
default GetAccountAuthorizationDetailsResponse |
getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their
relationships to one another.
|
default GetAccountAuthorizationDetailsIterable |
getAccountAuthorizationDetailsPaginator()
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their
relationships to one another.
|
default GetAccountAuthorizationDetailsIterable |
getAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their
relationships to one another.
|
default GetAccountPasswordPolicyResponse |
getAccountPasswordPolicy()
Retrieves the password policy for the AWS account.
|
default GetAccountPasswordPolicyResponse |
getAccountPasswordPolicy(Consumer<GetAccountPasswordPolicyRequest.Builder> getAccountPasswordPolicyRequest)
Retrieves the password policy for the AWS account.
|
default GetAccountPasswordPolicyResponse |
getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest)
Retrieves the password policy for the AWS account.
|
default GetAccountSummaryResponse |
getAccountSummary()
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
|
default GetAccountSummaryResponse |
getAccountSummary(Consumer<GetAccountSummaryRequest.Builder> getAccountSummaryRequest)
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
|
default GetAccountSummaryResponse |
getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest)
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
|
default GetContextKeysForCustomPolicyResponse |
getContextKeysForCustomPolicy(Consumer<GetContextKeysForCustomPolicyRequest.Builder> getContextKeysForCustomPolicyRequest)
Gets a list of all of the context keys referenced in the input policies.
|
default GetContextKeysForCustomPolicyResponse |
getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest)
Gets a list of all of the context keys referenced in the input policies.
|
default GetContextKeysForPrincipalPolicyResponse |
getContextKeysForPrincipalPolicy(Consumer<GetContextKeysForPrincipalPolicyRequest.Builder> getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM
entity.
|
default GetContextKeysForPrincipalPolicyResponse |
getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM
entity.
|
default GetCredentialReportResponse |
getCredentialReport()
Retrieves a credential report for the AWS account.
|
default GetCredentialReportResponse |
getCredentialReport(Consumer<GetCredentialReportRequest.Builder> getCredentialReportRequest)
Retrieves a credential report for the AWS account.
|
default GetCredentialReportResponse |
getCredentialReport(GetCredentialReportRequest getCredentialReportRequest)
Retrieves a credential report for the AWS account.
|
default GetGroupResponse |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Returns a list of IAM users that are in the specified IAM group.
|
default GetGroupResponse |
getGroup(GetGroupRequest getGroupRequest)
Returns a list of IAM users that are in the specified IAM group.
|
default GetGroupIterable |
getGroupPaginator(Consumer<GetGroupRequest.Builder> getGroupRequest)
Returns a list of IAM users that are in the specified IAM group.
|
default GetGroupIterable |
getGroupPaginator(GetGroupRequest getGroupRequest)
Returns a list of IAM users that are in the specified IAM group.
|
default GetGroupPolicyResponse |
getGroupPolicy(Consumer<GetGroupPolicyRequest.Builder> getGroupPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM group.
|
default GetGroupPolicyResponse |
getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM group.
|
default GetInstanceProfileResponse |
getInstanceProfile(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest)
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and
role.
|
default GetInstanceProfileResponse |
getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and
role.
|
default GetLoginProfileResponse |
getLoginProfile(Consumer<GetLoginProfileRequest.Builder> getLoginProfileRequest)
Retrieves the user name and password-creation date for the specified IAM user.
|
default GetLoginProfileResponse |
getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
Retrieves the user name and password-creation date for the specified IAM user.
|
default GetOpenIDConnectProviderResponse |
getOpenIDConnectProvider(Consumer<GetOpenIDConnectProviderRequest.Builder> getOpenIDConnectProviderRequest)
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
|
default GetOpenIDConnectProviderResponse |
getOpenIDConnectProvider(GetOpenIDConnectProviderRequest getOpenIDConnectProviderRequest)
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
|
default GetPolicyResponse |
getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)
Retrieves information about the specified managed policy, including the policy's default version and the total
number of IAM users, groups, and roles to which the policy is attached.
|
default GetPolicyResponse |
getPolicy(GetPolicyRequest getPolicyRequest)
Retrieves information about the specified managed policy, including the policy's default version and the total
number of IAM users, groups, and roles to which the policy is attached.
|
default GetPolicyVersionResponse |
getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest)
Retrieves information about the specified version of the specified managed policy, including the policy document.
|
default GetPolicyVersionResponse |
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Retrieves information about the specified version of the specified managed policy, including the policy document.
|
default GetRoleResponse |
getRole(Consumer<GetRoleRequest.Builder> getRoleRequest)
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy
that grants permission to assume the role.
|
default GetRoleResponse |
getRole(GetRoleRequest getRoleRequest)
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy
that grants permission to assume the role.
|
default GetRolePolicyResponse |
getRolePolicy(Consumer<GetRolePolicyRequest.Builder> getRolePolicyRequest)
Retrieves the specified inline policy document that is embedded with the specified IAM role.
|
default GetRolePolicyResponse |
getRolePolicy(GetRolePolicyRequest getRolePolicyRequest)
Retrieves the specified inline policy document that is embedded with the specified IAM role.
|
default GetSAMLProviderResponse |
getSAMLProvider(Consumer<GetSAMLProviderRequest.Builder> getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created
or updated.
|
default GetSAMLProviderResponse |
getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest)
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created
or updated.
|
default GetServerCertificateResponse |
getServerCertificate(Consumer<GetServerCertificateRequest.Builder> getServerCertificateRequest)
Retrieves information about the specified server certificate stored in IAM.
|
default GetServerCertificateResponse |
getServerCertificate(GetServerCertificateRequest getServerCertificateRequest)
Retrieves information about the specified server certificate stored in IAM.
|
default GetServiceLinkedRoleDeletionStatusResponse |
getServiceLinkedRoleDeletionStatus(Consumer<GetServiceLinkedRoleDeletionStatusRequest.Builder> getServiceLinkedRoleDeletionStatusRequest)
Retrieves the status of your service-linked role deletion.
|
default GetServiceLinkedRoleDeletionStatusResponse |
getServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest getServiceLinkedRoleDeletionStatusRequest)
Retrieves the status of your service-linked role deletion.
|
default GetSSHPublicKeyResponse |
getSSHPublicKey(Consumer<GetSSHPublicKeyRequest.Builder> getSSHPublicKeyRequest)
Retrieves the specified SSH public key, including metadata about the key.
|
default GetSSHPublicKeyResponse |
getSSHPublicKey(GetSSHPublicKeyRequest getSSHPublicKeyRequest)
Retrieves the specified SSH public key, including metadata about the key.
|
default GetUserResponse |
getUser()
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
|
default GetUserResponse |
getUser(Consumer<GetUserRequest.Builder> getUserRequest)
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
|
default GetUserResponse |
getUser(GetUserRequest getUserRequest)
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
|
default GetUserPolicyResponse |
getUserPolicy(Consumer<GetUserPolicyRequest.Builder> getUserPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM user.
|
default GetUserPolicyResponse |
getUserPolicy(GetUserPolicyRequest getUserPolicyRequest)
Retrieves the specified inline policy document that is embedded in the specified IAM user.
|
default ListAccessKeysResponse |
listAccessKeys()
Returns information about the access key IDs associated with the specified IAM user.
|
default ListAccessKeysResponse |
listAccessKeys(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest)
Returns information about the access key IDs associated with the specified IAM user.
|
default ListAccessKeysResponse |
listAccessKeys(ListAccessKeysRequest listAccessKeysRequest)
Returns information about the access key IDs associated with the specified IAM user.
|
default ListAccessKeysIterable |
listAccessKeysPaginator()
Returns information about the access key IDs associated with the specified IAM user.
|
default ListAccessKeysIterable |
listAccessKeysPaginator(ListAccessKeysRequest listAccessKeysRequest)
Returns information about the access key IDs associated with the specified IAM user.
|
default ListAccountAliasesResponse |
listAccountAliases()
Lists the account alias associated with the AWS account (Note: you can have only one).
|
default ListAccountAliasesResponse |
listAccountAliases(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest)
Lists the account alias associated with the AWS account (Note: you can have only one).
|
default ListAccountAliasesResponse |
listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the AWS account (Note: you can have only one).
|
default ListAccountAliasesIterable |
listAccountAliasesPaginator()
Lists the account alias associated with the AWS account (Note: you can have only one).
|
default ListAccountAliasesIterable |
listAccountAliasesPaginator(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the AWS account (Note: you can have only one).
|
default ListAttachedGroupPoliciesResponse |
listAttachedGroupPolicies(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified IAM group.
|
default ListAttachedGroupPoliciesResponse |
listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified IAM group.
|
default ListAttachedGroupPoliciesIterable |
listAttachedGroupPoliciesPaginator(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified IAM group.
|
default ListAttachedGroupPoliciesIterable |
listAttachedGroupPoliciesPaginator(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest)
Lists all managed policies that are attached to the specified IAM group.
|
default ListAttachedRolePoliciesResponse |
listAttachedRolePolicies(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified IAM role.
|
default ListAttachedRolePoliciesResponse |
listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified IAM role.
|
default ListAttachedRolePoliciesIterable |
listAttachedRolePoliciesPaginator(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified IAM role.
|
default ListAttachedRolePoliciesIterable |
listAttachedRolePoliciesPaginator(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest)
Lists all managed policies that are attached to the specified IAM role.
|
default ListAttachedUserPoliciesResponse |
listAttachedUserPolicies(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified IAM user.
|
default ListAttachedUserPoliciesResponse |
listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified IAM user.
|
default ListAttachedUserPoliciesIterable |
listAttachedUserPoliciesPaginator(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified IAM user.
|
default ListAttachedUserPoliciesIterable |
listAttachedUserPoliciesPaginator(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest)
Lists all managed policies that are attached to the specified IAM user.
|
default ListEntitiesForPolicyResponse |
listEntitiesForPolicy(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
|
default ListEntitiesForPolicyResponse |
listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
|
default ListEntitiesForPolicyIterable |
listEntitiesForPolicyPaginator(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
|
default ListEntitiesForPolicyIterable |
listEntitiesForPolicyPaginator(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
|
default ListGroupPoliciesResponse |
listGroupPolicies(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM group.
|
default ListGroupPoliciesResponse |
listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM group.
|
default ListGroupPoliciesIterable |
listGroupPoliciesPaginator(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM group.
|
default ListGroupPoliciesIterable |
listGroupPoliciesPaginator(ListGroupPoliciesRequest listGroupPoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM group.
|
default ListGroupsResponse |
listGroups()
Lists the IAM groups that have the specified path prefix.
|
default ListGroupsResponse |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists the IAM groups that have the specified path prefix.
|
default ListGroupsResponse |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the IAM groups that have the specified path prefix.
|
default ListGroupsForUserResponse |
listGroupsForUser(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest)
Lists the IAM groups that the specified IAM user belongs to.
|
default ListGroupsForUserResponse |
listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the IAM groups that the specified IAM user belongs to.
|
default ListGroupsForUserIterable |
listGroupsForUserPaginator(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest)
Lists the IAM groups that the specified IAM user belongs to.
|
default ListGroupsForUserIterable |
listGroupsForUserPaginator(ListGroupsForUserRequest listGroupsForUserRequest)
Lists the IAM groups that the specified IAM user belongs to.
|
default ListGroupsIterable |
listGroupsPaginator()
Lists the IAM groups that have the specified path prefix.
|
default ListGroupsIterable |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Lists the IAM groups that have the specified path prefix.
|
default ListInstanceProfilesResponse |
listInstanceProfiles()
Lists the instance profiles that have the specified path prefix.
|
default ListInstanceProfilesResponse |
listInstanceProfiles(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest)
Lists the instance profiles that have the specified path prefix.
|
default ListInstanceProfilesResponse |
listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
Lists the instance profiles that have the specified path prefix.
|
default ListInstanceProfilesForRoleResponse |
listInstanceProfilesForRole(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated IAM role.
|
default ListInstanceProfilesForRoleResponse |
listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated IAM role.
|
default ListInstanceProfilesForRoleIterable |
listInstanceProfilesForRolePaginator(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated IAM role.
|
default ListInstanceProfilesForRoleIterable |
listInstanceProfilesForRolePaginator(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest)
Lists the instance profiles that have the specified associated IAM role.
|
default ListInstanceProfilesIterable |
listInstanceProfilesPaginator()
Lists the instance profiles that have the specified path prefix.
|
default ListInstanceProfilesIterable |
listInstanceProfilesPaginator(ListInstanceProfilesRequest listInstanceProfilesRequest)
Lists the instance profiles that have the specified path prefix.
|
default ListMFADevicesResponse |
listMFADevices()
Lists the MFA devices for an IAM user.
|
default ListMFADevicesResponse |
listMFADevices(Consumer<ListMFADevicesRequest.Builder> listMFADevicesRequest)
Lists the MFA devices for an IAM user.
|
default ListMFADevicesResponse |
listMFADevices(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices for an IAM user.
|
default ListMFADevicesIterable |
listMFADevicesPaginator()
Lists the MFA devices for an IAM user.
|
default ListMFADevicesIterable |
listMFADevicesPaginator(ListMFADevicesRequest listMFADevicesRequest)
Lists the MFA devices for an IAM user.
|
default ListOpenIDConnectProvidersResponse |
listOpenIDConnectProviders()
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
|
default ListOpenIDConnectProvidersResponse |
listOpenIDConnectProviders(Consumer<ListOpenIDConnectProvidersRequest.Builder> listOpenIDConnectProvidersRequest)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
|
default ListOpenIDConnectProvidersResponse |
listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest listOpenIDConnectProvidersRequest)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
|
default ListPoliciesResponse |
listPolicies()
Lists all the managed policies that are available in your AWS account, including your own customer-defined
managed policies and all AWS managed policies.
|
default ListPoliciesResponse |
listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)
Lists all the managed policies that are available in your AWS account, including your own customer-defined
managed policies and all AWS managed policies.
|
default ListPoliciesResponse |
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available in your AWS account, including your own customer-defined
managed policies and all AWS managed policies.
|
default ListPoliciesIterable |
listPoliciesPaginator()
Lists all the managed policies that are available in your AWS account, including your own customer-defined
managed policies and all AWS managed policies.
|
default ListPoliciesIterable |
listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available in your AWS account, including your own customer-defined
managed policies and all AWS managed policies.
|
default ListPolicyVersionsResponse |
listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is currently set
as the policy's default version.
|
default ListPolicyVersionsResponse |
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is currently set
as the policy's default version.
|
default ListPolicyVersionsIterable |
listPolicyVersionsPaginator(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is currently set
as the policy's default version.
|
default ListPolicyVersionsIterable |
listPolicyVersionsPaginator(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists information about the versions of the specified managed policy, including the version that is currently set
as the policy's default version.
|
default ListRolePoliciesResponse |
listRolePolicies(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM role.
|
default ListRolePoliciesResponse |
listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM role.
|
default ListRolePoliciesIterable |
listRolePoliciesPaginator(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM role.
|
default ListRolePoliciesIterable |
listRolePoliciesPaginator(ListRolePoliciesRequest listRolePoliciesRequest)
Lists the names of the inline policies that are embedded in the specified IAM role.
|
default ListRolesResponse |
listRoles()
Lists the IAM roles that have the specified path prefix.
|
default ListRolesResponse |
listRoles(Consumer<ListRolesRequest.Builder> listRolesRequest)
Lists the IAM roles that have the specified path prefix.
|
default ListRolesResponse |
listRoles(ListRolesRequest listRolesRequest)
Lists the IAM roles that have the specified path prefix.
|
default ListRolesIterable |
listRolesPaginator()
Lists the IAM roles that have the specified path prefix.
|
default ListRolesIterable |
listRolesPaginator(ListRolesRequest listRolesRequest)
Lists the IAM roles that have the specified path prefix.
|
default ListSAMLProvidersResponse |
listSAMLProviders()
Lists the SAML provider resource objects defined in IAM in the account.
|
default ListSAMLProvidersResponse |
listSAMLProviders(Consumer<ListSAMLProvidersRequest.Builder> listSAMLProvidersRequest)
Lists the SAML provider resource objects defined in IAM in the account.
|
default ListSAMLProvidersResponse |
listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest)
Lists the SAML provider resource objects defined in IAM in the account.
|
default ListServerCertificatesResponse |
listServerCertificates()
Lists the server certificates stored in IAM that have the specified path prefix.
|
default ListServerCertificatesResponse |
listServerCertificates(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest)
Lists the server certificates stored in IAM that have the specified path prefix.
|
default ListServerCertificatesResponse |
listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates stored in IAM that have the specified path prefix.
|
default ListServerCertificatesIterable |
listServerCertificatesPaginator()
Lists the server certificates stored in IAM that have the specified path prefix.
|
default ListServerCertificatesIterable |
listServerCertificatesPaginator(ListServerCertificatesRequest listServerCertificatesRequest)
Lists the server certificates stored in IAM that have the specified path prefix.
|
default ListServiceSpecificCredentialsResponse |
listServiceSpecificCredentials()
Returns information about the service-specific credentials associated with the specified IAM user.
|
default ListServiceSpecificCredentialsResponse |
listServiceSpecificCredentials(Consumer<ListServiceSpecificCredentialsRequest.Builder> listServiceSpecificCredentialsRequest)
Returns information about the service-specific credentials associated with the specified IAM user.
|
default ListServiceSpecificCredentialsResponse |
listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest listServiceSpecificCredentialsRequest)
Returns information about the service-specific credentials associated with the specified IAM user.
|
default ListSigningCertificatesResponse |
listSigningCertificates()
Returns information about the signing certificates associated with the specified IAM user.
|
default ListSigningCertificatesResponse |
listSigningCertificates(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified IAM user.
|
default ListSigningCertificatesResponse |
listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified IAM user.
|
default ListSigningCertificatesIterable |
listSigningCertificatesPaginator()
Returns information about the signing certificates associated with the specified IAM user.
|
default ListSigningCertificatesIterable |
listSigningCertificatesPaginator(ListSigningCertificatesRequest listSigningCertificatesRequest)
Returns information about the signing certificates associated with the specified IAM user.
|
default ListSSHPublicKeysResponse |
listSSHPublicKeys()
Returns information about the SSH public keys associated with the specified IAM user.
|
default ListSSHPublicKeysResponse |
listSSHPublicKeys(Consumer<ListSSHPublicKeysRequest.Builder> listSSHPublicKeysRequest)
Returns information about the SSH public keys associated with the specified IAM user.
|
default ListSSHPublicKeysResponse |
listSSHPublicKeys(ListSSHPublicKeysRequest listSSHPublicKeysRequest)
Returns information about the SSH public keys associated with the specified IAM user.
|
default ListSSHPublicKeysIterable |
listSSHPublicKeysPaginator()
Returns information about the SSH public keys associated with the specified IAM user.
|
default ListSSHPublicKeysIterable |
listSSHPublicKeysPaginator(ListSSHPublicKeysRequest listSSHPublicKeysRequest)
Returns information about the SSH public keys associated with the specified IAM user.
|
default ListUserPoliciesResponse |
listUserPolicies(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified IAM user.
|
default ListUserPoliciesResponse |
listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified IAM user.
|
default ListUserPoliciesIterable |
listUserPoliciesPaginator(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified IAM user.
|
default ListUserPoliciesIterable |
listUserPoliciesPaginator(ListUserPoliciesRequest listUserPoliciesRequest)
Lists the names of the inline policies embedded in the specified IAM user.
|
default ListUsersResponse |
listUsers()
Lists the IAM users that have the specified path prefix.
|
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the IAM users that have the specified path prefix.
|
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Lists the IAM users that have the specified path prefix.
|
default ListUsersIterable |
listUsersPaginator()
Lists the IAM users that have the specified path prefix.
|
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the IAM users that have the specified path prefix.
|
default ListVirtualMFADevicesResponse |
listVirtualMFADevices()
Lists the virtual MFA devices defined in the AWS account by assignment status.
|
default ListVirtualMFADevicesResponse |
listVirtualMFADevices(Consumer<ListVirtualMFADevicesRequest.Builder> listVirtualMFADevicesRequest)
Lists the virtual MFA devices defined in the AWS account by assignment status.
|
default ListVirtualMFADevicesResponse |
listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
Lists the virtual MFA devices defined in the AWS account by assignment status.
|
default ListVirtualMFADevicesIterable |
listVirtualMFADevicesPaginator()
Lists the virtual MFA devices defined in the AWS account by assignment status.
|
default ListVirtualMFADevicesIterable |
listVirtualMFADevicesPaginator(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest)
Lists the virtual MFA devices defined in the AWS account by assignment status.
|
default PutGroupPolicyResponse |
putGroupPolicy(Consumer<PutGroupPolicyRequest.Builder> putGroupPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM group.
|
default PutGroupPolicyResponse |
putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM group.
|
default PutRolePolicyResponse |
putRolePolicy(Consumer<PutRolePolicyRequest.Builder> putRolePolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM role.
|
default PutRolePolicyResponse |
putRolePolicy(PutRolePolicyRequest putRolePolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM role.
|
default PutUserPolicyResponse |
putUserPolicy(Consumer<PutUserPolicyRequest.Builder> putUserPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM user.
|
default PutUserPolicyResponse |
putUserPolicy(PutUserPolicyRequest putUserPolicyRequest)
Adds or updates an inline policy document that is embedded in the specified IAM user.
|
default RemoveClientIDFromOpenIDConnectProviderResponse |
removeClientIDFromOpenIDConnectProvider(Consumer<RemoveClientIDFromOpenIDConnectProviderRequest.Builder> removeClientIDFromOpenIDConnectProviderRequest)
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified
IAM OpenID Connect (OIDC) provider resource object.
|
default RemoveClientIDFromOpenIDConnectProviderResponse |
removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest removeClientIDFromOpenIDConnectProviderRequest)
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified
IAM OpenID Connect (OIDC) provider resource object.
|
default RemoveRoleFromInstanceProfileResponse |
removeRoleFromInstanceProfile(Consumer<RemoveRoleFromInstanceProfileRequest.Builder> removeRoleFromInstanceProfileRequest)
Removes the specified IAM role from the specified EC2 instance profile.
|
default RemoveRoleFromInstanceProfileResponse |
removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest)
Removes the specified IAM role from the specified EC2 instance profile.
|
default RemoveUserFromGroupResponse |
removeUserFromGroup(Consumer<RemoveUserFromGroupRequest.Builder> removeUserFromGroupRequest)
Removes the specified user from the specified group.
|
default RemoveUserFromGroupResponse |
removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest)
Removes the specified user from the specified group.
|
default ResetServiceSpecificCredentialResponse |
resetServiceSpecificCredential(Consumer<ResetServiceSpecificCredentialRequest.Builder> resetServiceSpecificCredentialRequest)
Resets the password for a service-specific credential.
|
default ResetServiceSpecificCredentialResponse |
resetServiceSpecificCredential(ResetServiceSpecificCredentialRequest resetServiceSpecificCredentialRequest)
Resets the password for a service-specific credential.
|
default ResyncMFADeviceResponse |
resyncMFADevice(Consumer<ResyncMFADeviceRequest.Builder> resyncMFADeviceRequest)
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
|
default ResyncMFADeviceResponse |
resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest)
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
|
static ServiceMetadata |
serviceMetadata() |
default SetDefaultPolicyVersionResponse |
setDefaultPolicyVersion(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.
|
default SetDefaultPolicyVersionResponse |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.
|
default SimulateCustomPolicyResponse |
simulateCustomPolicy(Consumer<SimulateCustomPolicyRequest.Builder> simulateCustomPolicyRequest)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and
AWS resources to determine the policies' effective permissions.
|
default SimulateCustomPolicyResponse |
simulateCustomPolicy(SimulateCustomPolicyRequest simulateCustomPolicyRequest)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and
AWS resources to determine the policies' effective permissions.
|
default SimulateCustomPolicyIterable |
simulateCustomPolicyPaginator(Consumer<SimulateCustomPolicyRequest.Builder> simulateCustomPolicyRequest)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and
AWS resources to determine the policies' effective permissions.
|
default SimulateCustomPolicyIterable |
simulateCustomPolicyPaginator(SimulateCustomPolicyRequest simulateCustomPolicyRequest)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and
AWS resources to determine the policies' effective permissions.
|
default SimulatePrincipalPolicyResponse |
simulatePrincipalPolicy(Consumer<SimulatePrincipalPolicyRequest.Builder> simulatePrincipalPolicyRequest)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources
to determine the policies' effective permissions.
|
default SimulatePrincipalPolicyResponse |
simulatePrincipalPolicy(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources
to determine the policies' effective permissions.
|
default SimulatePrincipalPolicyIterable |
simulatePrincipalPolicyPaginator(Consumer<SimulatePrincipalPolicyRequest.Builder> simulatePrincipalPolicyRequest)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources
to determine the policies' effective permissions.
|
default SimulatePrincipalPolicyIterable |
simulatePrincipalPolicyPaginator(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources
to determine the policies' effective permissions.
|
default UpdateAccessKeyResponse |
updateAccessKey(Consumer<UpdateAccessKeyRequest.Builder> updateAccessKeyRequest)
Changes the status of the specified access key from Active to Inactive, or vice versa.
|
default UpdateAccessKeyResponse |
updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest)
Changes the status of the specified access key from Active to Inactive, or vice versa.
|
default UpdateAccountPasswordPolicyResponse |
updateAccountPasswordPolicy(Consumer<UpdateAccountPasswordPolicyRequest.Builder> updateAccountPasswordPolicyRequest)
Updates the password policy settings for the AWS account.
|
default UpdateAccountPasswordPolicyResponse |
updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
Updates the password policy settings for the AWS account.
|
default UpdateAssumeRolePolicyResponse |
updateAssumeRolePolicy(Consumer<UpdateAssumeRolePolicyRequest.Builder> updateAssumeRolePolicyRequest)
Updates the policy that grants an IAM entity permission to assume a role.
|
default UpdateAssumeRolePolicyResponse |
updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest)
Updates the policy that grants an IAM entity permission to assume a role.
|
default UpdateGroupResponse |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates the name and/or the path of the specified IAM group.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the name and/or the path of the specified IAM group.
|
default UpdateLoginProfileResponse |
updateLoginProfile(Consumer<UpdateLoginProfileRequest.Builder> updateLoginProfileRequest)
Changes the password for the specified IAM user.
|
default UpdateLoginProfileResponse |
updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest)
Changes the password for the specified IAM user.
|
default UpdateOpenIDConnectProviderThumbprintResponse |
updateOpenIDConnectProviderThumbprint(Consumer<UpdateOpenIDConnectProviderThumbprintRequest.Builder> updateOpenIDConnectProviderThumbprintRequest)
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider
resource object with a new list of thumbprints.
|
default UpdateOpenIDConnectProviderThumbprintResponse |
updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest updateOpenIDConnectProviderThumbprintRequest)
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider
resource object with a new list of thumbprints.
|
default UpdateRoleDescriptionResponse |
updateRoleDescription(Consumer<UpdateRoleDescriptionRequest.Builder> updateRoleDescriptionRequest)
Modifies the description of a role.
|
default UpdateRoleDescriptionResponse |
updateRoleDescription(UpdateRoleDescriptionRequest updateRoleDescriptionRequest)
Modifies the description of a role.
|
default UpdateSAMLProviderResponse |
updateSAMLProvider(Consumer<UpdateSAMLProviderRequest.Builder> updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider resource object.
|
default UpdateSAMLProviderResponse |
updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest)
Updates the metadata document for an existing SAML provider resource object.
|
default UpdateServerCertificateResponse |
updateServerCertificate(Consumer<UpdateServerCertificateRequest.Builder> updateServerCertificateRequest)
Updates the name and/or the path of the specified server certificate stored in IAM.
|
default UpdateServerCertificateResponse |
updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest)
Updates the name and/or the path of the specified server certificate stored in IAM.
|
default UpdateServiceSpecificCredentialResponse |
updateServiceSpecificCredential(Consumer<UpdateServiceSpecificCredentialRequest.Builder> updateServiceSpecificCredentialRequest)
Sets the status of a service-specific credential to
Active or Inactive . |
default UpdateServiceSpecificCredentialResponse |
updateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest updateServiceSpecificCredentialRequest)
Sets the status of a service-specific credential to
Active or Inactive . |
default UpdateSigningCertificateResponse |
updateSigningCertificate(Consumer<UpdateSigningCertificateRequest.Builder> updateSigningCertificateRequest)
Changes the status of the specified user signing certificate from active to disabled, or vice versa.
|
default UpdateSigningCertificateResponse |
updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest)
Changes the status of the specified user signing certificate from active to disabled, or vice versa.
|
default UpdateSSHPublicKeyResponse |
updateSSHPublicKey(Consumer<UpdateSSHPublicKeyRequest.Builder> updateSSHPublicKeyRequest)
Sets the status of an IAM user's SSH public key to active or inactive.
|
default UpdateSSHPublicKeyResponse |
updateSSHPublicKey(UpdateSSHPublicKeyRequest updateSSHPublicKeyRequest)
Sets the status of an IAM user's SSH public key to active or inactive.
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates the name and/or the path of the specified IAM user.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Updates the name and/or the path of the specified IAM user.
|
default UploadServerCertificateResponse |
uploadServerCertificate(Consumer<UploadServerCertificateRequest.Builder> uploadServerCertificateRequest)
Uploads a server certificate entity for the AWS account.
|
default UploadServerCertificateResponse |
uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest)
Uploads a server certificate entity for the AWS account.
|
default UploadSigningCertificateResponse |
uploadSigningCertificate(Consumer<UploadSigningCertificateRequest.Builder> uploadSigningCertificateRequest)
Uploads an X.509 signing certificate and associates it with the specified IAM user.
|
default UploadSigningCertificateResponse |
uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest)
Uploads an X.509 signing certificate and associates it with the specified IAM user.
|
default UploadSSHPublicKeyResponse |
uploadSSHPublicKey(Consumer<UploadSSHPublicKeyRequest.Builder> uploadSSHPublicKeyRequest)
Uploads an SSH public key and associates it with the specified IAM user.
|
default UploadSSHPublicKeyResponse |
uploadSSHPublicKey(UploadSSHPublicKeyRequest uploadSSHPublicKeyRequest)
Uploads an SSH public key and associates it with the specified IAM user.
|
serviceName
close
static final String SERVICE_NAME
static IAMClient create()
IAMClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static IAMClientBuilder builder()
IAMClient
.default AddClientIDToOpenIDConnectProviderResponse addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest addClientIDToOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
addClientIDToOpenIDConnectProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddClientIDToOpenIDConnectProviderResponse addClientIDToOpenIDConnectProvider(Consumer<AddClientIDToOpenIDConnectProviderRequest.Builder> addClientIDToOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the AddClientIDToOpenIDConnectProviderRequest.Builder
avoiding the need to create one manually via AddClientIDToOpenIDConnectProviderRequest.builder()
addClientIDToOpenIDConnectProviderRequest
- A Consumer
that will call methods on AddClientIDToOpenIDConnectProviderRequest.Builder
to
create a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddRoleToInstanceProfileResponse addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest) throws NoSuchEntityException, EntityAlreadyExistsException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
addRoleToInstanceProfileRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddRoleToInstanceProfileResponse addRoleToInstanceProfile(Consumer<AddRoleToInstanceProfileRequest.Builder> addRoleToInstanceProfileRequest) throws NoSuchEntityException, EntityAlreadyExistsException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the AddRoleToInstanceProfileRequest.Builder
avoiding
the need to create one manually via AddRoleToInstanceProfileRequest.builder()
addRoleToInstanceProfileRequest
- A Consumer
that will call methods on AddRoleToInstanceProfileRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddUserToGroupResponse addUserToGroup(AddUserToGroupRequest addUserToGroupRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Adds the specified user to the specified group.
addUserToGroupRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddUserToGroupResponse addUserToGroup(Consumer<AddUserToGroupRequest.Builder> addUserToGroupRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Adds the specified user to the specified group.
This is a convenience which creates an instance of the AddUserToGroupRequest.Builder
avoiding the need to
create one manually via AddUserToGroupRequest.builder()
addUserToGroupRequest
- A Consumer
that will call methods on AddUserToGroupRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachGroupPolicyResponse attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
attachGroupPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyNotAttachableException
- The request failed because AWS service role policies can only be attached to the service-linked role for
that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachGroupPolicyResponse attachGroupPolicy(Consumer<AttachGroupPolicyRequest.Builder> attachGroupPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the AttachGroupPolicyRequest.Builder
avoiding the need
to create one manually via AttachGroupPolicyRequest.builder()
attachGroupPolicyRequest
- A Consumer
that will call methods on AttachGroupPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyNotAttachableException
- The request failed because AWS service role policies can only be attached to the service-linked role for
that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachRolePolicyResponse attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, UnmodifiableEntityException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
attachRolePolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.PolicyNotAttachableException
- The request failed because AWS service role policies can only be attached to the service-linked role for
that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachRolePolicyResponse attachRolePolicy(Consumer<AttachRolePolicyRequest.Builder> attachRolePolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, UnmodifiableEntityException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the AttachRolePolicyRequest.Builder
avoiding the need
to create one manually via AttachRolePolicyRequest.builder()
attachRolePolicyRequest
- A Consumer
that will call methods on AttachRolePolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.PolicyNotAttachableException
- The request failed because AWS service role policies can only be attached to the service-linked role for
that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachUserPolicyResponse attachUserPolicy(AttachUserPolicyRequest attachUserPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
attachUserPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyNotAttachableException
- The request failed because AWS service role policies can only be attached to the service-linked role for
that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachUserPolicyResponse attachUserPolicy(Consumer<AttachUserPolicyRequest.Builder> attachUserPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the AttachUserPolicyRequest.Builder
avoiding the need
to create one manually via AttachUserPolicyRequest.builder()
attachUserPolicyRequest
- A Consumer
that will call methods on AttachUserPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyNotAttachableException
- The request failed because AWS service role policies can only be attached to the service-linked role for
that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ChangePasswordResponse changePassword(ChangePasswordRequest changePasswordRequest) throws NoSuchEntityException, InvalidUserTypeException, LimitExceededException, EntityTemporarilyUnmodifiableException, PasswordPolicyViolationException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
changePasswordRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidUserTypeException
- The request was rejected because the type of user for the transaction was incorrect.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the
account password policy.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ChangePasswordResponse changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest) throws NoSuchEntityException, InvalidUserTypeException, LimitExceededException, EntityTemporarilyUnmodifiableException, PasswordPolicyViolationException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ChangePasswordRequest.Builder
avoiding the need to
create one manually via ChangePasswordRequest.builder()
changePasswordRequest
- A Consumer
that will call methods on ChangePasswordRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidUserTypeException
- The request was rejected because the type of user for the transaction was incorrect.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the
account password policy.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAccessKeyResponse createAccessKey() throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
createAccessKey(CreateAccessKeyRequest)
,
AWS API
Documentationdefault CreateAccessKeyResponse createAccessKey(CreateAccessKeyRequest createAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createAccessKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAccessKeyResponse createAccessKey(Consumer<CreateAccessKeyRequest.Builder> createAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateAccessKeyRequest.Builder
avoiding the need
to create one manually via CreateAccessKeyRequest.builder()
createAccessKeyRequest
- A Consumer
that will call methods on CreateAccessKeyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAccountAliasResponse createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest) throws EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createAccountAliasRequest
- EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAccountAliasResponse createAccountAlias(Consumer<CreateAccountAliasRequest.Builder> createAccountAliasRequest) throws EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateAccountAliasRequest.Builder
avoiding the
need to create one manually via CreateAccountAliasRequest.builder()
createAccountAliasRequest
- A Consumer
that will call methods on CreateAccountAliasRequest.Builder
to create a
request.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws LimitExceededException, EntityAlreadyExistsException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
createGroupRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws LimitExceededException, EntityAlreadyExistsException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- A Consumer
that will call methods on CreateGroupRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInstanceProfileResponse createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest) throws EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createInstanceProfileRequest
- EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInstanceProfileResponse createInstanceProfile(Consumer<CreateInstanceProfileRequest.Builder> createInstanceProfileRequest) throws EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateInstanceProfileRequest.Builder
avoiding the
need to create one manually via CreateInstanceProfileRequest.builder()
createInstanceProfileRequest
- A Consumer
that will call methods on CreateInstanceProfileRequest.Builder
to create a
request.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateLoginProfileResponse createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest) throws EntityAlreadyExistsException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createLoginProfileRequest
- EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the
account password policy.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateLoginProfileResponse createLoginProfile(Consumer<CreateLoginProfileRequest.Builder> createLoginProfileRequest) throws EntityAlreadyExistsException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateLoginProfileRequest.Builder
avoiding the
need to create one manually via CreateLoginProfileRequest.builder()
createLoginProfileRequest
- A Consumer
that will call methods on CreateLoginProfileRequest.Builder
to create a
request.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the
account password policy.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateOpenIDConnectProviderResponse createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest createOpenIDConnectProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createOpenIDConnectProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateOpenIDConnectProviderResponse createOpenIDConnectProvider(Consumer<CreateOpenIDConnectProviderRequest.Builder> createOpenIDConnectProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateOpenIDConnectProviderRequest.Builder
avoiding the need to create one manually via CreateOpenIDConnectProviderRequest.builder()
createOpenIDConnectProviderRequest
- A Consumer
that will call methods on CreateOpenIDConnectProviderRequest.Builder
to create
a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePolicyResponse createPolicy(CreatePolicyRequest createPolicyRequest) throws InvalidInputException, LimitExceededException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createPolicyRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePolicyResponse createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) throws InvalidInputException, LimitExceededException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreatePolicyRequest.Builder
avoiding the need to
create one manually via CreatePolicyRequest.builder()
createPolicyRequest
- A Consumer
that will call methods on CreatePolicyRequest.Builder
to create a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePolicyVersionResponse createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, InvalidInputException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createPolicyVersionRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePolicyVersionResponse createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, InvalidInputException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreatePolicyVersionRequest.Builder
avoiding the
need to create one manually via CreatePolicyVersionRequest.builder()
createPolicyVersionRequest
- A Consumer
that will call methods on CreatePolicyVersionRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateRoleResponse createRole(CreateRoleRequest createRoleRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createRoleRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateRoleResponse createRole(Consumer<CreateRoleRequest.Builder> createRoleRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateRoleRequest.Builder
avoiding the need to
create one manually via CreateRoleRequest.builder()
createRoleRequest
- A Consumer
that will call methods on CreateRoleRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSAMLProviderResponse createSAMLProvider(CreateSAMLProviderRequest createSAMLProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createSAMLProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSAMLProviderResponse createSAMLProvider(Consumer<CreateSAMLProviderRequest.Builder> createSAMLProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateSAMLProviderRequest.Builder
avoiding the
need to create one manually via CreateSAMLProviderRequest.builder()
createSAMLProviderRequest
- A Consumer
that will call methods on CreateSAMLProviderRequest.Builder
to create a
request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateServiceLinkedRoleResponse createServiceLinkedRole(CreateServiceLinkedRoleRequest createServiceLinkedRoleRequest) throws InvalidInputException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createServiceLinkedRoleRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateServiceLinkedRoleResponse createServiceLinkedRole(Consumer<CreateServiceLinkedRoleRequest.Builder> createServiceLinkedRoleRequest) throws InvalidInputException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateServiceLinkedRoleRequest.Builder
avoiding
the need to create one manually via CreateServiceLinkedRoleRequest.builder()
createServiceLinkedRoleRequest
- A Consumer
that will call methods on CreateServiceLinkedRoleRequest.Builder
to create a
request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateServiceSpecificCredentialResponse createServiceSpecificCredential(CreateServiceSpecificCredentialRequest createServiceSpecificCredentialRequest) throws LimitExceededException, NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IAMException
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.
createServiceSpecificCredentialRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceNotSupportedException
- The specified service does not support service-specific credentials.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateServiceSpecificCredentialResponse createServiceSpecificCredential(Consumer<CreateServiceSpecificCredentialRequest.Builder> createServiceSpecificCredentialRequest) throws LimitExceededException, NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateServiceSpecificCredentialRequest.Builder
avoiding the need to create one manually via CreateServiceSpecificCredentialRequest.builder()
createServiceSpecificCredentialRequest
- A Consumer
that will call methods on CreateServiceSpecificCredentialRequest.Builder
to
create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceNotSupportedException
- The specified service does not support service-specific credentials.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws LimitExceededException, EntityAlreadyExistsException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createUserRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws LimitExceededException, EntityAlreadyExistsException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateUserRequest.Builder
avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest
- A Consumer
that will call methods on CreateUserRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateVirtualMFADeviceResponse createVirtualMFADevice(CreateVirtualMFADeviceRequest createVirtualMFADeviceRequest) throws LimitExceededException, EntityAlreadyExistsException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
createVirtualMFADeviceRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateVirtualMFADeviceResponse createVirtualMFADevice(Consumer<CreateVirtualMFADeviceRequest.Builder> createVirtualMFADeviceRequest) throws LimitExceededException, EntityAlreadyExistsException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the CreateVirtualMFADeviceRequest.Builder
avoiding the
need to create one manually via CreateVirtualMFADeviceRequest.builder()
createVirtualMFADeviceRequest
- A Consumer
that will call methods on CreateVirtualMFADeviceRequest.Builder
to create a
request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeactivateMFADeviceResponse deactivateMFADevice(DeactivateMFADeviceRequest deactivateMFADeviceRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deactivateMFADeviceRequest
- EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeactivateMFADeviceResponse deactivateMFADevice(Consumer<DeactivateMFADeviceRequest.Builder> deactivateMFADeviceRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeactivateMFADeviceRequest.Builder
avoiding the
need to create one manually via DeactivateMFADeviceRequest.builder()
deactivateMFADeviceRequest
- A Consumer
that will call methods on DeactivateMFADeviceRequest.Builder
to create a
request.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccessKeyResponse deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteAccessKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccessKeyResponse deleteAccessKey(Consumer<DeleteAccessKeyRequest.Builder> deleteAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteAccessKeyRequest.Builder
avoiding the need
to create one manually via DeleteAccessKeyRequest.builder()
deleteAccessKeyRequest
- A Consumer
that will call methods on DeleteAccessKeyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccountAliasResponse deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteAccountAliasRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccountAliasResponse deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteAccountAliasRequest.Builder
avoiding the
need to create one manually via DeleteAccountAliasRequest.builder()
deleteAccountAliasRequest
- A Consumer
that will call methods on DeleteAccountAliasRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccountPasswordPolicyResponse deleteAccountPasswordPolicy() throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the password policy for the AWS account. There are no parameters.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest)
,
AWS API Documentationdefault DeleteAccountPasswordPolicyResponse deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the password policy for the AWS account. There are no parameters.
deleteAccountPasswordPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccountPasswordPolicyResponse deleteAccountPasswordPolicy(Consumer<DeleteAccountPasswordPolicyRequest.Builder> deleteAccountPasswordPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the password policy for the AWS account. There are no parameters.
This is a convenience which creates an instance of the DeleteAccountPasswordPolicyRequest.Builder
avoiding the need to create one manually via DeleteAccountPasswordPolicyRequest.builder()
deleteAccountPasswordPolicyRequest
- A Consumer
that will call methods on DeleteAccountPasswordPolicyRequest.Builder
to create
a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
deleteGroupRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- A Consumer
that will call methods on DeleteGroupRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupPolicyResponse deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteGroupPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupPolicyResponse deleteGroupPolicy(Consumer<DeleteGroupPolicyRequest.Builder> deleteGroupPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteGroupPolicyRequest.Builder
avoiding the need
to create one manually via DeleteGroupPolicyRequest.builder()
deleteGroupPolicyRequest
- A Consumer
that will call methods on DeleteGroupPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInstanceProfileResponse deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteInstanceProfileRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInstanceProfileResponse deleteInstanceProfile(Consumer<DeleteInstanceProfileRequest.Builder> deleteInstanceProfileRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteInstanceProfileRequest.Builder
avoiding the
need to create one manually via DeleteInstanceProfileRequest.builder()
deleteInstanceProfileRequest
- A Consumer
that will call methods on DeleteInstanceProfileRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLoginProfileResponse deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteLoginProfileRequest
- EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLoginProfileResponse deleteLoginProfile(Consumer<DeleteLoginProfileRequest.Builder> deleteLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteLoginProfileRequest.Builder
avoiding the
need to create one manually via DeleteLoginProfileRequest.builder()
deleteLoginProfileRequest
- A Consumer
that will call methods on DeleteLoginProfileRequest.Builder
to create a
request.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteOpenIDConnectProviderResponse deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest deleteOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteOpenIDConnectProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteOpenIDConnectProviderResponse deleteOpenIDConnectProvider(Consumer<DeleteOpenIDConnectProviderRequest.Builder> deleteOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteOpenIDConnectProviderRequest.Builder
avoiding the need to create one manually via DeleteOpenIDConnectProviderRequest.builder()
deleteOpenIDConnectProviderRequest
- A Consumer
that will call methods on DeleteOpenIDConnectProviderRequest.Builder
to create
a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, DeleteConflictException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deletePolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, DeleteConflictException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeletePolicyRequest.Builder
avoiding the need to
create one manually via DeletePolicyRequest.builder()
deletePolicyRequest
- A Consumer
that will call methods on DeletePolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePolicyVersionResponse deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, DeleteConflictException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deletePolicyVersionRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePolicyVersionResponse deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, DeleteConflictException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeletePolicyVersionRequest.Builder
avoiding the
need to create one manually via DeletePolicyVersionRequest.builder()
deletePolicyVersionRequest
- A Consumer
that will call methods on DeletePolicyVersionRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRoleResponse deleteRole(DeleteRoleRequest deleteRoleRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteRoleRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRoleResponse deleteRole(Consumer<DeleteRoleRequest.Builder> deleteRoleRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteRoleRequest.Builder
avoiding the need to
create one manually via DeleteRoleRequest.builder()
deleteRoleRequest
- A Consumer
that will call methods on DeleteRoleRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRolePolicyResponse deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest) throws NoSuchEntityException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteRolePolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRolePolicyResponse deleteRolePolicy(Consumer<DeleteRolePolicyRequest.Builder> deleteRolePolicyRequest) throws NoSuchEntityException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteRolePolicyRequest.Builder
avoiding the need
to create one manually via DeleteRolePolicyRequest.builder()
deleteRolePolicyRequest
- A Consumer
that will call methods on DeleteRolePolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSAMLProviderResponse deleteSAMLProvider(DeleteSAMLProviderRequest deleteSAMLProviderRequest) throws InvalidInputException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteSAMLProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSAMLProviderResponse deleteSAMLProvider(Consumer<DeleteSAMLProviderRequest.Builder> deleteSAMLProviderRequest) throws InvalidInputException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteSAMLProviderRequest.Builder
avoiding the
need to create one manually via DeleteSAMLProviderRequest.builder()
deleteSAMLProviderRequest
- A Consumer
that will call methods on DeleteSAMLProviderRequest.Builder
to create a
request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSSHPublicKeyResponse deleteSSHPublicKey(DeleteSSHPublicKeyRequest deleteSSHPublicKeyRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
deleteSSHPublicKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSSHPublicKeyResponse deleteSSHPublicKey(Consumer<DeleteSSHPublicKeyRequest.Builder> deleteSSHPublicKeyRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteSSHPublicKeyRequest.Builder
avoiding the
need to create one manually via DeleteSSHPublicKeyRequest.builder()
deleteSSHPublicKeyRequest
- A Consumer
that will call methods on DeleteSSHPublicKeyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServerCertificateResponse deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteServerCertificateRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServerCertificateResponse deleteServerCertificate(Consumer<DeleteServerCertificateRequest.Builder> deleteServerCertificateRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteServerCertificateRequest.Builder
avoiding
the need to create one manually via DeleteServerCertificateRequest.builder()
deleteServerCertificateRequest
- A Consumer
that will call methods on DeleteServerCertificateRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServiceLinkedRoleResponse deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest deleteServiceLinkedRoleRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteServiceLinkedRoleRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServiceLinkedRoleResponse deleteServiceLinkedRole(Consumer<DeleteServiceLinkedRoleRequest.Builder> deleteServiceLinkedRoleRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteServiceLinkedRoleRequest.Builder
avoiding
the need to create one manually via DeleteServiceLinkedRoleRequest.builder()
deleteServiceLinkedRoleRequest
- A Consumer
that will call methods on DeleteServiceLinkedRoleRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServiceSpecificCredentialResponse deleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest deleteServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
Deletes the specified service-specific credential.
deleteServiceSpecificCredentialRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServiceSpecificCredentialResponse deleteServiceSpecificCredential(Consumer<DeleteServiceSpecificCredentialRequest.Builder> deleteServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
Deletes the specified service-specific credential.
This is a convenience which creates an instance of the DeleteServiceSpecificCredentialRequest.Builder
avoiding the need to create one manually via DeleteServiceSpecificCredentialRequest.builder()
deleteServiceSpecificCredentialRequest
- A Consumer
that will call methods on DeleteServiceSpecificCredentialRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSigningCertificateResponse deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteSigningCertificateRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSigningCertificateResponse deleteSigningCertificate(Consumer<DeleteSigningCertificateRequest.Builder> deleteSigningCertificateRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteSigningCertificateRequest.Builder
avoiding
the need to create one manually via DeleteSigningCertificateRequest.builder()
deleteSigningCertificateRequest
- A Consumer
that will call methods on DeleteSigningCertificateRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws LimitExceededException, NoSuchEntityException, DeleteConflictException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
deleteUserRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws LimitExceededException, NoSuchEntityException, DeleteConflictException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
This is a convenience which creates an instance of the DeleteUserRequest.Builder
avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest
- A Consumer
that will call methods on DeleteUserRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserPolicyResponse deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteUserPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserPolicyResponse deleteUserPolicy(Consumer<DeleteUserPolicyRequest.Builder> deleteUserPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteUserPolicyRequest.Builder
avoiding the need
to create one manually via DeleteUserPolicyRequest.builder()
deleteUserPolicyRequest
- A Consumer
that will call methods on DeleteUserPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteVirtualMFADeviceResponse deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest deleteVirtualMFADeviceRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
deleteVirtualMFADeviceRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteVirtualMFADeviceResponse deleteVirtualMFADevice(Consumer<DeleteVirtualMFADeviceRequest.Builder> deleteVirtualMFADeviceRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DeleteVirtualMFADeviceRequest.Builder
avoiding the
need to create one manually via DeleteVirtualMFADeviceRequest.builder()
deleteVirtualMFADeviceRequest
- A Consumer
that will call methods on DeleteVirtualMFADeviceRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.DeleteConflictException
- The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachGroupPolicyResponse detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
detachGroupPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachGroupPolicyResponse detachGroupPolicy(Consumer<DetachGroupPolicyRequest.Builder> detachGroupPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DetachGroupPolicyRequest.Builder
avoiding the need
to create one manually via DetachGroupPolicyRequest.builder()
detachGroupPolicyRequest
- A Consumer
that will call methods on DetachGroupPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachRolePolicyResponse detachRolePolicy(DetachRolePolicyRequest detachRolePolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
detachRolePolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachRolePolicyResponse detachRolePolicy(Consumer<DetachRolePolicyRequest.Builder> detachRolePolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DetachRolePolicyRequest.Builder
avoiding the need
to create one manually via DetachRolePolicyRequest.builder()
detachRolePolicyRequest
- A Consumer
that will call methods on DetachRolePolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachUserPolicyResponse detachUserPolicy(DetachUserPolicyRequest detachUserPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
detachUserPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachUserPolicyResponse detachUserPolicy(Consumer<DetachUserPolicyRequest.Builder> detachUserPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the DetachUserPolicyRequest.Builder
avoiding the need
to create one manually via DetachUserPolicyRequest.builder()
detachUserPolicyRequest
- A Consumer
that will call methods on DetachUserPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableMFADeviceResponse enableMFADevice(EnableMFADeviceRequest enableMFADeviceRequest) throws EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, InvalidAuthenticationCodeException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
enableMFADeviceRequest
- EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.InvalidAuthenticationCodeException
- The request was rejected because the authentication code was not recognized. The error message describes
the specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableMFADeviceResponse enableMFADevice(Consumer<EnableMFADeviceRequest.Builder> enableMFADeviceRequest) throws EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, InvalidAuthenticationCodeException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the EnableMFADeviceRequest.Builder
avoiding the need
to create one manually via EnableMFADeviceRequest.builder()
enableMFADeviceRequest
- A Consumer
that will call methods on EnableMFADeviceRequest.Builder
to create a request.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.InvalidAuthenticationCodeException
- The request was rejected because the authentication code was not recognized. The error message describes
the specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GenerateCredentialReportResponse generateCredentialReport() throws LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
generateCredentialReport(GenerateCredentialReportRequest)
,
AWS
API Documentationdefault GenerateCredentialReportResponse generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest) throws LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
generateCredentialReportRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GenerateCredentialReportResponse generateCredentialReport(Consumer<GenerateCredentialReportRequest.Builder> generateCredentialReportRequest) throws LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
This is a convenience which creates an instance of the GenerateCredentialReportRequest.Builder
avoiding
the need to create one manually via GenerateCredentialReportRequest.builder()
generateCredentialReportRequest
- A Consumer
that will call methods on GenerateCredentialReportRequest.Builder
to create a
request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccessKeyLastUsedResponse getAccessKeyLastUsed(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
getAccessKeyLastUsedRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccessKeyLastUsedResponse getAccessKeyLastUsed(Consumer<GetAccessKeyLastUsedRequest.Builder> getAccessKeyLastUsedRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetAccessKeyLastUsedRequest.Builder
avoiding the
need to create one manually via GetAccessKeyLastUsedRequest.builder()
getAccessKeyLastUsedRequest
- A Consumer
that will call methods on GetAccessKeyLastUsedRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountAuthorizationDetailsResponse getAccountAuthorizationDetails() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest)
,
AWS API Documentationdefault GetAccountAuthorizationDetailsResponse getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getAccountAuthorizationDetailsRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountAuthorizationDetailsResponse getAccountAuthorizationDetails(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetAccountAuthorizationDetailsRequest.Builder
avoiding the need to create one manually via GetAccountAuthorizationDetailsRequest.builder()
getAccountAuthorizationDetailsRequest
- A Consumer
that will call methods on GetAccountAuthorizationDetailsRequest.Builder
to
create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountAuthorizationDetailsIterable getAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsIterable responses = client.getAccountAuthorizationDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsIterable responses = client .getAccountAuthorizationDetailsPaginator(request); for (software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsIterable responses = client.getAccountAuthorizationDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation.
getAccountAuthorizationDetailsRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountAuthorizationDetailsIterable getAccountAuthorizationDetailsPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsIterable responses = client.getAccountAuthorizationDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsIterable responses = client .getAccountAuthorizationDetailsPaginator(request); for (software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsIterable responses = client.getAccountAuthorizationDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest)
,
AWS API Documentationdefault GetAccountPasswordPolicyResponse getAccountPasswordPolicy() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getAccountPasswordPolicy(GetAccountPasswordPolicyRequest)
,
AWS
API Documentationdefault GetAccountPasswordPolicyResponse getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
getAccountPasswordPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountPasswordPolicyResponse getAccountPasswordPolicy(Consumer<GetAccountPasswordPolicyRequest.Builder> getAccountPasswordPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
This is a convenience which creates an instance of the GetAccountPasswordPolicyRequest.Builder
avoiding
the need to create one manually via GetAccountPasswordPolicyRequest.builder()
getAccountPasswordPolicyRequest
- A Consumer
that will call methods on GetAccountPasswordPolicyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountSummaryResponse getAccountSummary() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getAccountSummary(GetAccountSummaryRequest)
,
AWS API
Documentationdefault GetAccountSummaryResponse getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getAccountSummaryRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountSummaryResponse getAccountSummary(Consumer<GetAccountSummaryRequest.Builder> getAccountSummaryRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetAccountSummaryRequest.Builder
avoiding the need
to create one manually via GetAccountSummaryRequest.builder()
getAccountSummaryRequest
- A Consumer
that will call methods on GetAccountSummaryRequest.Builder
to create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContextKeysForCustomPolicyResponse getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest) throws InvalidInputException, AwsServiceException, SdkClientException, IAMException
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.
getContextKeysForCustomPolicyRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContextKeysForCustomPolicyResponse getContextKeysForCustomPolicy(Consumer<GetContextKeysForCustomPolicyRequest.Builder> getContextKeysForCustomPolicyRequest) throws InvalidInputException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetContextKeysForCustomPolicyRequest.Builder
avoiding the need to create one manually via GetContextKeysForCustomPolicyRequest.builder()
getContextKeysForCustomPolicyRequest
- A Consumer
that will call methods on GetContextKeysForCustomPolicyRequest.Builder
to
create a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContextKeysForPrincipalPolicyResponse getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IAMException
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.
getContextKeysForPrincipalPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContextKeysForPrincipalPolicyResponse getContextKeysForPrincipalPolicy(Consumer<GetContextKeysForPrincipalPolicyRequest.Builder> getContextKeysForPrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetContextKeysForPrincipalPolicyRequest.Builder
avoiding the need to create one manually via GetContextKeysForPrincipalPolicyRequest.builder()
getContextKeysForPrincipalPolicyRequest
- A Consumer
that will call methods on GetContextKeysForPrincipalPolicyRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCredentialReportResponse getCredentialReport() throws CredentialReportNotPresentException, CredentialReportExpiredException, CredentialReportNotReadyException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
CredentialReportNotPresentException
- The request was rejected because the credential report does not exist. To generate a credential report,
use GenerateCredentialReport.CredentialReportExpiredException
- The request was rejected because the most recent credential report has expired. To generate a new
credential report, use GenerateCredentialReport. For more information about credential report
expiration, see Getting
Credential Reports in the IAM User Guide.CredentialReportNotReadyException
- The request was rejected because the credential report is still being generated.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getCredentialReport(GetCredentialReportRequest)
,
AWS API
Documentationdefault GetCredentialReportResponse getCredentialReport(GetCredentialReportRequest getCredentialReportRequest) throws CredentialReportNotPresentException, CredentialReportExpiredException, CredentialReportNotReadyException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
getCredentialReportRequest
- CredentialReportNotPresentException
- The request was rejected because the credential report does not exist. To generate a credential report,
use GenerateCredentialReport.CredentialReportExpiredException
- The request was rejected because the most recent credential report has expired. To generate a new
credential report, use GenerateCredentialReport. For more information about credential report
expiration, see Getting
Credential Reports in the IAM User Guide.CredentialReportNotReadyException
- The request was rejected because the credential report is still being generated.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCredentialReportResponse getCredentialReport(Consumer<GetCredentialReportRequest.Builder> getCredentialReportRequest) throws CredentialReportNotPresentException, CredentialReportExpiredException, CredentialReportNotReadyException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
This is a convenience which creates an instance of the GetCredentialReportRequest.Builder
avoiding the
need to create one manually via GetCredentialReportRequest.builder()
getCredentialReportRequest
- A Consumer
that will call methods on GetCredentialReportRequest.Builder
to create a
request.CredentialReportNotPresentException
- The request was rejected because the credential report does not exist. To generate a credential report,
use GenerateCredentialReport.CredentialReportExpiredException
- The request was rejected because the most recent credential report has expired. To generate a new
credential report, use GenerateCredentialReport. For more information about credential report
expiration, see Getting
Credential Reports in the IAM User Guide.CredentialReportNotReadyException
- The request was rejected because the credential report is still being generated.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
and Marker
parameters.
getGroupRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
and Marker
parameters.
This is a convenience which creates an instance of the GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- A Consumer
that will call methods on GetGroupRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupIterable getGroupPaginator(GetGroupRequest getGroupRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
and Marker
parameters.
This is a variant of getGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.GetGroupIterable responses = client.getGroupPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.GetGroupIterable responses = client.getGroupPaginator(request); for (software.amazon.awssdk.services.iam.model.GetGroupResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.GetGroupIterable responses = client.getGroupPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation.
getGroupRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupIterable getGroupPaginator(Consumer<GetGroupRequest.Builder> getGroupRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
and Marker
parameters.
This is a variant of getGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.GetGroupIterable responses = client.getGroupPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.GetGroupIterable responses = client.getGroupPaginator(request); for (software.amazon.awssdk.services.iam.model.GetGroupResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.GetGroupIterable responses = client.getGroupPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation.
This is a convenience which creates an instance of the GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- A Consumer
that will call methods on GetGroupRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupPolicyResponse getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getGroupPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupPolicyResponse getGroupPolicy(Consumer<GetGroupPolicyRequest.Builder> getGroupPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetGroupPolicyRequest.Builder
avoiding the need to
create one manually via GetGroupPolicyRequest.builder()
getGroupPolicyRequest
- A Consumer
that will call methods on GetGroupPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInstanceProfileResponse getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getInstanceProfileRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInstanceProfileResponse getInstanceProfile(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetInstanceProfileRequest.Builder
avoiding the
need to create one manually via GetInstanceProfileRequest.builder()
getInstanceProfileRequest
- A Consumer
that will call methods on GetInstanceProfileRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLoginProfileResponse getLoginProfile(GetLoginProfileRequest getLoginProfileRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getLoginProfileRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLoginProfileResponse getLoginProfile(Consumer<GetLoginProfileRequest.Builder> getLoginProfileRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetLoginProfileRequest.Builder
avoiding the need
to create one manually via GetLoginProfileRequest.builder()
getLoginProfileRequest
- A Consumer
that will call methods on GetLoginProfileRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetOpenIDConnectProviderResponse getOpenIDConnectProvider(GetOpenIDConnectProviderRequest getOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
getOpenIDConnectProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetOpenIDConnectProviderResponse getOpenIDConnectProvider(Consumer<GetOpenIDConnectProviderRequest.Builder> getOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
This is a convenience which creates an instance of the GetOpenIDConnectProviderRequest.Builder
avoiding
the need to create one manually via GetOpenIDConnectProviderRequest.builder()
getOpenIDConnectProviderRequest
- A Consumer
that will call methods on GetOpenIDConnectProviderRequest.Builder
to create a
request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetPolicyRequest.Builder
avoiding the need to
create one manually via GetPolicyRequest.builder()
getPolicyRequest
- A Consumer
that will call methods on GetPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPolicyVersionResponse getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getPolicyVersionRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPolicyVersionResponse getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetPolicyVersionRequest.Builder
avoiding the need
to create one manually via GetPolicyVersionRequest.builder()
getPolicyVersionRequest
- A Consumer
that will call methods on GetPolicyVersionRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRoleResponse getRole(GetRoleRequest getRoleRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getRoleRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRoleResponse getRole(Consumer<GetRoleRequest.Builder> getRoleRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetRoleRequest.Builder
avoiding the need to create
one manually via GetRoleRequest.builder()
getRoleRequest
- A Consumer
that will call methods on GetRoleRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRolePolicyResponse getRolePolicy(GetRolePolicyRequest getRolePolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getRolePolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRolePolicyResponse getRolePolicy(Consumer<GetRolePolicyRequest.Builder> getRolePolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetRolePolicyRequest.Builder
avoiding the need to
create one manually via GetRolePolicyRequest.builder()
getRolePolicyRequest
- A Consumer
that will call methods on GetRolePolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSAMLProviderResponse getSAMLProvider(GetSAMLProviderRequest getSAMLProviderRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getSAMLProviderRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSAMLProviderResponse getSAMLProvider(Consumer<GetSAMLProviderRequest.Builder> getSAMLProviderRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetSAMLProviderRequest.Builder
avoiding the need
to create one manually via GetSAMLProviderRequest.builder()
getSAMLProviderRequest
- A Consumer
that will call methods on GetSAMLProviderRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSSHPublicKeyResponse getSSHPublicKey(GetSSHPublicKeyRequest getSSHPublicKeyRequest) throws NoSuchEntityException, UnrecognizedPublicKeyEncodingException, AwsServiceException, SdkClientException, IAMException
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.
getSSHPublicKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.UnrecognizedPublicKeyEncodingException
- The request was rejected because the public key encoding format is unsupported or unrecognized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSSHPublicKeyResponse getSSHPublicKey(Consumer<GetSSHPublicKeyRequest.Builder> getSSHPublicKeyRequest) throws NoSuchEntityException, UnrecognizedPublicKeyEncodingException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetSSHPublicKeyRequest.Builder
avoiding the need
to create one manually via GetSSHPublicKeyRequest.builder()
getSSHPublicKeyRequest
- A Consumer
that will call methods on GetSSHPublicKeyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.UnrecognizedPublicKeyEncodingException
- The request was rejected because the public key encoding format is unsupported or unrecognized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServerCertificateResponse getServerCertificate(GetServerCertificateRequest getServerCertificateRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getServerCertificateRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServerCertificateResponse getServerCertificate(Consumer<GetServerCertificateRequest.Builder> getServerCertificateRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetServerCertificateRequest.Builder
avoiding the
need to create one manually via GetServerCertificateRequest.builder()
getServerCertificateRequest
- A Consumer
that will call methods on GetServerCertificateRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServiceLinkedRoleDeletionStatusResponse getServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest getServiceLinkedRoleDeletionStatusRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getServiceLinkedRoleDeletionStatusRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServiceLinkedRoleDeletionStatusResponse getServiceLinkedRoleDeletionStatus(Consumer<GetServiceLinkedRoleDeletionStatusRequest.Builder> getServiceLinkedRoleDeletionStatusRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetServiceLinkedRoleDeletionStatusRequest.Builder
avoiding the need to create one manually via GetServiceLinkedRoleDeletionStatusRequest.builder()
getServiceLinkedRoleDeletionStatusRequest
- A Consumer
that will call methods on GetServiceLinkedRoleDeletionStatusRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetUserResponse getUser() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getUser(GetUserRequest)
,
AWS API
Documentationdefault GetUserResponse getUser(GetUserRequest getUserRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getUserRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetUserRequest.Builder
avoiding the need to create
one manually via GetUserRequest.builder()
getUserRequest
- A Consumer
that will call methods on GetUserRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetUserPolicyResponse getUserPolicy(GetUserPolicyRequest getUserPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
getUserPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetUserPolicyResponse getUserPolicy(Consumer<GetUserPolicyRequest.Builder> getUserPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the GetUserPolicyRequest.Builder
avoiding the need to
create one manually via GetUserPolicyRequest.builder()
getUserPolicyRequest
- A Consumer
that will call methods on GetUserPolicyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccessKeysResponse listAccessKeys() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listAccessKeys(ListAccessKeysRequest)
,
AWS API
Documentationdefault ListAccessKeysResponse listAccessKeys(ListAccessKeysRequest listAccessKeysRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listAccessKeysRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccessKeysResponse listAccessKeys(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListAccessKeysRequest.Builder
avoiding the need to
create one manually via ListAccessKeysRequest.builder()
listAccessKeysRequest
- A Consumer
that will call methods on ListAccessKeysRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccessKeysIterable listAccessKeysPaginator(ListAccessKeysRequest listAccessKeysRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAccessKeysIterable responses = client.listAccessKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAccessKeysIterable responses = client.listAccessKeysPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAccessKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAccessKeysIterable responses = client.listAccessKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation.
listAccessKeysRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccessKeysIterable listAccessKeysPaginator() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAccessKeysIterable responses = client.listAccessKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAccessKeysIterable responses = client.listAccessKeysPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAccessKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAccessKeysIterable responses = client.listAccessKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listAccessKeysPaginator(ListAccessKeysRequest)
,
AWS API
Documentationdefault ListAccountAliasesResponse listAccountAliases() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listAccountAliases(ListAccountAliasesRequest)
,
AWS API
Documentationdefault ListAccountAliasesResponse listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listAccountAliasesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccountAliasesResponse listAccountAliases(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListAccountAliasesRequest.Builder
avoiding the
need to create one manually via ListAccountAliasesRequest.builder()
listAccountAliasesRequest
- A Consumer
that will call methods on ListAccountAliasesRequest.Builder
to create a
request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccountAliasesIterable listAccountAliasesPaginator(ListAccountAliasesRequest listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesIterable responses = client.listAccountAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAccountAliasesIterable responses = client .listAccountAliasesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesIterable responses = client.listAccountAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation.
listAccountAliasesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccountAliasesIterable listAccountAliasesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesIterable responses = client.listAccountAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAccountAliasesIterable responses = client .listAccountAliasesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesIterable responses = client.listAccountAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listAccountAliasesPaginator(ListAccountAliasesRequest)
,
AWS API
Documentationdefault ListAttachedGroupPoliciesResponse listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listAttachedGroupPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedGroupPoliciesResponse listAttachedGroupPolicies(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListAttachedGroupPoliciesRequest.Builder
avoiding
the need to create one manually via ListAttachedGroupPoliciesRequest.builder()
listAttachedGroupPoliciesRequest
- A Consumer
that will call methods on ListAttachedGroupPoliciesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedGroupPoliciesIterable listAttachedGroupPoliciesPaginator(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesIterable responses = client.listAttachedGroupPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesIterable responses = client .listAttachedGroupPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesIterable responses = client.listAttachedGroupPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation.
listAttachedGroupPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedGroupPoliciesIterable listAttachedGroupPoliciesPaginator(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesIterable responses = client.listAttachedGroupPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesIterable responses = client .listAttachedGroupPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesIterable responses = client.listAttachedGroupPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListAttachedGroupPoliciesRequest.Builder
avoiding
the need to create one manually via ListAttachedGroupPoliciesRequest.builder()
listAttachedGroupPoliciesRequest
- A Consumer
that will call methods on ListAttachedGroupPoliciesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedRolePoliciesResponse listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listAttachedRolePoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedRolePoliciesResponse listAttachedRolePolicies(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListAttachedRolePoliciesRequest.Builder
avoiding
the need to create one manually via ListAttachedRolePoliciesRequest.builder()
listAttachedRolePoliciesRequest
- A Consumer
that will call methods on ListAttachedRolePoliciesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedRolePoliciesIterable listAttachedRolePoliciesPaginator(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesIterable responses = client.listAttachedRolePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesIterable responses = client .listAttachedRolePoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesIterable responses = client.listAttachedRolePoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation.
listAttachedRolePoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedRolePoliciesIterable listAttachedRolePoliciesPaginator(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesIterable responses = client.listAttachedRolePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesIterable responses = client .listAttachedRolePoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesIterable responses = client.listAttachedRolePoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation.
This is a convenience which creates an instance of the ListAttachedRolePoliciesRequest.Builder
avoiding
the need to create one manually via ListAttachedRolePoliciesRequest.builder()
listAttachedRolePoliciesRequest
- A Consumer
that will call methods on ListAttachedRolePoliciesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedUserPoliciesResponse listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listAttachedUserPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedUserPoliciesResponse listAttachedUserPolicies(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListAttachedUserPoliciesRequest.Builder
avoiding
the need to create one manually via ListAttachedUserPoliciesRequest.builder()
listAttachedUserPoliciesRequest
- A Consumer
that will call methods on ListAttachedUserPoliciesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedUserPoliciesIterable listAttachedUserPoliciesPaginator(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesIterable responses = client.listAttachedUserPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesIterable responses = client .listAttachedUserPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesIterable responses = client.listAttachedUserPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation.
listAttachedUserPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedUserPoliciesIterable listAttachedUserPoliciesPaginator(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesIterable responses = client.listAttachedUserPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesIterable responses = client .listAttachedUserPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesIterable responses = client.listAttachedUserPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListAttachedUserPoliciesRequest.Builder
avoiding
the need to create one manually via ListAttachedUserPoliciesRequest.builder()
listAttachedUserPoliciesRequest
- A Consumer
that will call methods on ListAttachedUserPoliciesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesForPolicyResponse listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listEntitiesForPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesForPolicyResponse listEntitiesForPolicy(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListEntitiesForPolicyRequest.Builder
avoiding the
need to create one manually via ListEntitiesForPolicyRequest.builder()
listEntitiesForPolicyRequest
- A Consumer
that will call methods on ListEntitiesForPolicyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesForPolicyIterable listEntitiesForPolicyPaginator(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyIterable responses = client.listEntitiesForPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyIterable responses = client .listEntitiesForPolicyPaginator(request); for (software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyIterable responses = client.listEntitiesForPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation.
listEntitiesForPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesForPolicyIterable listEntitiesForPolicyPaginator(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyIterable responses = client.listEntitiesForPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyIterable responses = client .listEntitiesForPolicyPaginator(request); for (software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyIterable responses = client.listEntitiesForPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation.
This is a convenience which creates an instance of the ListEntitiesForPolicyRequest.Builder
avoiding the
need to create one manually via ListEntitiesForPolicyRequest.builder()
listEntitiesForPolicyRequest
- A Consumer
that will call methods on ListEntitiesForPolicyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupPoliciesResponse listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listGroupPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupPoliciesResponse listGroupPolicies(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListGroupPoliciesRequest.Builder
avoiding the need
to create one manually via ListGroupPoliciesRequest.builder()
listGroupPoliciesRequest
- A Consumer
that will call methods on ListGroupPoliciesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupPoliciesIterable listGroupPoliciesPaginator(ListGroupPoliciesRequest listGroupPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesIterable responses = client.listGroupPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesIterable responses = client .listGroupPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListGroupPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesIterable responses = client.listGroupPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation.
listGroupPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupPoliciesIterable listGroupPoliciesPaginator(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesIterable responses = client.listGroupPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesIterable responses = client .listGroupPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListGroupPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesIterable responses = client.listGroupPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListGroupPoliciesRequest.Builder
avoiding the need
to create one manually via ListGroupPoliciesRequest.builder()
listGroupPoliciesRequest
- A Consumer
that will call methods on ListGroupPoliciesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsResponse listGroups() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listGroups(ListGroupsRequest)
,
AWS API
Documentationdefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
listGroupsRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsRequest.Builder
to create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
This is a variant of listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.iam.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.
listGroupsRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsIterable listGroupsPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
This is a variant of listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.iam.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listGroupsPaginator(ListGroupsRequest)
,
AWS API
Documentationdefault ListGroupsForUserResponse listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
listGroupsForUserRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsForUserResponse listGroupsForUser(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
This is a convenience which creates an instance of the ListGroupsForUserRequest.Builder
avoiding the need
to create one manually via ListGroupsForUserRequest.builder()
listGroupsForUserRequest
- A Consumer
that will call methods on ListGroupsForUserRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsForUserIterable listGroupsForUserPaginator(ListGroupsForUserRequest listGroupsForUserRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
This is a variant of
listGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListGroupsForUserIterable responses = client.listGroupsForUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListGroupsForUserIterable responses = client .listGroupsForUserPaginator(request); for (software.amazon.awssdk.services.iam.model.ListGroupsForUserResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListGroupsForUserIterable responses = client.listGroupsForUserPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation.
listGroupsForUserRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsForUserIterable listGroupsForUserPaginator(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
This is a variant of
listGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListGroupsForUserIterable responses = client.listGroupsForUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListGroupsForUserIterable responses = client .listGroupsForUserPaginator(request); for (software.amazon.awssdk.services.iam.model.ListGroupsForUserResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListGroupsForUserIterable responses = client.listGroupsForUserPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation.
This is a convenience which creates an instance of the ListGroupsForUserRequest.Builder
avoiding the need
to create one manually via ListGroupsForUserRequest.builder()
listGroupsForUserRequest
- A Consumer
that will call methods on ListGroupsForUserRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesResponse listInstanceProfiles() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listInstanceProfiles(ListInstanceProfilesRequest)
,
AWS API
Documentationdefault ListInstanceProfilesResponse listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listInstanceProfilesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesResponse listInstanceProfiles(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListInstanceProfilesRequest.Builder
avoiding the
need to create one manually via ListInstanceProfilesRequest.builder()
listInstanceProfilesRequest
- A Consumer
that will call methods on ListInstanceProfilesRequest.Builder
to create a
request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesIterable listInstanceProfilesPaginator(ListInstanceProfilesRequest listInstanceProfilesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesIterable responses = client.listInstanceProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesIterable responses = client .listInstanceProfilesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesIterable responses = client.listInstanceProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.
listInstanceProfilesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesIterable listInstanceProfilesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesIterable responses = client.listInstanceProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesIterable responses = client .listInstanceProfilesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesIterable responses = client.listInstanceProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listInstanceProfilesPaginator(ListInstanceProfilesRequest)
,
AWS API
Documentationdefault ListInstanceProfilesForRoleResponse listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listInstanceProfilesForRoleRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesForRoleResponse listInstanceProfilesForRole(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListInstanceProfilesForRoleRequest.Builder
avoiding the need to create one manually via ListInstanceProfilesForRoleRequest.builder()
listInstanceProfilesForRoleRequest
- A Consumer
that will call methods on ListInstanceProfilesForRoleRequest.Builder
to create
a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesForRoleIterable listInstanceProfilesForRolePaginator(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRoleIterable responses = client.listInstanceProfilesForRolePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRoleIterable responses = client .listInstanceProfilesForRolePaginator(request); for (software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRoleIterable responses = client.listInstanceProfilesForRolePaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation.
listInstanceProfilesForRoleRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInstanceProfilesForRoleIterable listInstanceProfilesForRolePaginator(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRoleIterable responses = client.listInstanceProfilesForRolePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRoleIterable responses = client .listInstanceProfilesForRolePaginator(request); for (software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRoleIterable responses = client.listInstanceProfilesForRolePaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation.
This is a convenience which creates an instance of the ListInstanceProfilesForRoleRequest.Builder
avoiding the need to create one manually via ListInstanceProfilesForRoleRequest.builder()
listInstanceProfilesForRoleRequest
- A Consumer
that will call methods on ListInstanceProfilesForRoleRequest.Builder
to create
a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMFADevicesResponse listMFADevices() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listMFADevices(ListMFADevicesRequest)
,
AWS API
Documentationdefault ListMFADevicesResponse listMFADevices(ListMFADevicesRequest listMFADevicesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listMFADevicesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMFADevicesResponse listMFADevices(Consumer<ListMFADevicesRequest.Builder> listMFADevicesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListMFADevicesRequest.Builder
avoiding the need to
create one manually via ListMFADevicesRequest.builder()
listMFADevicesRequest
- A Consumer
that will call methods on ListMFADevicesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMFADevicesIterable listMFADevicesPaginator(ListMFADevicesRequest listMFADevicesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listMFADevices(software.amazon.awssdk.services.iam.model.ListMFADevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListMFADevicesIterable responses = client.listMFADevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListMFADevicesIterable responses = client.listMFADevicesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListMFADevicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListMFADevicesIterable responses = client.listMFADevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listMFADevices(software.amazon.awssdk.services.iam.model.ListMFADevicesRequest)
operation.
listMFADevicesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMFADevicesIterable listMFADevicesPaginator() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listMFADevices(software.amazon.awssdk.services.iam.model.ListMFADevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListMFADevicesIterable responses = client.listMFADevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListMFADevicesIterable responses = client.listMFADevicesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListMFADevicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListMFADevicesIterable responses = client.listMFADevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listMFADevices(software.amazon.awssdk.services.iam.model.ListMFADevicesRequest)
operation.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listMFADevicesPaginator(ListMFADevicesRequest)
,
AWS API
Documentationdefault ListOpenIDConnectProvidersResponse listOpenIDConnectProviders() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest)
,
AWS
API Documentationdefault ListOpenIDConnectProvidersResponse listOpenIDConnectProviders(ListOpenIDConnectProvidersRequest listOpenIDConnectProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
listOpenIDConnectProvidersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOpenIDConnectProvidersResponse listOpenIDConnectProviders(Consumer<ListOpenIDConnectProvidersRequest.Builder> listOpenIDConnectProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
This is a convenience which creates an instance of the ListOpenIDConnectProvidersRequest.Builder
avoiding
the need to create one manually via ListOpenIDConnectProvidersRequest.builder()
listOpenIDConnectProvidersRequest
- A Consumer
that will call methods on ListOpenIDConnectProvidersRequest.Builder
to create a
request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPoliciesResponse listPolicies() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPolicies(ListPoliciesRequest)
,
AWS API
Documentationdefault ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listPoliciesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPoliciesResponse listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListPoliciesRequest.Builder
avoiding the need to
create one manually via ListPoliciesRequest.builder()
listPoliciesRequest
- A Consumer
that will call methods on ListPoliciesRequest.Builder
to create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPoliciesIterable listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation.
listPoliciesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPoliciesIterable listPoliciesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPoliciesPaginator(ListPoliciesRequest)
,
AWS API
Documentationdefault ListPolicyVersionsResponse listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listPolicyVersionsRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPolicyVersionsResponse listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListPolicyVersionsRequest.Builder
avoiding the
need to create one manually via ListPolicyVersionsRequest.builder()
listPolicyVersionsRequest
- A Consumer
that will call methods on ListPolicyVersionsRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPolicyVersionsIterable listPolicyVersionsPaginator(ListPolicyVersionsRequest listPolicyVersionsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsIterable responses = client .listPolicyVersionsPaginator(request); for (software.amazon.awssdk.services.iam.model.ListPolicyVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation.
listPolicyVersionsRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPolicyVersionsIterable listPolicyVersionsPaginator(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsIterable responses = client .listPolicyVersionsPaginator(request); for (software.amazon.awssdk.services.iam.model.ListPolicyVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation.
This is a convenience which creates an instance of the ListPolicyVersionsRequest.Builder
avoiding the
need to create one manually via ListPolicyVersionsRequest.builder()
listPolicyVersionsRequest
- A Consumer
that will call methods on ListPolicyVersionsRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolePoliciesResponse listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listRolePoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolePoliciesResponse listRolePolicies(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListRolePoliciesRequest.Builder
avoiding the need
to create one manually via ListRolePoliciesRequest.builder()
listRolePoliciesRequest
- A Consumer
that will call methods on ListRolePoliciesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolePoliciesIterable listRolePoliciesPaginator(ListRolePoliciesRequest listRolePoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListRolePoliciesIterable responses = client.listRolePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListRolePoliciesIterable responses = client.listRolePoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListRolePoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListRolePoliciesIterable responses = client.listRolePoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation.
listRolePoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolePoliciesIterable listRolePoliciesPaginator(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListRolePoliciesIterable responses = client.listRolePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListRolePoliciesIterable responses = client.listRolePoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListRolePoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListRolePoliciesIterable responses = client.listRolePoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation.
This is a convenience which creates an instance of the ListRolePoliciesRequest.Builder
avoiding the need
to create one manually via ListRolePoliciesRequest.builder()
listRolePoliciesRequest
- A Consumer
that will call methods on ListRolePoliciesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolesResponse listRoles() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listRoles(ListRolesRequest)
,
AWS API
Documentationdefault ListRolesResponse listRoles(ListRolesRequest listRolesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listRolesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolesResponse listRoles(Consumer<ListRolesRequest.Builder> listRolesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListRolesRequest.Builder
avoiding the need to
create one manually via ListRolesRequest.builder()
listRolesRequest
- A Consumer
that will call methods on ListRolesRequest.Builder
to create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolesIterable listRolesPaginator(ListRolesRequest listRolesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListRolesIterable responses = client.listRolesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListRolesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.
listRolesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListRolesIterable listRolesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListRolesIterable responses = client.listRolesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListRolesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listRolesPaginator(ListRolesRequest)
,
AWS API
Documentationdefault ListSAMLProvidersResponse listSAMLProviders() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSAMLProviders(ListSAMLProvidersRequest)
,
AWS API
Documentationdefault ListSAMLProvidersResponse listSAMLProviders(ListSAMLProvidersRequest listSAMLProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
listSAMLProvidersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSAMLProvidersResponse listSAMLProviders(Consumer<ListSAMLProvidersRequest.Builder> listSAMLProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
This is a convenience which creates an instance of the ListSAMLProvidersRequest.Builder
avoiding the need
to create one manually via ListSAMLProvidersRequest.builder()
listSAMLProvidersRequest
- A Consumer
that will call methods on ListSAMLProvidersRequest.Builder
to create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSSHPublicKeysResponse listSSHPublicKeys() throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSSHPublicKeys(ListSSHPublicKeysRequest)
,
AWS API
Documentationdefault ListSSHPublicKeysResponse listSSHPublicKeys(ListSSHPublicKeysRequest listSSHPublicKeysRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
listSSHPublicKeysRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSSHPublicKeysResponse listSSHPublicKeys(Consumer<ListSSHPublicKeysRequest.Builder> listSSHPublicKeysRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListSSHPublicKeysRequest.Builder
avoiding the need
to create one manually via ListSSHPublicKeysRequest.builder()
listSSHPublicKeysRequest
- A Consumer
that will call methods on ListSSHPublicKeysRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSSHPublicKeysIterable listSSHPublicKeysPaginator(ListSSHPublicKeysRequest listSSHPublicKeysRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSSHPublicKeysRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysIterable responses = client.listSSHPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysIterable responses = client .listSSHPublicKeysPaginator(request); for (software.amazon.awssdk.services.iam.model.ListSSHPublicKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysIterable responses = client.listSSHPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSSHPublicKeysRequest)
operation.
listSSHPublicKeysRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSSHPublicKeysIterable listSSHPublicKeysPaginator() throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSSHPublicKeysRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysIterable responses = client.listSSHPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysIterable responses = client .listSSHPublicKeysPaginator(request); for (software.amazon.awssdk.services.iam.model.ListSSHPublicKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysIterable responses = client.listSSHPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSSHPublicKeysRequest)
operation.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSSHPublicKeysPaginator(ListSSHPublicKeysRequest)
,
AWS API
Documentationdefault ListServerCertificatesResponse listServerCertificates() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listServerCertificates(ListServerCertificatesRequest)
,
AWS API
Documentationdefault ListServerCertificatesResponse listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listServerCertificatesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServerCertificatesResponse listServerCertificates(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListServerCertificatesRequest.Builder
avoiding the
need to create one manually via ListServerCertificatesRequest.builder()
listServerCertificatesRequest
- A Consumer
that will call methods on ListServerCertificatesRequest.Builder
to create a
request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServerCertificatesIterable listServerCertificatesPaginator(ListServerCertificatesRequest listServerCertificatesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesIterable responses = client.listServerCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListServerCertificatesIterable responses = client .listServerCertificatesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesIterable responses = client.listServerCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation.
listServerCertificatesRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServerCertificatesIterable listServerCertificatesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesIterable responses = client.listServerCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListServerCertificatesIterable responses = client .listServerCertificatesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesIterable responses = client.listServerCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listServerCertificatesPaginator(ListServerCertificatesRequest)
,
AWS API
Documentationdefault ListServiceSpecificCredentialsResponse listServiceSpecificCredentials() throws NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceNotSupportedException
- The specified service does not support service-specific credentials.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest)
,
AWS API Documentationdefault ListServiceSpecificCredentialsResponse listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest listServiceSpecificCredentialsRequest) throws NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IAMException
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.
listServiceSpecificCredentialsRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceNotSupportedException
- The specified service does not support service-specific credentials.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServiceSpecificCredentialsResponse listServiceSpecificCredentials(Consumer<ListServiceSpecificCredentialsRequest.Builder> listServiceSpecificCredentialsRequest) throws NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListServiceSpecificCredentialsRequest.Builder
avoiding the need to create one manually via ListServiceSpecificCredentialsRequest.builder()
listServiceSpecificCredentialsRequest
- A Consumer
that will call methods on ListServiceSpecificCredentialsRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceNotSupportedException
- The specified service does not support service-specific credentials.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSigningCertificatesResponse listSigningCertificates() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSigningCertificates(ListSigningCertificatesRequest)
,
AWS
API Documentationdefault ListSigningCertificatesResponse listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listSigningCertificatesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSigningCertificatesResponse listSigningCertificates(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListSigningCertificatesRequest.Builder
avoiding
the need to create one manually via ListSigningCertificatesRequest.builder()
listSigningCertificatesRequest
- A Consumer
that will call methods on ListSigningCertificatesRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSigningCertificatesIterable listSigningCertificatesPaginator(ListSigningCertificatesRequest listSigningCertificatesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesIterable responses = client.listSigningCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesIterable responses = client .listSigningCertificatesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesIterable responses = client.listSigningCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation.
listSigningCertificatesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSigningCertificatesIterable listSigningCertificatesPaginator() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesIterable responses = client.listSigningCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesIterable responses = client .listSigningCertificatesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesIterable responses = client.listSigningCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation.
NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSigningCertificatesPaginator(ListSigningCertificatesRequest)
,
AWS
API Documentationdefault ListUserPoliciesResponse listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listUserPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUserPoliciesResponse listUserPolicies(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListUserPoliciesRequest.Builder
avoiding the need
to create one manually via ListUserPoliciesRequest.builder()
listUserPoliciesRequest
- A Consumer
that will call methods on ListUserPoliciesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUserPoliciesIterable listUserPoliciesPaginator(ListUserPoliciesRequest listUserPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListUserPoliciesIterable responses = client.listUserPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListUserPoliciesIterable responses = client.listUserPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListUserPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListUserPoliciesIterable responses = client.listUserPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation.
listUserPoliciesRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUserPoliciesIterable listUserPoliciesPaginator(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListUserPoliciesIterable responses = client.listUserPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListUserPoliciesIterable responses = client.listUserPoliciesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListUserPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListUserPoliciesIterable responses = client.listUserPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListUserPoliciesRequest.Builder
avoiding the need
to create one manually via ListUserPoliciesRequest.builder()
listUserPoliciesRequest
- A Consumer
that will call methods on ListUserPoliciesRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUsersResponse listUsers() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listUsers(ListUsersRequest)
,
AWS API
Documentationdefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
listUsersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.iam.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.
listUsersRequest
- ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUsersIterable listUsersPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.iam.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.
ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listUsersPaginator(ListUsersRequest)
,
AWS API
Documentationdefault ListVirtualMFADevicesResponse listVirtualMFADevices() throws AwsServiceException, SdkClientException, IAMException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listVirtualMFADevices(ListVirtualMFADevicesRequest)
,
AWS API
Documentationdefault ListVirtualMFADevicesResponse listVirtualMFADevices(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest) throws AwsServiceException, SdkClientException, IAMException
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.
listVirtualMFADevicesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListVirtualMFADevicesResponse listVirtualMFADevices(Consumer<ListVirtualMFADevicesRequest.Builder> listVirtualMFADevicesRequest) throws AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ListVirtualMFADevicesRequest.Builder
avoiding the
need to create one manually via ListVirtualMFADevicesRequest.builder()
listVirtualMFADevicesRequest
- A Consumer
that will call methods on ListVirtualMFADevicesRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListVirtualMFADevicesIterable listVirtualMFADevicesPaginator(ListVirtualMFADevicesRequest listVirtualMFADevicesRequest) throws AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesIterable responses = client.listVirtualMFADevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesIterable responses = client .listVirtualMFADevicesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesIterable responses = client.listVirtualMFADevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesRequest)
operation.
listVirtualMFADevicesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListVirtualMFADevicesIterable listVirtualMFADevicesPaginator() throws AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesIterable responses = client.listVirtualMFADevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesIterable responses = client .listVirtualMFADevicesPaginator(request); for (software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesIterable responses = client.listVirtualMFADevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listVirtualMFADevicesPaginator(ListVirtualMFADevicesRequest)
,
AWS API
Documentationdefault PutGroupPolicyResponse putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest) throws LimitExceededException, MalformedPolicyDocumentException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
putGroupPolicyRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutGroupPolicyResponse putGroupPolicy(Consumer<PutGroupPolicyRequest.Builder> putGroupPolicyRequest) throws LimitExceededException, MalformedPolicyDocumentException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the PutGroupPolicyRequest.Builder
avoiding the need to
create one manually via PutGroupPolicyRequest.builder()
putGroupPolicyRequest
- A Consumer
that will call methods on PutGroupPolicyRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutRolePolicyResponse putRolePolicy(PutRolePolicyRequest putRolePolicyRequest) throws LimitExceededException, MalformedPolicyDocumentException, NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
putRolePolicyRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutRolePolicyResponse putRolePolicy(Consumer<PutRolePolicyRequest.Builder> putRolePolicyRequest) throws LimitExceededException, MalformedPolicyDocumentException, NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the PutRolePolicyRequest.Builder
avoiding the need to
create one manually via PutRolePolicyRequest.builder()
putRolePolicyRequest
- A Consumer
that will call methods on PutRolePolicyRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutUserPolicyResponse putUserPolicy(PutUserPolicyRequest putUserPolicyRequest) throws LimitExceededException, MalformedPolicyDocumentException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
putUserPolicyRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutUserPolicyResponse putUserPolicy(Consumer<PutUserPolicyRequest.Builder> putUserPolicyRequest) throws LimitExceededException, MalformedPolicyDocumentException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the PutUserPolicyRequest.Builder
avoiding the need to
create one manually via PutUserPolicyRequest.builder()
putUserPolicyRequest
- A Consumer
that will call methods on PutUserPolicyRequest.Builder
to create a request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveClientIDFromOpenIDConnectProviderResponse removeClientIDFromOpenIDConnectProvider(RemoveClientIDFromOpenIDConnectProviderRequest removeClientIDFromOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
removeClientIDFromOpenIDConnectProviderRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveClientIDFromOpenIDConnectProviderResponse removeClientIDFromOpenIDConnectProvider(Consumer<RemoveClientIDFromOpenIDConnectProviderRequest.Builder> removeClientIDFromOpenIDConnectProviderRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the
RemoveClientIDFromOpenIDConnectProviderRequest.Builder
avoiding the need to create one manually via
RemoveClientIDFromOpenIDConnectProviderRequest.builder()
removeClientIDFromOpenIDConnectProviderRequest
- A Consumer
that will call methods on
RemoveClientIDFromOpenIDConnectProviderRequest.Builder
to create a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveRoleFromInstanceProfileResponse removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest) throws NoSuchEntityException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
removeRoleFromInstanceProfileRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveRoleFromInstanceProfileResponse removeRoleFromInstanceProfile(Consumer<RemoveRoleFromInstanceProfileRequest.Builder> removeRoleFromInstanceProfileRequest) throws NoSuchEntityException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the RemoveRoleFromInstanceProfileRequest.Builder
avoiding the need to create one manually via RemoveRoleFromInstanceProfileRequest.builder()
removeRoleFromInstanceProfileRequest
- A Consumer
that will call methods on RemoveRoleFromInstanceProfileRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveUserFromGroupResponse removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Removes the specified user from the specified group.
removeUserFromGroupRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveUserFromGroupResponse removeUserFromGroup(Consumer<RemoveUserFromGroupRequest.Builder> removeUserFromGroupRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Removes the specified user from the specified group.
This is a convenience which creates an instance of the RemoveUserFromGroupRequest.Builder
avoiding the
need to create one manually via RemoveUserFromGroupRequest.builder()
removeUserFromGroupRequest
- A Consumer
that will call methods on RemoveUserFromGroupRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetServiceSpecificCredentialResponse resetServiceSpecificCredential(ResetServiceSpecificCredentialRequest resetServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
resetServiceSpecificCredentialRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetServiceSpecificCredentialResponse resetServiceSpecificCredential(Consumer<ResetServiceSpecificCredentialRequest.Builder> resetServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ResetServiceSpecificCredentialRequest.Builder
avoiding the need to create one manually via ResetServiceSpecificCredentialRequest.builder()
resetServiceSpecificCredentialRequest
- A Consumer
that will call methods on ResetServiceSpecificCredentialRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResyncMFADeviceResponse resyncMFADevice(ResyncMFADeviceRequest resyncMFADeviceRequest) throws InvalidAuthenticationCodeException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
resyncMFADeviceRequest
- InvalidAuthenticationCodeException
- The request was rejected because the authentication code was not recognized. The error message describes
the specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResyncMFADeviceResponse resyncMFADevice(Consumer<ResyncMFADeviceRequest.Builder> resyncMFADeviceRequest) throws InvalidAuthenticationCodeException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the ResyncMFADeviceRequest.Builder
avoiding the need
to create one manually via ResyncMFADeviceRequest.builder()
resyncMFADeviceRequest
- A Consumer
that will call methods on ResyncMFADeviceRequest.Builder
to create a request.InvalidAuthenticationCodeException
- The request was rejected because the authentication code was not recognized. The error message describes
the specific error.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetDefaultPolicyVersionResponse setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
setDefaultPolicyVersionRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetDefaultPolicyVersionResponse setDefaultPolicyVersion(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the SetDefaultPolicyVersionRequest.Builder
avoiding
the need to create one manually via SetDefaultPolicyVersionRequest.builder()
setDefaultPolicyVersionRequest
- A Consumer
that will call methods on SetDefaultPolicyVersionRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulateCustomPolicyResponse simulateCustomPolicy(SimulateCustomPolicyRequest simulateCustomPolicyRequest) throws InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
simulateCustomPolicyRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulateCustomPolicyResponse simulateCustomPolicy(Consumer<SimulateCustomPolicyRequest.Builder> simulateCustomPolicyRequest) throws InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the SimulateCustomPolicyRequest.Builder
avoiding the
need to create one manually via SimulateCustomPolicyRequest.builder()
simulateCustomPolicyRequest
- A Consumer
that will call methods on SimulateCustomPolicyRequest.Builder
to create a
request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulateCustomPolicyIterable simulateCustomPolicyPaginator(SimulateCustomPolicyRequest simulateCustomPolicyRequest) throws InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
simulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyIterable responses = client.simulateCustomPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyIterable responses = client .simulateCustomPolicyPaginator(request); for (software.amazon.awssdk.services.iam.model.SimulateCustomPolicyResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyIterable responses = client.simulateCustomPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
simulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation.
simulateCustomPolicyRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulateCustomPolicyIterable simulateCustomPolicyPaginator(Consumer<SimulateCustomPolicyRequest.Builder> simulateCustomPolicyRequest) throws InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
simulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyIterable responses = client.simulateCustomPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyIterable responses = client .simulateCustomPolicyPaginator(request); for (software.amazon.awssdk.services.iam.model.SimulateCustomPolicyResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyIterable responses = client.simulateCustomPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
simulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation.
This is a convenience which creates an instance of the SimulateCustomPolicyRequest.Builder
avoiding the
need to create one manually via SimulateCustomPolicyRequest.builder()
simulateCustomPolicyRequest
- A Consumer
that will call methods on SimulateCustomPolicyRequest.Builder
to create a
request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulatePrincipalPolicyResponse simulatePrincipalPolicy(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
simulatePrincipalPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulatePrincipalPolicyResponse simulatePrincipalPolicy(Consumer<SimulatePrincipalPolicyRequest.Builder> simulatePrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the SimulatePrincipalPolicyRequest.Builder
avoiding
the need to create one manually via SimulatePrincipalPolicyRequest.builder()
simulatePrincipalPolicyRequest
- A Consumer
that will call methods on SimulatePrincipalPolicyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulatePrincipalPolicyIterable simulatePrincipalPolicyPaginator(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
simulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyIterable responses = client.simulatePrincipalPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyIterable responses = client .simulatePrincipalPolicyPaginator(request); for (software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyIterable responses = client.simulatePrincipalPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
simulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation.
simulatePrincipalPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SimulatePrincipalPolicyIterable simulatePrincipalPolicyPaginator(Consumer<SimulatePrincipalPolicyRequest.Builder> simulatePrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, PolicyEvaluationException, AwsServiceException, SdkClientException, IAMException
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.
This is a variant of
simulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyIterable responses = client.simulatePrincipalPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyIterable responses = client .simulatePrincipalPolicyPaginator(request); for (software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyIterable responses = client.simulatePrincipalPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
simulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation.
This is a convenience which creates an instance of the SimulatePrincipalPolicyRequest.Builder
avoiding
the need to create one manually via SimulatePrincipalPolicyRequest.builder()
simulatePrincipalPolicyRequest
- A Consumer
that will call methods on SimulatePrincipalPolicyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyEvaluationException
- The request failed because a provided policy could not be successfully evaluated. An additional detailed
message indicates the source of the failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAccessKeyResponse updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateAccessKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAccessKeyResponse updateAccessKey(Consumer<UpdateAccessKeyRequest.Builder> updateAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateAccessKeyRequest.Builder
avoiding the need
to create one manually via UpdateAccessKeyRequest.builder()
updateAccessKeyRequest
- A Consumer
that will call methods on UpdateAccessKeyRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAccountPasswordPolicyResponse updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateAccountPasswordPolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAccountPasswordPolicyResponse updateAccountPasswordPolicy(Consumer<UpdateAccountPasswordPolicyRequest.Builder> updateAccountPasswordPolicyRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateAccountPasswordPolicyRequest.Builder
avoiding the need to create one manually via UpdateAccountPasswordPolicyRequest.builder()
updateAccountPasswordPolicyRequest
- A Consumer
that will call methods on UpdateAccountPasswordPolicyRequest.Builder
to create
a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAssumeRolePolicyResponse updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateAssumeRolePolicyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAssumeRolePolicyResponse updateAssumeRolePolicy(Consumer<UpdateAssumeRolePolicyRequest.Builder> updateAssumeRolePolicyRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateAssumeRolePolicyRequest.Builder
avoiding the
need to create one manually via UpdateAssumeRolePolicyRequest.builder()
updateAssumeRolePolicyRequest
- A Consumer
that will call methods on UpdateAssumeRolePolicyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.MalformedPolicyDocumentException
- The request was rejected because the policy document was malformed. The error message describes the
specific error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws NoSuchEntityException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateGroupRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws NoSuchEntityException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- A Consumer
that will call methods on UpdateGroupRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateLoginProfileResponse updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateLoginProfileRequest
- EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the
account password policy.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateLoginProfileResponse updateLoginProfile(Consumer<UpdateLoginProfileRequest.Builder> updateLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateLoginProfileRequest.Builder
avoiding the
need to create one manually via UpdateLoginProfileRequest.builder()
updateLoginProfileRequest
- A Consumer
that will call methods on UpdateLoginProfileRequest.Builder
to create a
request.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.PasswordPolicyViolationException
- The request was rejected because the provided password did not meet the requirements imposed by the
account password policy.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateOpenIDConnectProviderThumbprintResponse updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest updateOpenIDConnectProviderThumbprintRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateOpenIDConnectProviderThumbprintRequest
- InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateOpenIDConnectProviderThumbprintResponse updateOpenIDConnectProviderThumbprint(Consumer<UpdateOpenIDConnectProviderThumbprintRequest.Builder> updateOpenIDConnectProviderThumbprintRequest) throws InvalidInputException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the
UpdateOpenIDConnectProviderThumbprintRequest.Builder
avoiding the need to create one manually via
UpdateOpenIDConnectProviderThumbprintRequest.builder()
updateOpenIDConnectProviderThumbprintRequest
- A Consumer
that will call methods on UpdateOpenIDConnectProviderThumbprintRequest.Builder
to create a request.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateRoleDescriptionResponse updateRoleDescription(UpdateRoleDescriptionRequest updateRoleDescriptionRequest) throws NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Modifies the description of a role.
updateRoleDescriptionRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateRoleDescriptionResponse updateRoleDescription(Consumer<UpdateRoleDescriptionRequest.Builder> updateRoleDescriptionRequest) throws NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Modifies the description of a role.
This is a convenience which creates an instance of the UpdateRoleDescriptionRequest.Builder
avoiding the
need to create one manually via UpdateRoleDescriptionRequest.builder()
updateRoleDescriptionRequest
- A Consumer
that will call methods on UpdateRoleDescriptionRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.UnmodifiableEntityException
- The request was rejected because only the service that depends on the service-linked role can modify or
delete the role on your behalf. The error message includes the name of the service that depends on this
service-linked role. You must request the change through that service.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSAMLProviderResponse updateSAMLProvider(UpdateSAMLProviderRequest updateSAMLProviderRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
updateSAMLProviderRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSAMLProviderResponse updateSAMLProvider(Consumer<UpdateSAMLProviderRequest.Builder> updateSAMLProviderRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
This is a convenience which creates an instance of the UpdateSAMLProviderRequest.Builder
avoiding the
need to create one manually via UpdateSAMLProviderRequest.builder()
updateSAMLProviderRequest
- A Consumer
that will call methods on UpdateSAMLProviderRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidInputException
- The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSSHPublicKeyResponse updateSSHPublicKey(UpdateSSHPublicKeyRequest updateSSHPublicKeyRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
updateSSHPublicKeyRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSSHPublicKeyResponse updateSSHPublicKey(Consumer<UpdateSSHPublicKeyRequest.Builder> updateSSHPublicKeyRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateSSHPublicKeyRequest.Builder
avoiding the
need to create one manually via UpdateSSHPublicKeyRequest.builder()
updateSSHPublicKeyRequest
- A Consumer
that will call methods on UpdateSSHPublicKeyRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateServerCertificateResponse updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest) throws NoSuchEntityException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateServerCertificateRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateServerCertificateResponse updateServerCertificate(Consumer<UpdateServerCertificateRequest.Builder> updateServerCertificateRequest) throws NoSuchEntityException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateServerCertificateRequest.Builder
avoiding
the need to create one manually via UpdateServerCertificateRequest.builder()
updateServerCertificateRequest
- A Consumer
that will call methods on UpdateServerCertificateRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateServiceSpecificCredentialResponse updateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest updateServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
updateServiceSpecificCredentialRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateServiceSpecificCredentialResponse updateServiceSpecificCredential(Consumer<UpdateServiceSpecificCredentialRequest.Builder> updateServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateServiceSpecificCredentialRequest.Builder
avoiding the need to create one manually via UpdateServiceSpecificCredentialRequest.builder()
updateServiceSpecificCredentialRequest
- A Consumer
that will call methods on UpdateServiceSpecificCredentialRequest.Builder
to
create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSigningCertificateResponse updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateSigningCertificateRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSigningCertificateResponse updateSigningCertificate(Consumer<UpdateSigningCertificateRequest.Builder> updateSigningCertificateRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateSigningCertificateRequest.Builder
avoiding
the need to create one manually via UpdateSigningCertificateRequest.builder()
updateSigningCertificateRequest
- A Consumer
that will call methods on UpdateSigningCertificateRequest.Builder
to create a
request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws NoSuchEntityException, LimitExceededException, EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
updateUserRequest
- NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws NoSuchEntityException, LimitExceededException, EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UpdateUserRequest.Builder
avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest
- A Consumer
that will call methods on UpdateUserRequest.Builder
to create a request.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.EntityTemporarilyUnmodifiableException
- The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user
name that was deleted and then recreated. The error indicates that the request is likely to succeed if
you try again after waiting several minutes. The error message describes the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadSSHPublicKeyResponse uploadSSHPublicKey(UploadSSHPublicKeyRequest uploadSSHPublicKeyRequest) throws LimitExceededException, NoSuchEntityException, InvalidPublicKeyException, DuplicateSSHPublicKeyException, UnrecognizedPublicKeyEncodingException, AwsServiceException, SdkClientException, IAMException
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.
uploadSSHPublicKeyRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidPublicKeyException
- The request was rejected because the public key is malformed or otherwise invalid.DuplicateSSHPublicKeyException
- The request was rejected because the SSH public key is already associated with the specified IAM user.UnrecognizedPublicKeyEncodingException
- The request was rejected because the public key encoding format is unsupported or unrecognized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadSSHPublicKeyResponse uploadSSHPublicKey(Consumer<UploadSSHPublicKeyRequest.Builder> uploadSSHPublicKeyRequest) throws LimitExceededException, NoSuchEntityException, InvalidPublicKeyException, DuplicateSSHPublicKeyException, UnrecognizedPublicKeyEncodingException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UploadSSHPublicKeyRequest.Builder
avoiding the
need to create one manually via UploadSSHPublicKeyRequest.builder()
uploadSSHPublicKeyRequest
- A Consumer
that will call methods on UploadSSHPublicKeyRequest.Builder
to create a
request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.InvalidPublicKeyException
- The request was rejected because the public key is malformed or otherwise invalid.DuplicateSSHPublicKeyException
- The request was rejected because the SSH public key is already associated with the specified IAM user.UnrecognizedPublicKeyEncodingException
- The request was rejected because the public key encoding format is unsupported or unrecognized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadServerCertificateResponse uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest) throws LimitExceededException, EntityAlreadyExistsException, MalformedCertificateException, KeyPairMismatchException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
uploadServerCertificateRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedCertificateException
- The request was rejected because the certificate was malformed or expired. The error message describes
the specific error.KeyPairMismatchException
- The request was rejected because the public key certificate and the private key do not match.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadServerCertificateResponse uploadServerCertificate(Consumer<UploadServerCertificateRequest.Builder> uploadServerCertificateRequest) throws LimitExceededException, EntityAlreadyExistsException, MalformedCertificateException, KeyPairMismatchException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UploadServerCertificateRequest.Builder
avoiding
the need to create one manually via UploadServerCertificateRequest.builder()
uploadServerCertificateRequest
- A Consumer
that will call methods on UploadServerCertificateRequest.Builder
to create a
request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedCertificateException
- The request was rejected because the certificate was malformed or expired. The error message describes
the specific error.KeyPairMismatchException
- The request was rejected because the public key certificate and the private key do not match.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadSigningCertificateResponse uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest) throws LimitExceededException, EntityAlreadyExistsException, MalformedCertificateException, InvalidCertificateException, DuplicateCertificateException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
uploadSigningCertificateRequest
- LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedCertificateException
- The request was rejected because the certificate was malformed or expired. The error message describes
the specific error.InvalidCertificateException
- The request was rejected because the certificate is invalid.DuplicateCertificateException
- The request was rejected because the same certificate is associated with an IAM user in the account.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadSigningCertificateResponse uploadSigningCertificate(Consumer<UploadSigningCertificateRequest.Builder> uploadSigningCertificateRequest) throws LimitExceededException, EntityAlreadyExistsException, MalformedCertificateException, InvalidCertificateException, DuplicateCertificateException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IAMException
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.
This is a convenience which creates an instance of the UploadSigningCertificateRequest.Builder
avoiding
the need to create one manually via UploadSigningCertificateRequest.builder()
uploadSigningCertificateRequest
- A Consumer
that will call methods on UploadSigningCertificateRequest.Builder
to create a
request.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error message describes the limit exceeded.EntityAlreadyExistsException
- The request was rejected because it attempted to create a resource that already exists.MalformedCertificateException
- The request was rejected because the certificate was malformed or expired. The error message describes
the specific error.InvalidCertificateException
- The request was rejected because the certificate is invalid.DuplicateCertificateException
- The request was rejected because the same certificate is associated with an IAM user in the account.NoSuchEntityException
- The request was rejected because it referenced an entity that does not exist. The error message describes
the entity.ServiceFailureException
- The request processing has failed because of an unknown error, exception or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IAMException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.