@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IamClient extends AwsClient
builder() method.
Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
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 operation.
|
default ChangePasswordResponse |
changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest)
Changes the password of the IAM user who is calling this operation.
|
default CreateAccessKeyResponse |
createAccessKey()
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the
specified user.
|
default CreateAccessKeyResponse |
createAccessKey(Consumer<CreateAccessKeyRequest.Builder> createAccessKeyRequest)
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the
specified user.
|
default CreateAccessKeyResponse |
createAccessKey(CreateAccessKeyRequest createAccessKeyRequest)
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the
specified user.
|
default CreateAccountAliasResponse |
createAccountAlias(Consumer<CreateAccountAliasRequest.Builder> createAccountAliasRequest)
Creates an alias for your Amazon Web Services account.
|
default CreateAccountAliasResponse |
createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest)
Creates an alias for your Amazon Web Services 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 IAM user.
|
default CreateLoginProfileResponse |
createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest)
Creates a password for the specified IAM user.
|
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 Amazon Web Services account.
|
default CreatePolicyResponse |
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates a new managed policy for your Amazon Web Services 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 Amazon Web Services account.
|
default CreateRoleResponse |
createRole(CreateRoleRequest createRoleRequest)
Creates a new role for your Amazon Web Services 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 Amazon Web Services service.
|
default CreateServiceLinkedRoleResponse |
createServiceLinkedRole(CreateServiceLinkedRoleRequest createServiceLinkedRoleRequest)
Creates an IAM role that is linked to a specific Amazon Web Services 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 Amazon Web Services account.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a new IAM user for your Amazon Web Services account.
|
default CreateVirtualMfaDeviceResponse |
createVirtualMFADevice(Consumer<CreateVirtualMfaDeviceRequest.Builder> createVirtualMfaDeviceRequest)
Creates a new virtual MFA device for the Amazon Web Services account.
|
default CreateVirtualMfaDeviceResponse |
createVirtualMFADevice(CreateVirtualMfaDeviceRequest createVirtualMfaDeviceRequest)
Creates a new virtual MFA device for the Amazon Web Services 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 Amazon Web Services account alias.
|
default DeleteAccountAliasResponse |
deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest)
Deletes the specified Amazon Web Services account alias.
|
default DeleteAccountPasswordPolicyResponse |
deleteAccountPasswordPolicy()
Deletes the password policy for the Amazon Web Services account.
|
default DeleteAccountPasswordPolicyResponse |
deleteAccountPasswordPolicy(Consumer<DeleteAccountPasswordPolicyRequest.Builder> deleteAccountPasswordPolicyRequest)
Deletes the password policy for the Amazon Web Services account.
|
default DeleteAccountPasswordPolicyResponse |
deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest)
Deletes the password policy for the Amazon Web Services 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, For more information, see Managing
passwords for IAM users.
|
default DeleteLoginProfileResponse |
deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest)
Deletes the password for the specified IAM user, For more information, see Managing
passwords for IAM users.
|
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 DeleteRolePermissionsBoundaryResponse |
deleteRolePermissionsBoundary(Consumer<DeleteRolePermissionsBoundaryRequest.Builder> deleteRolePermissionsBoundaryRequest)
Deletes the permissions boundary for the specified IAM role.
|
default DeleteRolePermissionsBoundaryResponse |
deleteRolePermissionsBoundary(DeleteRolePermissionsBoundaryRequest deleteRolePermissionsBoundaryRequest)
Deletes the permissions boundary for the specified IAM 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 DeleteUserPermissionsBoundaryResponse |
deleteUserPermissionsBoundary(Consumer<DeleteUserPermissionsBoundaryRequest.Builder> deleteUserPermissionsBoundaryRequest)
Deletes the permissions boundary for the specified IAM user.
|
default DeleteUserPermissionsBoundaryResponse |
deleteUserPermissionsBoundary(DeleteUserPermissionsBoundaryRequest deleteUserPermissionsBoundaryRequest)
Deletes the permissions boundary for 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 Amazon Web Services account.
|
default GenerateCredentialReportResponse |
generateCredentialReport(Consumer<GenerateCredentialReportRequest.Builder> generateCredentialReportRequest)
Generates a credential report for the Amazon Web Services account.
|
default GenerateCredentialReportResponse |
generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest)
Generates a credential report for the Amazon Web Services account.
|
default GenerateOrganizationsAccessReportResponse |
generateOrganizationsAccessReport(Consumer<GenerateOrganizationsAccessReportRequest.Builder> generateOrganizationsAccessReportRequest)
Generates a report for service last accessed data for Organizations.
|
default GenerateOrganizationsAccessReportResponse |
generateOrganizationsAccessReport(GenerateOrganizationsAccessReportRequest generateOrganizationsAccessReportRequest)
Generates a report for service last accessed data for Organizations.
|
default GenerateServiceLastAccessedDetailsResponse |
generateServiceLastAccessedDetails(Consumer<GenerateServiceLastAccessedDetailsRequest.Builder> generateServiceLastAccessedDetailsRequest)
Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used
in an attempt to access Amazon Web Services services.
|
default GenerateServiceLastAccessedDetailsResponse |
generateServiceLastAccessedDetails(GenerateServiceLastAccessedDetailsRequest generateServiceLastAccessedDetailsRequest)
Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used
in an attempt to access Amazon Web Services services.
|
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 Amazon Web Services 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 Amazon Web Services account,
including their relationships to one another.
|
default GetAccountAuthorizationDetailsResponse |
getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account,
including their relationships to one another.
|
default GetAccountAuthorizationDetailsIterable |
getAccountAuthorizationDetailsPaginator()
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account,
including their relationships to one another.
|
default GetAccountAuthorizationDetailsIterable |
getAccountAuthorizationDetailsPaginator(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account,
including their relationships to one another.
|
default GetAccountAuthorizationDetailsIterable |
getAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest)
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account,
including their relationships to one another.
|
default GetAccountPasswordPolicyResponse |
getAccountPasswordPolicy()
Retrieves the password policy for the Amazon Web Services account.
|
default GetAccountPasswordPolicyResponse |
getAccountPasswordPolicy(Consumer<GetAccountPasswordPolicyRequest.Builder> getAccountPasswordPolicyRequest)
Retrieves the password policy for the Amazon Web Services account.
|
default GetAccountPasswordPolicyResponse |
getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest)
Retrieves the password policy for the Amazon Web Services account.
|
default GetAccountSummaryResponse |
getAccountSummary()
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
|
default GetAccountSummaryResponse |
getAccountSummary(Consumer<GetAccountSummaryRequest.Builder> getAccountSummaryRequest)
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
|
default GetAccountSummaryResponse |
getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest)
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services 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 the IAM policies that are attached to the specified IAM
entity.
|
default GetContextKeysForPrincipalPolicyResponse |
getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest)
Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM
entity.
|
default GetCredentialReportResponse |
getCredentialReport()
Retrieves a credential report for the Amazon Web Services account.
|
default GetCredentialReportResponse |
getCredentialReport(Consumer<GetCredentialReportRequest.Builder> getCredentialReportRequest)
Retrieves a credential report for the Amazon Web Services account.
|
default GetCredentialReportResponse |
getCredentialReport(GetCredentialReportRequest getCredentialReportRequest)
Retrieves a credential report for the Amazon Web Services 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 for the specified IAM user.
|
default GetLoginProfileResponse |
getLoginProfile(GetLoginProfileRequest getLoginProfileRequest)
Retrieves the user name for the specified IAM user.
|
default GetMfaDeviceResponse |
getMFADevice(Consumer<GetMfaDeviceRequest.Builder> getMfaDeviceRequest)
Retrieves information about an MFA device for a specified user.
|
default GetMfaDeviceResponse |
getMFADevice(GetMfaDeviceRequest getMfaDeviceRequest)
Retrieves information about an MFA device for a specified 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 GetOrganizationsAccessReportResponse |
getOrganizationsAccessReport(Consumer<GetOrganizationsAccessReportRequest.Builder> getOrganizationsAccessReportRequest)
Retrieves the service last accessed data report for Organizations that was previously generated using the
GenerateOrganizationsAccessReport operation. |
default GetOrganizationsAccessReportResponse |
getOrganizationsAccessReport(GetOrganizationsAccessReportRequest getOrganizationsAccessReportRequest)
Retrieves the service last accessed data report for Organizations that was previously generated using the
GenerateOrganizationsAccessReport operation. |
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 GetServiceLastAccessedDetailsResponse |
getServiceLastAccessedDetails(Consumer<GetServiceLastAccessedDetailsRequest.Builder> getServiceLastAccessedDetailsRequest)
Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails operation. |
default GetServiceLastAccessedDetailsResponse |
getServiceLastAccessedDetails(GetServiceLastAccessedDetailsRequest getServiceLastAccessedDetailsRequest)
Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails operation. |
default GetServiceLastAccessedDetailsWithEntitiesResponse |
getServiceLastAccessedDetailsWithEntities(Consumer<GetServiceLastAccessedDetailsWithEntitiesRequest.Builder> getServiceLastAccessedDetailsWithEntitiesRequest)
After you generate a group or policy report using the
GenerateServiceLastAccessedDetails operation,
you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. |
default GetServiceLastAccessedDetailsWithEntitiesResponse |
getServiceLastAccessedDetailsWithEntities(GetServiceLastAccessedDetailsWithEntitiesRequest getServiceLastAccessedDetailsWithEntitiesRequest)
After you generate a group or policy report using the
GenerateServiceLastAccessedDetails operation,
you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. |
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(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest)
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 Amazon Web Services account (Note: you can have only one).
|
default ListAccountAliasesResponse |
listAccountAliases(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest)
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).
|
default ListAccountAliasesResponse |
listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).
|
default ListAccountAliasesIterable |
listAccountAliasesPaginator()
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).
|
default ListAccountAliasesIterable |
listAccountAliasesPaginator(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest)
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).
|
default ListAccountAliasesIterable |
listAccountAliasesPaginator(ListAccountAliasesRequest listAccountAliasesRequest)
Lists the account alias associated with the Amazon Web Services 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(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest)
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 ListInstanceProfileTagsResponse |
listInstanceProfileTags(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest)
Lists the tags that are attached to the specified IAM instance profile.
|
default ListInstanceProfileTagsResponse |
listInstanceProfileTags(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest)
Lists the tags that are attached to the specified IAM instance profile.
|
default ListInstanceProfileTagsIterable |
listInstanceProfileTagsPaginator(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest)
Lists the tags that are attached to the specified IAM instance profile.
|
default ListInstanceProfileTagsIterable |
listInstanceProfileTagsPaginator(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest)
Lists the tags that are attached to the specified IAM instance profile.
|
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(Consumer<ListMfaDevicesRequest.Builder> listMfaDevicesRequest)
Lists the MFA devices for an IAM user.
|
default ListMFADevicesIterable |
listMFADevicesPaginator(ListMfaDevicesRequest listMfaDevicesRequest)
Lists the MFA devices for an IAM user.
|
default ListMfaDeviceTagsResponse |
listMFADeviceTags(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest)
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.
|
default ListMfaDeviceTagsResponse |
listMFADeviceTags(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest)
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.
|
default ListMFADeviceTagsIterable |
listMFADeviceTagsPaginator(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest)
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.
|
default ListMFADeviceTagsIterable |
listMFADeviceTagsPaginator(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest)
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.
|
default ListOpenIdConnectProvidersResponse |
listOpenIDConnectProviders()
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web
Services account.
|
default ListOpenIdConnectProvidersResponse |
listOpenIDConnectProviders(Consumer<ListOpenIdConnectProvidersRequest.Builder> listOpenIdConnectProvidersRequest)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web
Services account.
|
default ListOpenIdConnectProvidersResponse |
listOpenIDConnectProviders(ListOpenIdConnectProvidersRequest listOpenIdConnectProvidersRequest)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web
Services account.
|
default ListOpenIdConnectProviderTagsResponse |
listOpenIDConnectProviderTags(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest)
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.
|
default ListOpenIdConnectProviderTagsResponse |
listOpenIDConnectProviderTags(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest)
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.
|
default ListOpenIDConnectProviderTagsIterable |
listOpenIDConnectProviderTagsPaginator(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest)
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.
|
default ListOpenIDConnectProviderTagsIterable |
listOpenIDConnectProviderTagsPaginator(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest)
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.
|
default ListPoliciesResponse |
listPolicies()
Lists all the managed policies that are available in your Amazon Web Services account, including your own
customer-defined managed policies and all Amazon Web Services managed policies.
|
default ListPoliciesResponse |
listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)
Lists all the managed policies that are available in your Amazon Web Services account, including your own
customer-defined managed policies and all Amazon Web Services managed policies.
|
default ListPoliciesResponse |
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available in your Amazon Web Services account, including your own
customer-defined managed policies and all Amazon Web Services managed policies.
|
default ListPoliciesGrantingServiceAccessResponse |
listPoliciesGrantingServiceAccess(Consumer<ListPoliciesGrantingServiceAccessRequest.Builder> listPoliciesGrantingServiceAccessRequest)
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified
service.
|
default ListPoliciesGrantingServiceAccessResponse |
listPoliciesGrantingServiceAccess(ListPoliciesGrantingServiceAccessRequest listPoliciesGrantingServiceAccessRequest)
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified
service.
|
default ListPoliciesIterable |
listPoliciesPaginator()
Lists all the managed policies that are available in your Amazon Web Services account, including your own
customer-defined managed policies and all Amazon Web Services managed policies.
|
default ListPoliciesIterable |
listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)
Lists all the managed policies that are available in your Amazon Web Services account, including your own
customer-defined managed policies and all Amazon Web Services managed policies.
|
default ListPoliciesIterable |
listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest)
Lists all the managed policies that are available in your Amazon Web Services account, including your own
customer-defined managed policies and all Amazon Web Services managed policies.
|
default ListPolicyTagsResponse |
listPolicyTags(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest)
Lists the tags that are attached to the specified IAM customer managed policy.
|
default ListPolicyTagsResponse |
listPolicyTags(ListPolicyTagsRequest listPolicyTagsRequest)
Lists the tags that are attached to the specified IAM customer managed policy.
|
default ListPolicyTagsIterable |
listPolicyTagsPaginator(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest)
Lists the tags that are attached to the specified IAM customer managed policy.
|
default ListPolicyTagsIterable |
listPolicyTagsPaginator(ListPolicyTagsRequest listPolicyTagsRequest)
Lists the tags that are attached to the specified IAM customer managed policy.
|
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(Consumer<ListRolesRequest.Builder> listRolesRequest)
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 ListRoleTagsResponse |
listRoleTags(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest)
Lists the tags that are attached to the specified role.
|
default ListRoleTagsResponse |
listRoleTags(ListRoleTagsRequest listRoleTagsRequest)
Lists the tags that are attached to the specified role.
|
default ListRoleTagsIterable |
listRoleTagsPaginator(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest)
Lists the tags that are attached to the specified role.
|
default ListRoleTagsIterable |
listRoleTagsPaginator(ListRoleTagsRequest listRoleTagsRequest)
Lists the tags that are attached to the specified role.
|
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 ListSamlProviderTagsResponse |
listSAMLProviderTags(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest)
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.
|
default ListSamlProviderTagsResponse |
listSAMLProviderTags(ListSamlProviderTagsRequest listSamlProviderTagsRequest)
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.
|
default ListSAMLProviderTagsIterable |
listSAMLProviderTagsPaginator(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest)
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.
|
default ListSAMLProviderTagsIterable |
listSAMLProviderTagsPaginator(ListSamlProviderTagsRequest listSamlProviderTagsRequest)
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.
|
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(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest)
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 ListServerCertificateTagsResponse |
listServerCertificateTags(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest)
Lists the tags that are attached to the specified IAM server certificate.
|
default ListServerCertificateTagsResponse |
listServerCertificateTags(ListServerCertificateTagsRequest listServerCertificateTagsRequest)
Lists the tags that are attached to the specified IAM server certificate.
|
default ListServerCertificateTagsIterable |
listServerCertificateTagsPaginator(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest)
Lists the tags that are attached to the specified IAM server certificate.
|
default ListServerCertificateTagsIterable |
listServerCertificateTagsPaginator(ListServerCertificateTagsRequest listServerCertificateTagsRequest)
Lists the tags that are attached to the specified IAM server certificate.
|
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(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest)
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(Consumer<ListSshPublicKeysRequest.Builder> listSshPublicKeysRequest)
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(Consumer<ListUsersRequest.Builder> listUsersRequest)
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 ListUserTagsResponse |
listUserTags(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest)
Lists the tags that are attached to the specified IAM user.
|
default ListUserTagsResponse |
listUserTags(ListUserTagsRequest listUserTagsRequest)
Lists the tags that are attached to the specified IAM user.
|
default ListUserTagsIterable |
listUserTagsPaginator(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest)
Lists the tags that are attached to the specified IAM user.
|
default ListUserTagsIterable |
listUserTagsPaginator(ListUserTagsRequest listUserTagsRequest)
Lists the tags that are attached to the specified IAM user.
|
default ListVirtualMfaDevicesResponse |
listVirtualMFADevices()
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
|
default ListVirtualMfaDevicesResponse |
listVirtualMFADevices(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest)
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
|
default ListVirtualMfaDevicesResponse |
listVirtualMFADevices(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest)
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
|
default ListVirtualMFADevicesIterable |
listVirtualMFADevicesPaginator()
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
|
default ListVirtualMFADevicesIterable |
listVirtualMFADevicesPaginator(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest)
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
|
default ListVirtualMFADevicesIterable |
listVirtualMFADevicesPaginator(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest)
Lists the virtual MFA devices defined in the Amazon Web Services 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 PutRolePermissionsBoundaryResponse |
putRolePermissionsBoundary(Consumer<PutRolePermissionsBoundaryRequest.Builder> putRolePermissionsBoundaryRequest)
Adds or updates the policy that is specified as the IAM role's permissions boundary.
|
default PutRolePermissionsBoundaryResponse |
putRolePermissionsBoundary(PutRolePermissionsBoundaryRequest putRolePermissionsBoundaryRequest)
Adds or updates the policy that is specified as the IAM role's permissions boundary.
|
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 PutUserPermissionsBoundaryResponse |
putUserPermissionsBoundary(Consumer<PutUserPermissionsBoundaryRequest.Builder> putUserPermissionsBoundaryRequest)
Adds or updates the policy that is specified as the IAM user's permissions boundary.
|
default PutUserPermissionsBoundaryResponse |
putUserPermissionsBoundary(PutUserPermissionsBoundaryRequest putUserPermissionsBoundaryRequest)
Adds or updates the policy that is specified as the IAM user's permissions boundary.
|
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 Amazon Web Services servers.
|
default ResyncMfaDeviceResponse |
resyncMFADevice(ResyncMfaDeviceRequest resyncMfaDeviceRequest)
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
|
default IamServiceClientConfiguration |
serviceClientConfiguration() |
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 SetSecurityTokenServicePreferencesResponse |
setSecurityTokenServicePreferences(Consumer<SetSecurityTokenServicePreferencesRequest.Builder> setSecurityTokenServicePreferencesRequest)
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services
account.
|
default SetSecurityTokenServicePreferencesResponse |
setSecurityTokenServicePreferences(SetSecurityTokenServicePreferencesRequest setSecurityTokenServicePreferencesRequest)
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services
account.
|
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 operations and
Amazon Web Services 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 operations and
Amazon Web Services 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 operations and
Amazon Web Services 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 operations and
Amazon Web Services 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 operations and Amazon Web
Services 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 operations and Amazon Web
Services 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 operations and Amazon Web
Services 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 operations and Amazon Web
Services resources to determine the policies' effective permissions.
|
default TagInstanceProfileResponse |
tagInstanceProfile(Consumer<TagInstanceProfileRequest.Builder> tagInstanceProfileRequest)
Adds one or more tags to an IAM instance profile.
|
default TagInstanceProfileResponse |
tagInstanceProfile(TagInstanceProfileRequest tagInstanceProfileRequest)
Adds one or more tags to an IAM instance profile.
|
default TagMfaDeviceResponse |
tagMFADevice(Consumer<TagMfaDeviceRequest.Builder> tagMfaDeviceRequest)
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device.
|
default TagMfaDeviceResponse |
tagMFADevice(TagMfaDeviceRequest tagMfaDeviceRequest)
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device.
|
default TagOpenIdConnectProviderResponse |
tagOpenIDConnectProvider(Consumer<TagOpenIdConnectProviderRequest.Builder> tagOpenIdConnectProviderRequest)
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider.
|
default TagOpenIdConnectProviderResponse |
tagOpenIDConnectProvider(TagOpenIdConnectProviderRequest tagOpenIdConnectProviderRequest)
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider.
|
default TagPolicyResponse |
tagPolicy(Consumer<TagPolicyRequest.Builder> tagPolicyRequest)
Adds one or more tags to an IAM customer managed policy.
|
default TagPolicyResponse |
tagPolicy(TagPolicyRequest tagPolicyRequest)
Adds one or more tags to an IAM customer managed policy.
|
default TagRoleResponse |
tagRole(Consumer<TagRoleRequest.Builder> tagRoleRequest)
Adds one or more tags to an IAM role.
|
default TagRoleResponse |
tagRole(TagRoleRequest tagRoleRequest)
Adds one or more tags to an IAM role.
|
default TagSamlProviderResponse |
tagSAMLProvider(Consumer<TagSamlProviderRequest.Builder> tagSamlProviderRequest)
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.
|
default TagSamlProviderResponse |
tagSAMLProvider(TagSamlProviderRequest tagSamlProviderRequest)
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.
|
default TagServerCertificateResponse |
tagServerCertificate(Consumer<TagServerCertificateRequest.Builder> tagServerCertificateRequest)
Adds one or more tags to an IAM server certificate.
|
default TagServerCertificateResponse |
tagServerCertificate(TagServerCertificateRequest tagServerCertificateRequest)
Adds one or more tags to an IAM server certificate.
|
default TagUserResponse |
tagUser(Consumer<TagUserRequest.Builder> tagUserRequest)
Adds one or more tags to an IAM user.
|
default TagUserResponse |
tagUser(TagUserRequest tagUserRequest)
Adds one or more tags to an IAM user.
|
default UntagInstanceProfileResponse |
untagInstanceProfile(Consumer<UntagInstanceProfileRequest.Builder> untagInstanceProfileRequest)
Removes the specified tags from the IAM instance profile.
|
default UntagInstanceProfileResponse |
untagInstanceProfile(UntagInstanceProfileRequest untagInstanceProfileRequest)
Removes the specified tags from the IAM instance profile.
|
default UntagMfaDeviceResponse |
untagMFADevice(Consumer<UntagMfaDeviceRequest.Builder> untagMfaDeviceRequest)
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.
|
default UntagMfaDeviceResponse |
untagMFADevice(UntagMfaDeviceRequest untagMfaDeviceRequest)
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.
|
default UntagOpenIdConnectProviderResponse |
untagOpenIDConnectProvider(Consumer<UntagOpenIdConnectProviderRequest.Builder> untagOpenIdConnectProviderRequest)
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM.
|
default UntagOpenIdConnectProviderResponse |
untagOpenIDConnectProvider(UntagOpenIdConnectProviderRequest untagOpenIdConnectProviderRequest)
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM.
|
default UntagPolicyResponse |
untagPolicy(Consumer<UntagPolicyRequest.Builder> untagPolicyRequest)
Removes the specified tags from the customer managed policy.
|
default UntagPolicyResponse |
untagPolicy(UntagPolicyRequest untagPolicyRequest)
Removes the specified tags from the customer managed policy.
|
default UntagRoleResponse |
untagRole(Consumer<UntagRoleRequest.Builder> untagRoleRequest)
Removes the specified tags from the role.
|
default UntagRoleResponse |
untagRole(UntagRoleRequest untagRoleRequest)
Removes the specified tags from the role.
|
default UntagSamlProviderResponse |
untagSAMLProvider(Consumer<UntagSamlProviderRequest.Builder> untagSamlProviderRequest)
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM.
|
default UntagSamlProviderResponse |
untagSAMLProvider(UntagSamlProviderRequest untagSamlProviderRequest)
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM.
|
default UntagServerCertificateResponse |
untagServerCertificate(Consumer<UntagServerCertificateRequest.Builder> untagServerCertificateRequest)
Removes the specified tags from the IAM server certificate.
|
default UntagServerCertificateResponse |
untagServerCertificate(UntagServerCertificateRequest untagServerCertificateRequest)
Removes the specified tags from the IAM server certificate.
|
default UntagUserResponse |
untagUser(Consumer<UntagUserRequest.Builder> untagUserRequest)
Removes the specified tags from the user.
|
default UntagUserResponse |
untagUser(UntagUserRequest untagUserRequest)
Removes the specified tags from the user.
|
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()
Updates the password policy settings for the Amazon Web Services account.
|
default UpdateAccountPasswordPolicyResponse |
updateAccountPasswordPolicy(Consumer<UpdateAccountPasswordPolicyRequest.Builder> updateAccountPasswordPolicyRequest)
Updates the password policy settings for the Amazon Web Services account.
|
default UpdateAccountPasswordPolicyResponse |
updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest)
Updates the password policy settings for the Amazon Web Services 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 UpdateRoleResponse |
updateRole(Consumer<UpdateRoleRequest.Builder> updateRoleRequest)
Updates the description or maximum session duration setting of a role.
|
default UpdateRoleResponse |
updateRole(UpdateRoleRequest updateRoleRequest)
Updates the description or maximum session duration setting of a role.
|
default UpdateRoleDescriptionResponse |
updateRoleDescription(Consumer<UpdateRoleDescriptionRequest.Builder> updateRoleDescriptionRequest)
Use UpdateRole instead.
|
default UpdateRoleDescriptionResponse |
updateRoleDescription(UpdateRoleDescriptionRequest updateRoleDescriptionRequest)
Use UpdateRole instead.
|
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 Amazon Web Services account.
|
default UploadServerCertificateResponse |
uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest)
Uploads a server certificate entity for the Amazon Web Services 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.
|
default IamWaiter |
waiter()
Create an instance of
IamWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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 operation 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.
The caller of this operation must be granted the PassRole permission on the IAM role by a
permissions policy.
For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
addRoleToInstanceProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.
The caller of this operation must be granted the PassRole permission on the IAM role by a
permissions policy.
For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy
.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 Amazon Web Services 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.AwsServiceExceptiondefault 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 operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy
.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 Amazon Web Services 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.AwsServiceExceptiondefault 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 operation 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.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
attachRolePolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 service-linked roles are protected Amazon Web Services resources. 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 Amazon Web Services 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.AwsServiceExceptiondefault 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 operation 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.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 service-linked roles are protected Amazon Web Services resources. 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 Amazon Web Services 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.AwsServiceExceptiondefault 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 operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy
.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 Amazon Web Services 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.AwsServiceExceptiondefault 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 operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy
.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 Amazon Web Services 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.AwsServiceExceptiondefault 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 operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.
Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.
changePasswordRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.
Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault CreateAccessKeyResponse createAccessKey(CreateAccessKeyRequest createAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.
For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.
To ensure the security of your Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault CreateAccessKeyResponse createAccessKey(Consumer<CreateAccessKeyRequest.Builder> createAccessKeyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.
For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.
To ensure the security of your Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault CreateAccessKeyResponse createAccessKey() throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.
For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.
To ensure the security of your Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptioncreateAccessKey(CreateAccessKeyRequest),
AWS API
Documentationdefault CreateAccountAliasResponse createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest) throws ConcurrentModificationException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.
createAccountAliasRequest - ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.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 Amazon Web Services
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.AwsServiceExceptiondefault CreateAccountAliasResponse createAccountAlias(Consumer<CreateAccountAliasRequest.Builder> createAccountAliasRequest) throws ConcurrentModificationException, EntityAlreadyExistsException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 IAM and STS quotas in the IAM User Guide.
createGroupRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 IAM and STS quotas 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 Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstanceProfileResponse createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest) throws EntityAlreadyExistsException, InvalidInputException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
createInstanceProfileRequest - EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstanceProfileResponse createInstanceProfile(Consumer<CreateInstanceProfileRequest.Builder> createInstanceProfileRequest) throws EntityAlreadyExistsException, InvalidInputException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas 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.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLoginProfileResponse createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest) throws EntityAlreadyExistsException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault CreateLoginProfileResponse createLoginProfile(Consumer<CreateLoginProfileRequest.Builder> createLoginProfileRequest) throws EntityAlreadyExistsException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault CreateOpenIdConnectProviderResponse createOpenIDConnectProvider(CreateOpenIdConnectProviderRequest createOpenIdConnectProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ConcurrentModificationException, 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. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
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 allowed to authenticate using the OIDC provider
A list of tags that are attached to the specified IAM OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation 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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateOpenIdConnectProviderResponse createOpenIDConnectProvider(Consumer<CreateOpenIdConnectProviderRequest.Builder> createOpenIdConnectProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ConcurrentModificationException, 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. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
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 allowed to authenticate using the OIDC provider
A list of tags that are attached to the specified IAM OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation 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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePolicyResponse createPolicy(CreatePolicyRequest createPolicyRequest) throws InvalidInputException, LimitExceededException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new managed policy for your Amazon Web Services 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.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM 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 Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePolicyResponse createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) throws InvalidInputException, LimitExceededException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new managed policy for your Amazon Web Services 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.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM 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 Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault CreateRoleResponse createRole(CreateRoleRequest createRoleRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new role for your Amazon Web Services account.
For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide.
createRoleRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRoleResponse createRole(Consumer<CreateRoleRequest.Builder> createRoleRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, MalformedPolicyDocumentException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new role for your Amazon Web Services account.
For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas 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 Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSamlProviderResponse createSAMLProvider(CreateSamlProviderRequest createSamlProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ConcurrentModificationException, 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. Such a policy can 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 Amazon Web Services Management Console or one that supports API access to Amazon Web Services.
When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document 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 Amazon Web Services 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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSamlProviderResponse createSAMLProvider(Consumer<CreateSamlProviderRequest.Builder> createSamlProviderRequest) throws InvalidInputException, EntityAlreadyExistsException, LimitExceededException, ConcurrentModificationException, 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. Such a policy can 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 Amazon Web Services Management Console or one that supports API access to Amazon Web Services.
When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document 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 Amazon Web Services 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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateServiceLinkedRoleResponse createServiceLinkedRole(CreateServiceLinkedRoleRequest createServiceLinkedRoleRequest) throws InvalidInputException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates an IAM role that is linked to a specific Amazon Web Services 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 Amazon Web Services 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. For more information, see Using service-linked roles in the IAM User Guide.
To attach a policy to this service-linked role, you must make the request using the Amazon Web Services 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateServiceLinkedRoleResponse createServiceLinkedRole(Consumer<CreateServiceLinkedRoleRequest.Builder> createServiceLinkedRoleRequest) throws InvalidInputException, LimitExceededException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates an IAM role that is linked to a specific Amazon Web Services 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 Amazon Web Services 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. For more information, see Using service-linked roles in the IAM User Guide.
To attach a policy to this service-linked role, you must make the request using the Amazon Web Services 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
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 CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.
createServiceSpecificCredentialRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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.
You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
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 CodeCommit: Git credentials, SSH keys, and Amazon Web Services 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws LimitExceededException, EntityAlreadyExistsException, NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new IAM user for your Amazon Web Services account.
For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.
createUserRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws LimitExceededException, EntityAlreadyExistsException, NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new IAM user for your Amazon Web Services account.
For information about quotas for the number of IAM users you can create, see IAM and STS quotas 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 Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateVirtualMfaDeviceResponse createVirtualMFADevice(CreateVirtualMfaDeviceRequest createVirtualMfaDeviceRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new virtual MFA device for the Amazon Web Services 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, see Using a virtual MFA device in the IAM User Guide.
For information about the maximum number of MFA devices you can create, see IAM and STS quotas 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. In other words, protect the seed information as you would your Amazon Web Services 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 Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateVirtualMfaDeviceResponse createVirtualMFADevice(Consumer<CreateVirtualMfaDeviceRequest.Builder> createVirtualMfaDeviceRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Creates a new virtual MFA device for the Amazon Web Services 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, see Using a virtual MFA device in the IAM User Guide.
For information about the maximum number of MFA devices you can create, see IAM and STS quotas 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. In other words, protect the seed information as you would your Amazon Web Services 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 Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateMfaDeviceResponse deactivateMFADevice(DeactivateMfaDeviceRequest deactivateMfaDeviceRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, ConcurrentModificationException, 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, see Enabling a virtual multi-factor authentication (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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateMfaDeviceResponse deactivateMFADevice(Consumer<DeactivateMfaDeviceRequest.Builder> deactivateMfaDeviceRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, ConcurrentModificationException, 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, see Enabling a virtual multi-factor authentication (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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
deleteAccessKeyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteAccountAliasResponse deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest) throws ConcurrentModificationException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.
deleteAccountAliasRequest - ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteAccountAliasResponse deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest) throws ConcurrentModificationException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteAccountPasswordPolicyResponse deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the password policy for the Amazon Web Services account. There are no parameters.
deleteAccountPasswordPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteAccountPasswordPolicyResponse deleteAccountPasswordPolicy(Consumer<DeleteAccountPasswordPolicyRequest.Builder> deleteAccountPasswordPolicyRequest) throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the password policy for the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteAccountPasswordPolicyResponse deleteAccountPasswordPolicy() throws NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the password policy for the Amazon Web Services account. There are no parameters.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondeleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest),
AWS API Documentationdefault 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 that 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, see Using instance profiles in the IAM User Guide.
deleteInstanceProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 that 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, see Using instance profiles in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault DeleteLoginProfileResponse deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.
Deleting a user's password does not prevent a user from accessing Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteLoginProfileResponse deleteLoginProfile(Consumer<DeleteLoginProfileRequest.Builder> deleteLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.
Deleting a user's password does not prevent a user from accessing Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation is idempotent; it does not fail or return an error if you call the operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation is idempotent; it does not fail or return an error if you call the operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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. In addition, you must delete all 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 DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. 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 operation.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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. In addition, you must delete all 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 DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. 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 operation.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation. 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation. 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteRoleResponse deleteRole(DeleteRoleRequest deleteRoleRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, UnmodifiableEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:
Inline policies (DeleteRolePolicy)
Attached managed policies (DetachRolePolicy)
Instance profile (RemoveRoleFromInstanceProfile)
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)
Make sure that 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRoleResponse deleteRole(Consumer<DeleteRoleRequest.Builder> deleteRoleRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, UnmodifiableEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:
Inline policies (DeleteRolePolicy)
Attached managed policies (DetachRolePolicy)
Instance profile (RemoveRoleFromInstanceProfile)
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)
Make sure that 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRolePermissionsBoundaryResponse deleteRolePermissionsBoundary(DeleteRolePermissionsBoundaryRequest deleteRolePermissionsBoundaryRequest) throws NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the permissions boundary for the specified IAM role.
You cannot set the boundary for a service-linked role.
Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.
deleteRolePermissionsBoundaryRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault DeleteRolePermissionsBoundaryResponse deleteRolePermissionsBoundary(Consumer<DeleteRolePermissionsBoundaryRequest.Builder> deleteRolePermissionsBoundaryRequest) throws NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the permissions boundary for the specified IAM role.
You cannot set the boundary for a service-linked role.
Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.
This is a convenience which creates an instance of the DeleteRolePermissionsBoundaryRequest.Builder
avoiding the need to create one manually via DeleteRolePermissionsBoundaryRequest.builder()
deleteRolePermissionsBoundaryRequest - A Consumer that will call methods on
DeleteRolePermissionsBoundaryRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSshPublicKeyResponse deleteSSHPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Deletes the specified SSH public key.
The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
deleteSshPublicKeyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSshPublicKeyResponse deleteSSHPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Deletes the specified SSH public key.
The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
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, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
deleteServerCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
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, see 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 operation returns the reason for the failure, usually 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 Amazon Web Services documentation for your service.
For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.
deleteServiceLinkedRoleRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation returns the reason for the failure, usually 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 Amazon Web Services documentation for your service.
For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteServiceSpecificCredentialResponse deleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest deleteServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Deletes the specified service-specific credential.
deleteServiceSpecificCredentialRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSigningCertificateResponse deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest) throws NoSuchEntityException, LimitExceededException, ConcurrentModificationException, 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.
deleteSigningCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSigningCertificateResponse deleteSigningCertificate(Consumer<DeleteSigningCertificateRequest.Builder> deleteSigningCertificateRequest) throws NoSuchEntityException, LimitExceededException, ConcurrentModificationException, 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 Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws LimitExceededException, NoSuchEntityException, DeleteConflictException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:
Password (DeleteLoginProfile)
Access keys (DeleteAccessKey)
Signing certificate (DeleteSigningCertificate)
SSH public key (DeleteSSHPublicKey)
Git credentials (DeleteServiceSpecificCredential)
Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy)
Attached managed policies (DetachUserPolicy)
Group memberships (RemoveUserFromGroup)
deleteUserRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws LimitExceededException, NoSuchEntityException, DeleteConflictException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:
Password (DeleteLoginProfile)
Access keys (DeleteAccessKey)
Signing certificate (DeleteSigningCertificate)
SSH public key (DeleteSSHPublicKey)
Git credentials (DeleteServiceSpecificCredential)
Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy)
Attached managed policies (DetachUserPolicy)
Group memberships (RemoveUserFromGroup)
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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate
entities. The error message describes these entities.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserPermissionsBoundaryResponse deleteUserPermissionsBoundary(DeleteUserPermissionsBoundaryRequest deleteUserPermissionsBoundaryRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the permissions boundary for the specified IAM user.
Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.
deleteUserPermissionsBoundaryRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserPermissionsBoundaryResponse deleteUserPermissionsBoundary(Consumer<DeleteUserPermissionsBoundaryRequest.Builder> deleteUserPermissionsBoundaryRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Deletes the permissions boundary for the specified IAM user.
Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.
This is a convenience which creates an instance of the DeleteUserPermissionsBoundaryRequest.Builder
avoiding the need to create one manually via DeleteUserPermissionsBoundaryRequest.builder()
deleteUserPermissionsBoundaryRequest - A Consumer that will call methods on
DeleteUserPermissionsBoundaryRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault DeleteVirtualMfaDeviceResponse deleteVirtualMFADevice(DeleteVirtualMfaDeviceRequest deleteVirtualMfaDeviceRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, ConcurrentModificationException, 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVirtualMfaDeviceResponse deleteVirtualMFADevice(Consumer<DeleteVirtualMfaDeviceRequest.Builder> deleteVirtualMfaDeviceRequest) throws NoSuchEntityException, DeleteConflictException, LimitExceededException, ServiceFailureException, ConcurrentModificationException, 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
detachGroupPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 DeleteGroupPolicy. 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
detachRolePolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 DeleteRolePolicy. 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
detachUserPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 DeleteUserPolicy. 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault EnableMfaDeviceResponse enableMFADevice(EnableMfaDeviceRequest enableMfaDeviceRequest) throws EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, InvalidAuthenticationCodeException, LimitExceededException, NoSuchEntityException, ServiceFailureException, ConcurrentModificationException, 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableMfaDeviceResponse enableMFADevice(Consumer<EnableMfaDeviceRequest.Builder> enableMfaDeviceRequest) throws EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, InvalidAuthenticationCodeException, LimitExceededException, NoSuchEntityException, ServiceFailureException, ConcurrentModificationException, 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateCredentialReportResponse generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest) throws LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Generates a credential report for the Amazon Web Services 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 Amazon Web Services
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.AwsServiceExceptiondefault GenerateCredentialReportResponse generateCredentialReport(Consumer<GenerateCredentialReportRequest.Builder> generateCredentialReportRequest) throws LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Generates a credential report for the Amazon Web Services 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 Amazon Web Services
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.AwsServiceExceptiondefault GenerateCredentialReportResponse generateCredentialReport() throws LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Generates a credential report for the Amazon Web Services 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 Amazon Web Services
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.AwsServiceExceptiongenerateCredentialReport(GenerateCredentialReportRequest),
AWS
API Documentationdefault GenerateOrganizationsAccessReportResponse generateOrganizationsAccessReport(GenerateOrganizationsAccessReportRequest generateOrganizationsAccessReportRequest) throws ReportGenerationLimitExceededException, AwsServiceException, SdkClientException, IamException
Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.
To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.
You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.
For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.
The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
This operation returns a JobId. Use this parameter in the
GetOrganizationsAccessReport operation to check the status of the report generation. To
check the status of this request, use the JobId parameter in the
GetOrganizationsAccessReport operation and test the JobStatus response
parameter. When the job is complete, you can retrieve the report.
To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.
Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.
OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.
Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.
To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.
Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.
OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.
Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.
Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
generateOrganizationsAccessReportRequest - ReportGenerationLimitExceededException - The request failed because the maximum number of concurrent requests for this account are already
running.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateOrganizationsAccessReportResponse generateOrganizationsAccessReport(Consumer<GenerateOrganizationsAccessReportRequest.Builder> generateOrganizationsAccessReportRequest) throws ReportGenerationLimitExceededException, AwsServiceException, SdkClientException, IamException
Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.
To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.
You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.
For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.
The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
This operation returns a JobId. Use this parameter in the
GetOrganizationsAccessReport operation to check the status of the report generation. To
check the status of this request, use the JobId parameter in the
GetOrganizationsAccessReport operation and test the JobStatus response
parameter. When the job is complete, you can retrieve the report.
To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.
Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.
OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.
Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.
To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.
Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.
OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.
Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.
Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
This is a convenience which creates an instance of the GenerateOrganizationsAccessReportRequest.Builder
avoiding the need to create one manually via GenerateOrganizationsAccessReportRequest.builder()
generateOrganizationsAccessReportRequest - A Consumer that will call methods on
GenerateOrganizationsAccessReportRequest.Builder to
create a request.ReportGenerationLimitExceededException - The request failed because the maximum number of concurrent requests for this account are already
running.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateServiceLastAccessedDetailsResponse generateServiceLastAccessedDetails(GenerateServiceLastAccessedDetailsRequest generateServiceLastAccessedDetailsRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. For more information about services and actions for which action last accessed information is displayed, see IAM action last accessed information services and actions.
The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in
the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role
within a session, or by the same user when used to call GetServiceLastAccessedDetail.
GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId
parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
generateServiceLastAccessedDetailsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GenerateServiceLastAccessedDetailsResponse generateServiceLastAccessedDetails(Consumer<GenerateServiceLastAccessedDetailsRequest.Builder> generateServiceLastAccessedDetailsRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. For more information about services and actions for which action last accessed information is displayed, see IAM action last accessed information services and actions.
The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in
the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role
within a session, or by the same user when used to call GetServiceLastAccessedDetail.
GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId
parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
This is a convenience which creates an instance of the GenerateServiceLastAccessedDetailsRequest.Builder
avoiding the need to create one manually via GenerateServiceLastAccessedDetailsRequest.builder()
generateServiceLastAccessedDetailsRequest - A Consumer that will call methods on
GenerateServiceLastAccessedDetailsRequest.Builder to
create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetAccessKeyLastUsedResponse getAccessKeyLastUsed(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest) throws 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 Amazon Web Services service and Region that were specified in the last request made with that key.
getAccessKeyLastUsedRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessKeyLastUsedResponse getAccessKeyLastUsed(Consumer<GetAccessKeyLastUsedRequest.Builder> getAccessKeyLastUsedRequest) throws 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 Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountAuthorizationDetailsResponse getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation 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.
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.AwsServiceExceptiondefault GetAccountAuthorizationDetailsResponse getAccountAuthorizationDetails(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation 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.
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.AwsServiceExceptiondefault GetAccountAuthorizationDetailsResponse getAccountAuthorizationDetails() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation 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.
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.AwsServiceExceptiongetAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest),
AWS API Documentationdefault GetAccountAuthorizationDetailsIterable getAccountAuthorizationDetailsPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation 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.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiongetAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest),
AWS API Documentationdefault GetAccountAuthorizationDetailsIterable getAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation 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.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault GetAccountAuthorizationDetailsIterable getAccountAuthorizationDetailsPaginator(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation 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.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation.
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.AwsServiceExceptiondefault GetAccountPasswordPolicyResponse getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.
getAccountPasswordPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountPasswordPolicyResponse getAccountPasswordPolicy(Consumer<GetAccountPasswordPolicyRequest.Builder> getAccountPasswordPolicyRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountPasswordPolicyResponse getAccountPasswordPolicy() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetAccountPasswordPolicy(GetAccountPasswordPolicyRequest),
AWS
API Documentationdefault GetAccountSummaryResponse getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
For information about IAM quotas, see IAM and STS quotas 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.AwsServiceExceptiondefault GetAccountSummaryResponse getAccountSummary(Consumer<GetAccountSummaryRequest.Builder> getAccountSummaryRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
For information about IAM quotas, see IAM and STS quotas 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.AwsServiceExceptiondefault GetAccountSummaryResponse getAccountSummary() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
For information about IAM quotas, see IAM and STS quotas 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.AwsServiceExceptiongetAccountSummary(GetAccountSummaryRequest),
AWS API
Documentationdefault 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 Amazon Web Services and its services that provide details about the
context of an API query request. Context keys 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.AwsServiceExceptiondefault 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 Amazon Web Services and its services that provide details about the
context of an API query request. Context keys 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.AwsServiceExceptiondefault GetContextKeysForPrincipalPolicyResponse getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest getContextKeysForPrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Gets a list of all of the context keys referenced in all the IAM policies that are 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 operation 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 Amazon Web Services and its services that provide details about the context of an API query request. Context keys 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetContextKeysForPrincipalPolicyResponse getContextKeysForPrincipalPolicy(Consumer<GetContextKeysForPrincipalPolicyRequest.Builder> getContextKeysForPrincipalPolicyRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Gets a list of all of the context keys referenced in all the IAM policies that are 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 operation 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 Amazon Web Services and its services that provide details about the context of an API query request. Context keys 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetCredentialReportResponse getCredentialReport(GetCredentialReportRequest getCredentialReportRequest) throws CredentialReportNotPresentException, CredentialReportExpiredException, CredentialReportNotReadyException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves a credential report for the Amazon Web Services 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.AwsServiceExceptiondefault GetCredentialReportResponse getCredentialReport(Consumer<GetCredentialReportRequest.Builder> getCredentialReportRequest) throws CredentialReportNotPresentException, CredentialReportExpiredException, CredentialReportNotReadyException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves a credential report for the Amazon Web Services 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.AwsServiceExceptiondefault GetCredentialReportResponse getCredentialReport() throws CredentialReportNotPresentException, CredentialReportExpiredException, CredentialReportNotReadyException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves a credential report for the Amazon Web Services 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.AwsServiceExceptiongetCredentialReport(GetCredentialReportRequest),
AWS API
Documentationdefault 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Using instance profiles in the IAM User Guide.
getInstanceProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Using 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoginProfileResponse getLoginProfile(GetLoginProfileRequest getLoginProfileRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the
user to access the Amazon Web Services Management Console. If the user does not exist or does not have a
password, the operation returns a 404 (NoSuchEntity) error.
If you create an IAM user with access to the console, the CreateDate reflects the date you created
the initial password for the user.
If you create an IAM user with programmatic access, and then later add a password for the user to access the
Amazon Web Services Management Console, the CreateDate reflects the initial password creation date.
A user with programmatic access does not have a login profile unless you create a password for the user to access
the Amazon Web Services Management Console.
getLoginProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoginProfileResponse getLoginProfile(Consumer<GetLoginProfileRequest.Builder> getLoginProfileRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the
user to access the Amazon Web Services Management Console. If the user does not exist or does not have a
password, the operation returns a 404 (NoSuchEntity) error.
If you create an IAM user with access to the console, the CreateDate reflects the date you created
the initial password for the user.
If you create an IAM user with programmatic access, and then later add a password for the user to access the
Amazon Web Services Management Console, the CreateDate reflects the initial password creation date.
A user with programmatic access does not have a login profile unless you create a password for the user to access
the Amazon Web Services Management Console.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMfaDeviceResponse getMFADevice(GetMfaDeviceRequest getMfaDeviceRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about an MFA device for a specified user.
getMfaDeviceRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMfaDeviceResponse getMFADevice(Consumer<GetMfaDeviceRequest.Builder> getMfaDeviceRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves information about an MFA device for a specified user.
This is a convenience which creates an instance of the GetMfaDeviceRequest.Builder avoiding the need to
create one manually via GetMfaDeviceRequest.builder()
getMfaDeviceRequest - A Consumer that will call methods on
GetMfaDeviceRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOrganizationsAccessReportResponse getOrganizationsAccessReport(GetOrganizationsAccessReportRequest getOrganizationsAccessReportRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Retrieves the service last accessed data report for Organizations that was previously generated using the
GenerateOrganizationsAccessReport operation. This operation retrieves the status of your
report job and the report contents.
Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.
To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.
By default, the list is sorted by service namespace.
getOrganizationsAccessReportRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOrganizationsAccessReportResponse getOrganizationsAccessReport(Consumer<GetOrganizationsAccessReportRequest.Builder> getOrganizationsAccessReportRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Retrieves the service last accessed data report for Organizations that was previously generated using the
GenerateOrganizationsAccessReport operation. This operation retrieves the status of your
report job and the report contents.
Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.
To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.
By default, the list is sorted by service namespace.
This is a convenience which creates an instance of the GetOrganizationsAccessReportRequest.Builder
avoiding the need to create one manually via GetOrganizationsAccessReportRequest.builder()
getOrganizationsAccessReportRequest - A Consumer that will call methods on
GetOrganizationsAccessReportRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation 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 operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation 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 operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 IAM roles in the IAM User Guide.
Policies returned by this operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 IAM roles in the IAM User Guide.
Policies returned by this operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 IAM roles in the IAM User Guide.
getRolePolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 IAM roles in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
getSshPublicKeyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
getServerCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceLastAccessedDetailsResponse getServiceLastAccessedDetails(GetServiceLastAccessedDetailsRequest getServiceLastAccessedDetailsRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in
GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is
complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that
the resource (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For each service that the resource could access using permissions policies, the operation returns details about
the most recent access attempt. If there was no attempt, the service is listed without details about the most
recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails
operation returns the reason that it failed.
The GetServiceLastAccessedDetails operation returns a list of services. This list includes the
number of entities that have attempted to access the service and the date and time of the last attempt. It also
returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:
User – Returns the user ARN that you used to generate the report
Group – Returns the ARN of the group member (user) that last attempted to access the service
Role – Returns the role ARN that you used to generate the report
Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service
By default, the list is sorted by service namespace.
If you specified ACTION_LEVEL granularity when you generated the report, this operation returns
service and action last accessed data. This includes the most recent access attempt for each tracked action
within a service. Otherwise, this operation returns only service data.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
getServiceLastAccessedDetailsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetServiceLastAccessedDetailsResponse getServiceLastAccessedDetails(Consumer<GetServiceLastAccessedDetailsRequest.Builder> getServiceLastAccessedDetailsRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in
GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is
complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that
the resource (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For each service that the resource could access using permissions policies, the operation returns details about
the most recent access attempt. If there was no attempt, the service is listed without details about the most
recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails
operation returns the reason that it failed.
The GetServiceLastAccessedDetails operation returns a list of services. This list includes the
number of entities that have attempted to access the service and the date and time of the last attempt. It also
returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:
User – Returns the user ARN that you used to generate the report
Group – Returns the ARN of the group member (user) that last attempted to access the service
Role – Returns the role ARN that you used to generate the report
Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service
By default, the list is sorted by service namespace.
If you specified ACTION_LEVEL granularity when you generated the report, this operation returns
service and action last accessed data. This includes the most recent access attempt for each tracked action
within a service. Otherwise, this operation returns only service data.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
This is a convenience which creates an instance of the GetServiceLastAccessedDetailsRequest.Builder
avoiding the need to create one manually via GetServiceLastAccessedDetailsRequest.builder()
getServiceLastAccessedDetailsRequest - A Consumer that will call methods on
GetServiceLastAccessedDetailsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetServiceLastAccessedDetailsWithEntitiesResponse getServiceLastAccessedDetailsWithEntities(GetServiceLastAccessedDetailsWithEntitiesRequest getServiceLastAccessedDetailsWithEntitiesRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation,
you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This
operation retrieves the status of your report job and a list of entities that could have used group or policy
permissions to access the specified service.
Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.
Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason
that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
getServiceLastAccessedDetailsWithEntitiesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetServiceLastAccessedDetailsWithEntitiesResponse getServiceLastAccessedDetailsWithEntities(Consumer<GetServiceLastAccessedDetailsWithEntitiesRequest.Builder> getServiceLastAccessedDetailsWithEntitiesRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation,
you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This
operation retrieves the status of your report job and a list of entities that could have used group or policy
permissions to access the specified service.
Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.
Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason
that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
This is a convenience which creates an instance of the
GetServiceLastAccessedDetailsWithEntitiesRequest.Builder avoiding the need to create one manually via
GetServiceLastAccessedDetailsWithEntitiesRequest.builder()
getServiceLastAccessedDetailsWithEntitiesRequest - A Consumer that will call methods on
GetServiceLastAccessedDetailsWithEntitiesRequest.Builder
to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault GetServiceLinkedRoleDeletionStatusResponse getServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest getServiceLinkedRoleDeletionStatusRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole 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, if that information is returned by the service.
getServiceLinkedRoleDeletionStatusRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 DeleteServiceLinkedRole 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, if that information is returned by the service.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 Amazon Web Services access key ID used to sign the request to this operation.
getUserRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Amazon Web Services access key ID used to sign the request to this operation.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Amazon Web Services access key ID used to sign the request to this operation.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetUser(GetUserRequest),
AWS API
Documentationdefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 is none, the operation 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 is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.
listAccessKeysRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 is none, the operation 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 is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessKeysResponse listAccessKeys() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation 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 is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAccessKeys(ListAccessKeysRequest),
AWS API
Documentationdefault ListAccessKeysIterable listAccessKeysPaginator() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation 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 is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAccessKeysPaginator(ListAccessKeysRequest),
AWS API
Documentationdefault 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 is none, the operation 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 is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessKeysIterable listAccessKeysPaginator(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 is none, the operation 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 is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest) operation.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccountAliasesResponse listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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.AwsServiceExceptiondefault ListAccountAliasesResponse listAccountAliases(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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.AwsServiceExceptiondefault ListAccountAliasesResponse listAccountAliases() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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.AwsServiceExceptionlistAccountAliases(ListAccountAliasesRequest),
AWS API
Documentationdefault ListAccountAliasesIterable listAccountAliasesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistAccountAliasesPaginator(ListAccountAliasesRequest),
AWS API
Documentationdefault ListAccountAliasesIterable listAccountAliasesPaginator(ListAccountAliasesRequest listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListAccountAliasesIterable listAccountAliasesPaginator(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest) operation.
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.AwsServiceExceptiondefault 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 ListGroupPolicies. 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
operation returns an empty list.
listAttachedGroupPoliciesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListGroupPolicies. 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
operation 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListGroupPolicies. 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
operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListGroupPolicies. 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
operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListRolePolicies. 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
operation returns an empty list.
listAttachedRolePoliciesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListRolePolicies. 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
operation 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListRolePolicies. 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
operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListRolePolicies. 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
operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListUserPolicies. 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
operation returns an empty list.
listAttachedUserPoliciesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListUserPolicies. 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
operation 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListUserPolicies. 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
operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 ListUserPolicies. 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
operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation returns an empty list.
listGroupPoliciesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptionlistGroups(ListGroupsRequest),
AWS API
Documentationdefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistGroupsPaginator(ListGroupsRequest),
AWS API
Documentationdefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(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 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest) operation.
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceProfileTagsResponse listInstanceProfileTags(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listInstanceProfileTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceProfileTagsResponse listInstanceProfileTags(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListInstanceProfileTagsRequest.Builder avoiding
the need to create one manually via ListInstanceProfileTagsRequest.builder()
listInstanceProfileTagsRequest - A Consumer that will call methods on
ListInstanceProfileTagsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceProfileTagsIterable listInstanceProfileTagsPaginator(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
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.ListInstanceProfileTagsIterable responses = client.listInstanceProfileTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsIterable responses = client
.listInstanceProfileTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsIterable responses = client.listInstanceProfileTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
operation.
listInstanceProfileTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceProfileTagsIterable listInstanceProfileTagsPaginator(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
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.ListInstanceProfileTagsIterable responses = client.listInstanceProfileTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsIterable responses = client
.listInstanceProfileTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsIterable responses = client.listInstanceProfileTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
operation.
This is a convenience which creates an instance of the ListInstanceProfileTagsRequest.Builder avoiding
the need to create one manually via ListInstanceProfileTagsRequest.builder()
listInstanceProfileTagsRequest - A Consumer that will call methods on
ListInstanceProfileTagsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceProfilesResponse listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
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.AwsServiceExceptiondefault 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 operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
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.AwsServiceExceptiondefault ListInstanceProfilesResponse listInstanceProfiles() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
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.AwsServiceExceptionlistInstanceProfiles(ListInstanceProfilesRequest),
AWS API
Documentationdefault ListInstanceProfilesIterable listInstanceProfilesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistInstanceProfilesPaginator(ListInstanceProfilesRequest),
AWS API
Documentationdefault ListInstanceProfilesIterable listInstanceProfilesPaginator(ListInstanceProfilesRequest listInstanceProfilesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListInstanceProfilesIterable listInstanceProfilesPaginator(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.
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.AwsServiceExceptiondefault 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 operation returns an empty list. For more information about instance profiles, go to Using instance profiles in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters.
listInstanceProfilesForRoleRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation returns an empty list. For more information about instance profiles, go to Using instance profiles in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation returns an empty list. For more information about instance profiles, go to Using instance profiles in the IAM User Guide.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation returns an empty list. For more information about instance profiles, go to Using instance profiles in the IAM User Guide.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMfaDeviceTagsResponse listMFADeviceTags(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listMfaDeviceTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault ListMfaDeviceTagsResponse listMFADeviceTags(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListMfaDeviceTagsRequest.Builder avoiding the need
to create one manually via ListMfaDeviceTagsRequest.builder()
listMfaDeviceTagsRequest - A Consumer that will call methods on
ListMfaDeviceTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault ListMFADeviceTagsIterable listMFADeviceTagsPaginator(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest) 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.ListMFADeviceTagsIterable responses = client.listMFADeviceTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsIterable responses = client
.listMFADeviceTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsIterable responses = client.listMFADeviceTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest) operation.
listMfaDeviceTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault ListMFADeviceTagsIterable listMFADeviceTagsPaginator(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest) throws NoSuchEntityException, InvalidInputException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest) 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.ListMFADeviceTagsIterable responses = client.listMFADeviceTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsIterable responses = client
.listMFADeviceTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsIterable responses = client.listMFADeviceTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest) operation.
This is a convenience which creates an instance of the ListMfaDeviceTagsRequest.Builder avoiding the need
to create one manually via ListMfaDeviceTagsRequest.builder()
listMfaDeviceTagsRequest - A Consumer that will call methods on
ListMfaDeviceTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation 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 Amazon Web Services access key ID signing the request for this operation.
You can paginate the results using the MaxItems and Marker parameters.
listMfaDevicesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 Amazon Web Services access key ID signing the request for this operation.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 Amazon Web Services access key ID signing the request for this operation.
You can paginate the results using the MaxItems and Marker parameters.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistMFADevices(ListMfaDevicesRequest),
AWS API
Documentationdefault 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 operation 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 Amazon Web Services access key ID signing the request for this operation.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistMFADevicesPaginator(ListMfaDevicesRequest),
AWS API
Documentationdefault 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 operation 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 Amazon Web Services access key ID signing the request for this operation.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMFADevicesIterable listMFADevicesPaginator(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 operation 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 Amazon Web Services access key ID signing the request for this operation.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest) operation.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOpenIdConnectProviderTagsResponse listOpenIDConnectProviderTags(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listOpenIdConnectProviderTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListOpenIdConnectProviderTagsResponse listOpenIDConnectProviderTags(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListOpenIdConnectProviderTagsRequest.Builder
avoiding the need to create one manually via ListOpenIdConnectProviderTagsRequest.builder()
listOpenIdConnectProviderTagsRequest - A Consumer that will call methods on
ListOpenIdConnectProviderTagsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListOpenIDConnectProviderTagsIterable listOpenIDConnectProviderTagsPaginator(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
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.ListOpenIDConnectProviderTagsIterable responses = client.listOpenIDConnectProviderTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsIterable responses = client
.listOpenIDConnectProviderTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsIterable responses = client.listOpenIDConnectProviderTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
operation.
listOpenIdConnectProviderTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListOpenIDConnectProviderTagsIterable listOpenIDConnectProviderTagsPaginator(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
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.ListOpenIDConnectProviderTagsIterable responses = client.listOpenIDConnectProviderTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsIterable responses = client
.listOpenIDConnectProviderTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsIterable responses = client.listOpenIDConnectProviderTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
operation.
This is a convenience which creates an instance of the ListOpenIdConnectProviderTagsRequest.Builder
avoiding the need to create one manually via ListOpenIdConnectProviderTagsRequest.builder()
listOpenIdConnectProviderTagsRequest - A Consumer that will call methods on
ListOpenIdConnectProviderTagsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListOpenIdConnectProvidersResponse listOpenIDConnectProviders(ListOpenIdConnectProvidersRequest listOpenIdConnectProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.
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.AwsServiceExceptiondefault 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 Amazon Web Services account.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.
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.AwsServiceExceptiondefault ListOpenIdConnectProvidersResponse listOpenIDConnectProviders() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.
ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOpenIDConnectProviders(ListOpenIdConnectProvidersRequest),
AWS API Documentationdefault ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services account, set Scope to Local. To list only Amazon
Web Services 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.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
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.AwsServiceExceptiondefault ListPoliciesResponse listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services account, set Scope to Local. To list only Amazon
Web Services 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.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
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.AwsServiceExceptiondefault ListPoliciesResponse listPolicies() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services account, set Scope to Local. To list only Amazon
Web Services 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.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPolicies(ListPoliciesRequest),
AWS API
Documentationdefault ListPoliciesIterable listPoliciesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services account, set Scope to Local. To list only Amazon
Web Services 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.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistPoliciesPaginator(ListPoliciesRequest),
AWS API
Documentationdefault ListPoliciesIterable listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services account, set Scope to Local. To list only Amazon
Web Services 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.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListPoliciesIterable listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services account, set Scope to Local. To list only Amazon
Web Services 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.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest) operation.
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.AwsServiceExceptiondefault ListPoliciesGrantingServiceAccessResponse listPoliciesGrantingServiceAccess(ListPoliciesGrantingServiceAccessRequest listPoliciesGrantingServiceAccessRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
The list of policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.
Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.
Role – The list of policies includes only the managed and inline policies that are attached to the role.
For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.
listPoliciesGrantingServiceAccessRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault ListPoliciesGrantingServiceAccessResponse listPoliciesGrantingServiceAccess(Consumer<ListPoliciesGrantingServiceAccessRequest.Builder> listPoliciesGrantingServiceAccessRequest) throws NoSuchEntityException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
The list of policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.
Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.
Role – The list of policies includes only the managed and inline policies that are attached to the role.
For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.
This is a convenience which creates an instance of the ListPoliciesGrantingServiceAccessRequest.Builder
avoiding the need to create one manually via ListPoliciesGrantingServiceAccessRequest.builder()
listPoliciesGrantingServiceAccessRequest - A Consumer that will call methods on
ListPoliciesGrantingServiceAccessRequest.Builder to
create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault ListPolicyTagsResponse listPolicyTags(ListPolicyTagsRequest listPolicyTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listPolicyTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListPolicyTagsResponse listPolicyTags(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListPolicyTagsRequest.Builder avoiding the need to
create one manually via ListPolicyTagsRequest.builder()
listPolicyTagsRequest - A Consumer that will call methods on
ListPolicyTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListPolicyTagsIterable listPolicyTagsPaginator(ListPolicyTagsRequest listPolicyTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of listPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest)
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.ListPolicyTagsIterable responses = client.listPolicyTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListPolicyTagsIterable responses = client.listPolicyTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListPolicyTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListPolicyTagsIterable responses = client.listPolicyTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest) operation.
listPolicyTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListPolicyTagsIterable listPolicyTagsPaginator(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of listPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest)
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.ListPolicyTagsIterable responses = client.listPolicyTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListPolicyTagsIterable responses = client.listPolicyTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListPolicyTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListPolicyTagsIterable responses = client.listPolicyTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest) operation.
This is a convenience which creates an instance of the ListPolicyTagsRequest.Builder avoiding the need to
create one manually via ListPolicyTagsRequest.builder()
listPolicyTagsRequest - A Consumer that will call methods on
ListPolicyTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation returns an empty list.
listRolePoliciesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoleTagsResponse listRoleTags(ListRoleTagsRequest listRoleTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listRoleTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoleTagsResponse listRoleTags(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListRoleTagsRequest.Builder avoiding the need to
create one manually via ListRoleTagsRequest.builder()
listRoleTagsRequest - A Consumer that will call methods on
ListRoleTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoleTagsIterable listRoleTagsPaginator(ListRoleTagsRequest listRoleTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of listRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest)
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.ListRoleTagsIterable responses = client.listRoleTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListRoleTagsIterable responses = client.listRoleTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListRoleTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListRoleTagsIterable responses = client.listRoleTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest) operation.
listRoleTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoleTagsIterable listRoleTagsPaginator(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of listRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest)
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.ListRoleTagsIterable responses = client.listRoleTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListRoleTagsIterable responses = client.listRoleTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListRoleTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListRoleTagsIterable responses = client.listRoleTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest) operation.
This is a convenience which creates an instance of the ListRoleTagsRequest.Builder avoiding the need to
create one manually via ListRoleTagsRequest.builder()
listRoleTagsRequest - A Consumer that will call methods on
ListRoleTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRolesResponse listRoles(ListRolesRequest listRolesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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.AwsServiceExceptiondefault 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 operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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.AwsServiceExceptiondefault ListRolesResponse listRoles() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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.AwsServiceExceptionlistRoles(ListRolesRequest),
AWS API
Documentationdefault ListRolesIterable listRolesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistRolesPaginator(ListRolesRequest),
AWS API
Documentationdefault ListRolesIterable listRolesPaginator(ListRolesRequest listRolesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListRolesIterable listRolesPaginator(Consumer<ListRolesRequest.Builder> listRolesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest) operation.
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.AwsServiceExceptiondefault ListSamlProviderTagsResponse listSAMLProviderTags(ListSamlProviderTagsRequest listSamlProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listSamlProviderTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListSamlProviderTagsResponse listSAMLProviderTags(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListSamlProviderTagsRequest.Builder avoiding the
need to create one manually via ListSamlProviderTagsRequest.builder()
listSamlProviderTagsRequest - A Consumer that will call methods on
ListSamlProviderTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListSAMLProviderTagsIterable listSAMLProviderTagsPaginator(ListSamlProviderTagsRequest listSamlProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest) 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.ListSAMLProviderTagsIterable responses = client.listSAMLProviderTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsIterable responses = client
.listSAMLProviderTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListSamlProviderTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsIterable responses = client.listSAMLProviderTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest)
operation.
listSamlProviderTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListSAMLProviderTagsIterable listSAMLProviderTagsPaginator(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest) throws NoSuchEntityException, ServiceFailureException, InvalidInputException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of
listSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest) 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.ListSAMLProviderTagsIterable responses = client.listSAMLProviderTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsIterable responses = client
.listSAMLProviderTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListSamlProviderTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsIterable responses = client.listSAMLProviderTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest)
operation.
This is a convenience which creates an instance of the ListSamlProviderTagsRequest.Builder avoiding the
need to create one manually via ListSamlProviderTagsRequest.builder()
listSamlProviderTagsRequest - A Consumer that will call methods on
ListSamlProviderTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.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.AwsServiceExceptiondefault ListSamlProvidersResponse listSAMLProviders(ListSamlProvidersRequest listSamlProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
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.AwsServiceExceptiondefault ListSamlProvidersResponse listSAMLProviders(Consumer<ListSamlProvidersRequest.Builder> listSamlProvidersRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
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.AwsServiceExceptiondefault ListSamlProvidersResponse listSAMLProviders() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
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.AwsServiceExceptionlistSAMLProviders(ListSamlProvidersRequest),
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 none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSshPublicKeysResponse listSSHPublicKeys() throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistSSHPublicKeys(ListSshPublicKeysRequest),
AWS API
Documentationdefault ListSSHPublicKeysIterable listSSHPublicKeysPaginator() throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistSSHPublicKeysPaginator(ListSshPublicKeysRequest),
AWS API
Documentationdefault ListSSHPublicKeysIterable listSSHPublicKeysPaginator(ListSshPublicKeysRequest listSshPublicKeysRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSSHPublicKeysIterable listSSHPublicKeysPaginator(Consumer<ListSshPublicKeysRequest.Builder> listSshPublicKeysRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest) operation.
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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServerCertificateTagsResponse listServerCertificateTags(ListServerCertificateTagsRequest listServerCertificateTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
listServerCertificateTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServerCertificateTagsResponse listServerCertificateTags(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
This is a convenience which creates an instance of the ListServerCertificateTagsRequest.Builder avoiding
the need to create one manually via ListServerCertificateTagsRequest.builder()
listServerCertificateTagsRequest - A Consumer that will call methods on
ListServerCertificateTagsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServerCertificateTagsIterable listServerCertificateTagsPaginator(ListServerCertificateTagsRequest listServerCertificateTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
This is a variant of
listServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
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.ListServerCertificateTagsIterable responses = client.listServerCertificateTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsIterable responses = client
.listServerCertificateTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListServerCertificateTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsIterable responses = client.listServerCertificateTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
operation.
listServerCertificateTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServerCertificateTagsIterable listServerCertificateTagsPaginator(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
This is a variant of
listServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
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.ListServerCertificateTagsIterable responses = client.listServerCertificateTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsIterable responses = client
.listServerCertificateTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListServerCertificateTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsIterable responses = client.listServerCertificateTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
operation.
This is a convenience which creates an instance of the ListServerCertificateTagsRequest.Builder avoiding
the need to create one manually via ListServerCertificateTagsRequest.builder()
listServerCertificateTagsRequest - A Consumer that will call methods on
ListServerCertificateTagsRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
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.AwsServiceExceptiondefault 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 operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
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.AwsServiceExceptiondefault ListServerCertificatesResponse listServerCertificates() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistServerCertificates(ListServerCertificatesRequest),
AWS
API Documentationdefault ListServerCertificatesIterable listServerCertificatesPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistServerCertificatesPaginator(ListServerCertificatesRequest),
AWS
API Documentationdefault 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 operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListServerCertificatesIterable listServerCertificatesPaginator(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 operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation.
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.AwsServiceExceptiondefault ListServiceSpecificCredentialsResponse listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest listServiceSpecificCredentialsRequest) throws NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IamException
Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide.
listServiceSpecificCredentialsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the 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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault ListServiceSpecificCredentialsResponse listServiceSpecificCredentials() throws NoSuchEntityException, ServiceNotSupportedException, AwsServiceException, SdkClientException, IamException
Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptionlistServiceSpecificCredentials(ListServiceSpecificCredentialsRequest),
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 none exists, the operation 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 Amazon
Web Services access key ID used to sign the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services account has no associated users.
listSigningCertificatesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 none exists, the operation 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 Amazon
Web Services access key ID used to sign the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSigningCertificatesResponse listSigningCertificates() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation 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 Amazon
Web Services access key ID used to sign the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services account has no associated users.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistSigningCertificates(ListSigningCertificatesRequest),
AWS
API Documentationdefault ListSigningCertificatesIterable listSigningCertificatesPaginator() throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation 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 Amazon
Web Services access key ID used to sign the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistSigningCertificatesPaginator(ListSigningCertificatesRequest),
AWS
API Documentationdefault ListSigningCertificatesIterable listSigningCertificatesPaginator(ListSigningCertificatesRequest listSigningCertificatesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation 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 Amazon
Web Services access key ID used to sign the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSigningCertificatesIterable listSigningCertificatesPaginator(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation 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 Amazon
Web Services access key ID used to sign the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation returns an empty list.
listUserPoliciesRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserTagsResponse listUserTags(ListUserTagsRequest listUserTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
listUserTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserTagsResponse listUserTags(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the ListUserTagsRequest.Builder avoiding the need to
create one manually via ListUserTagsRequest.builder()
listUserTagsRequest - A Consumer that will call methods on
ListUserTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserTagsIterable listUserTagsPaginator(ListUserTagsRequest listUserTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of listUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest)
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.ListUserTagsIterable responses = client.listUserTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListUserTagsIterable responses = client.listUserTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListUserTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListUserTagsIterable responses = client.listUserTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest) operation.
listUserTagsRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserTagsIterable listUserTagsPaginator(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest) throws NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a variant of listUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest)
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.ListUserTagsIterable responses = client.listUserTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.iam.paginators.ListUserTagsIterable responses = client.listUserTagsPaginator(request);
for (software.amazon.awssdk.services.iam.model.ListUserTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.iam.paginators.ListUserTagsIterable responses = client.listUserTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest) operation.
This is a convenience which creates an instance of the ListUserTagsRequest.Builder avoiding the need to
create one manually via ListUserTagsRequest.builder()
listUserTagsRequest - A Consumer that will call methods on
ListUserTagsRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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.AwsServiceExceptiondefault 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 operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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.AwsServiceExceptiondefault ListUsersResponse listUsers() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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.AwsServiceExceptionlistUsers(ListUsersRequest),
AWS API
Documentationdefault ListUsersIterable listUsersPaginator() throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistUsersPaginator(ListUsersRequest),
AWS API
Documentationdefault 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 operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(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 operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest) operation.
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.AwsServiceExceptiondefault ListVirtualMfaDevicesResponse listVirtualMFADevices(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest) throws AwsServiceException, SdkClientException, IamException
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not
specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be
Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
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.AwsServiceExceptiondefault ListVirtualMfaDevicesResponse listVirtualMFADevices(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest) throws AwsServiceException, SdkClientException, IamException
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not
specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be
Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
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.AwsServiceExceptiondefault ListVirtualMfaDevicesResponse listVirtualMFADevices() throws AwsServiceException, SdkClientException, IamException
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not
specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be
Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
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.AwsServiceExceptionlistVirtualMFADevices(ListVirtualMfaDevicesRequest),
AWS API
Documentationdefault ListVirtualMFADevicesIterable listVirtualMFADevicesPaginator() throws AwsServiceException, SdkClientException, IamException
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not
specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be
Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistVirtualMFADevicesPaginator(ListVirtualMfaDevicesRequest),
AWS API
Documentationdefault ListVirtualMFADevicesIterable listVirtualMFADevicesPaginator(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest) throws AwsServiceException, SdkClientException, IamException
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not
specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be
Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListVirtualMFADevicesIterable listVirtualMFADevicesPaginator(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest) throws AwsServiceException, SdkClientException, IamException
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not
specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be
Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation.
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.AwsServiceExceptiondefault 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 the maximum number of inline policies that you can embed in a group, see IAM and STS quotas 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, see Making query requests in the
IAM User Guide.
putGroupPolicyRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the maximum number of inline policies that you can embed in a group, see IAM and STS quotas 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, see 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 Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRolePermissionsBoundaryResponse putRolePermissionsBoundary(PutRolePermissionsBoundaryRequest putRolePermissionsBoundaryRequest) throws NoSuchEntityException, InvalidInputException, UnmodifiableEntityException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.
You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
putRolePermissionsBoundaryRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 service-linked roles are protected Amazon Web Services resources. 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 Amazon Web Services 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.AwsServiceExceptiondefault PutRolePermissionsBoundaryResponse putRolePermissionsBoundary(Consumer<PutRolePermissionsBoundaryRequest.Builder> putRolePermissionsBoundaryRequest) throws NoSuchEntityException, InvalidInputException, UnmodifiableEntityException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.
You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
This is a convenience which creates an instance of the PutRolePermissionsBoundaryRequest.Builder avoiding
the need to create one manually via PutRolePermissionsBoundaryRequest.builder()
putRolePermissionsBoundaryRequest - A Consumer that will call methods on
PutRolePermissionsBoundaryRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 service-linked roles are protected Amazon Web Services resources. 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 Amazon Web Services 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.AwsServiceExceptiondefault 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 roles, see IAM roles in the IAM User
Guide.
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 the maximum number of inline policies that you can embed with a role, see IAM and STS quotas 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, see Making query requests in the
IAM User Guide.
putRolePolicyRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 roles, see IAM roles in the IAM User
Guide.
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 the maximum number of inline policies that you can embed with a role, see IAM and STS quotas 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, see 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 Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault PutUserPermissionsBoundaryResponse putUserPermissionsBoundary(PutUserPermissionsBoundaryRequest putUserPermissionsBoundaryRequest) throws NoSuchEntityException, InvalidInputException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.
Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
putUserPermissionsBoundaryRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyNotAttachableException - The request failed because Amazon Web Services 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.AwsServiceExceptiondefault PutUserPermissionsBoundaryResponse putUserPermissionsBoundary(Consumer<PutUserPermissionsBoundaryRequest.Builder> putUserPermissionsBoundaryRequest) throws NoSuchEntityException, InvalidInputException, PolicyNotAttachableException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.
Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
This is a convenience which creates an instance of the PutUserPermissionsBoundaryRequest.Builder avoiding
the need to create one manually via PutUserPermissionsBoundaryRequest.builder()
putUserPermissionsBoundaryRequest - A Consumer that will call methods on
PutUserPermissionsBoundaryRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PolicyNotAttachableException - The request failed because Amazon Web Services 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.AwsServiceExceptiondefault 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 the maximum number of inline policies that you can embed in a user, see IAM and STS quotas 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, see Making query requests in the
IAM User Guide.
putUserPolicyRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the maximum number of inline policies that you can embed in a user, see IAM and STS quotas 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, see 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 Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 that 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 roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
removeRoleFromInstanceProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 that 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 roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault ResetServiceSpecificCredentialResponse resetServiceSpecificCredential(ResetServiceSpecificCredentialRequest resetServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Resets the password for a service-specific credential. The new password is Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetServiceSpecificCredentialResponse resetServiceSpecificCredential(Consumer<ResetServiceSpecificCredentialRequest.Builder> resetServiceSpecificCredentialRequest) throws NoSuchEntityException, AwsServiceException, SdkClientException, IamException
Resets the password for a service-specific credential. The new password is Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResyncMfaDeviceResponse resyncMFADevice(ResyncMfaDeviceRequest resyncMfaDeviceRequest) throws InvalidAuthenticationCodeException, NoSuchEntityException, LimitExceededException, ServiceFailureException, ConcurrentModificationException, AwsServiceException, SdkClientException, IamException
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResyncMfaDeviceResponse resyncMFADevice(Consumer<ResyncMfaDeviceRequest.Builder> resyncMfaDeviceRequest) throws InvalidAuthenticationCodeException, NoSuchEntityException, LimitExceededException, ServiceFailureException, ConcurrentModificationException, AwsServiceException, SdkClientException, IamException
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 ListEntitiesForPolicy.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 operation 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 ListEntitiesForPolicy.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault SetSecurityTokenServicePreferencesResponse setSecurityTokenServicePreferences(SetSecurityTokenServicePreferencesRequest setSecurityTokenServicePreferencesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single
endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints
to reduce latency, build in redundancy, and increase session token availability. For information about Regional
endpoints for STS, see Security Token Service
endpoints and quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
To view the current session token version, see the GlobalEndpointTokenVersion entry in the response
of the GetAccountSummary operation.
setSecurityTokenServicePreferencesRequest - ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetSecurityTokenServicePreferencesResponse setSecurityTokenServicePreferences(Consumer<SetSecurityTokenServicePreferencesRequest.Builder> setSecurityTokenServicePreferencesRequest) throws ServiceFailureException, AwsServiceException, SdkClientException, IamException
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single
endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints
to reduce latency, build in redundancy, and increase session token availability. For information about Regional
endpoints for STS, see Security Token Service
endpoints and quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
To view the current session token version, see the GlobalEndpointTokenVersion entry in the response
of the GetAccountSummary operation.
This is a convenience which creates an instance of the SetSecurityTokenServicePreferencesRequest.Builder
avoiding the need to create one manually via SetSecurityTokenServicePreferencesRequest.builder()
setSecurityTokenServicePreferencesRequest - A Consumer that will call methods on
SetSecurityTokenServicePreferencesRequest.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.AwsServiceExceptiondefault 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 operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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.AwsServiceExceptiondefault 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 operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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.AwsServiceExceptiondefault 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 operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault 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 operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault 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 operations and Amazon Web Services 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 simulate resources that don't exist in your account.
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 for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation 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 Amazon Web Services 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
simulatePrincipalPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operations and Amazon Web Services 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 simulate resources that don't exist in your account.
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 for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation 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 Amazon Web Services 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operations and Amazon Web Services 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 simulate resources that don't exist in your account.
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 for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation 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 Amazon Web Services 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operations and Amazon Web Services 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 simulate resources that don't exist in your account.
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 for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation 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 Amazon Web Services 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.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
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(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault TagInstanceProfileResponse tagInstanceProfile(TagInstanceProfileRequest tagInstanceProfileRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
tagInstanceProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagInstanceProfileResponse tagInstanceProfile(Consumer<TagInstanceProfileRequest.Builder> tagInstanceProfileRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
This is a convenience which creates an instance of the TagInstanceProfileRequest.Builder avoiding the
need to create one manually via TagInstanceProfileRequest.builder()
tagInstanceProfileRequest - A Consumer that will call methods on
TagInstanceProfileRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagMfaDeviceResponse tagMFADevice(TagMfaDeviceRequest tagMfaDeviceRequest) throws InvalidInputException, NoSuchEntityException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
tagMfaDeviceRequest - 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagMfaDeviceResponse tagMFADevice(Consumer<TagMfaDeviceRequest.Builder> tagMfaDeviceRequest) throws InvalidInputException, NoSuchEntityException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
This is a convenience which creates an instance of the TagMfaDeviceRequest.Builder avoiding the need to
create one manually via TagMfaDeviceRequest.builder()
tagMfaDeviceRequest - A Consumer that will call methods on
TagMfaDeviceRequest.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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagOpenIdConnectProviderResponse tagOpenIDConnectProvider(TagOpenIdConnectProviderRequest tagOpenIdConnectProviderRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
tagOpenIdConnectProviderRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagOpenIdConnectProviderResponse tagOpenIDConnectProvider(Consumer<TagOpenIdConnectProviderRequest.Builder> tagOpenIdConnectProviderRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
This is a convenience which creates an instance of the TagOpenIdConnectProviderRequest.Builder avoiding
the need to create one manually via TagOpenIdConnectProviderRequest.builder()
tagOpenIdConnectProviderRequest - A Consumer that will call methods on
TagOpenIdConnectProviderRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagPolicyResponse tagPolicy(TagPolicyRequest tagPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
tagPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagPolicyResponse tagPolicy(Consumer<TagPolicyRequest.Builder> tagPolicyRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
This is a convenience which creates an instance of the TagPolicyRequest.Builder avoiding the need to
create one manually via TagPolicyRequest.builder()
tagPolicyRequest - A Consumer that will call methods on
TagPolicyRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagRoleResponse tagRole(TagRoleRequest tagRoleRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
tagRoleRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagRoleResponse tagRole(Consumer<TagRoleRequest.Builder> tagRoleRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
This is a convenience which creates an instance of the TagRoleRequest.Builder avoiding the need to create
one manually via TagRoleRequest.builder()
tagRoleRequest - A Consumer that will call methods on
TagRoleRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagSamlProviderResponse tagSAMLProvider(TagSamlProviderRequest tagSamlProviderRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
tagSamlProviderRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagSamlProviderResponse tagSAMLProvider(Consumer<TagSamlProviderRequest.Builder> tagSamlProviderRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
This is a convenience which creates an instance of the TagSamlProviderRequest.Builder avoiding the need
to create one manually via TagSamlProviderRequest.builder()
tagSamlProviderRequest - A Consumer that will call methods on
TagSamlProviderRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagServerCertificateResponse tagServerCertificate(TagServerCertificateRequest tagServerCertificateRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
tagServerCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagServerCertificateResponse tagServerCertificate(Consumer<TagServerCertificateRequest.Builder> tagServerCertificateRequest) throws NoSuchEntityException, InvalidInputException, LimitExceededException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
This is a convenience which creates an instance of the TagServerCertificateRequest.Builder avoiding the
need to create one manually via TagServerCertificateRequest.builder()
tagServerCertificateRequest - A Consumer that will call methods on
TagServerCertificateRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagUserResponse tagUser(TagUserRequest tagUserRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
tagUserRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagUserResponse tagUser(Consumer<TagUserRequest.Builder> tagUserRequest) throws NoSuchEntityException, LimitExceededException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
This is a convenience which creates an instance of the TagUserRequest.Builder avoiding the need to create
one manually via TagUserRequest.builder()
tagUserRequest - A Consumer that will call methods on
TagUserRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagInstanceProfileResponse untagInstanceProfile(UntagInstanceProfileRequest untagInstanceProfileRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagInstanceProfileRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagInstanceProfileResponse untagInstanceProfile(Consumer<UntagInstanceProfileRequest.Builder> untagInstanceProfileRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagInstanceProfileRequest.Builder avoiding the
need to create one manually via UntagInstanceProfileRequest.builder()
untagInstanceProfileRequest - A Consumer that will call methods on
UntagInstanceProfileRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagMfaDeviceResponse untagMFADevice(UntagMfaDeviceRequest untagMfaDeviceRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagMfaDeviceRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagMfaDeviceResponse untagMFADevice(Consumer<UntagMfaDeviceRequest.Builder> untagMfaDeviceRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagMfaDeviceRequest.Builder avoiding the need to
create one manually via UntagMfaDeviceRequest.builder()
untagMfaDeviceRequest - A Consumer that will call methods on
UntagMfaDeviceRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagOpenIdConnectProviderResponse untagOpenIDConnectProvider(UntagOpenIdConnectProviderRequest untagOpenIdConnectProviderRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagOpenIdConnectProviderRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagOpenIdConnectProviderResponse untagOpenIDConnectProvider(Consumer<UntagOpenIdConnectProviderRequest.Builder> untagOpenIdConnectProviderRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagOpenIdConnectProviderRequest.Builder avoiding
the need to create one manually via UntagOpenIdConnectProviderRequest.builder()
untagOpenIdConnectProviderRequest - A Consumer that will call methods on
UntagOpenIdConnectProviderRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagPolicyResponse untagPolicy(UntagPolicyRequest untagPolicyRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagPolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagPolicyResponse untagPolicy(Consumer<UntagPolicyRequest.Builder> untagPolicyRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagPolicyRequest.Builder avoiding the need to
create one manually via UntagPolicyRequest.builder()
untagPolicyRequest - A Consumer that will call methods on
UntagPolicyRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagRoleResponse untagRole(UntagRoleRequest untagRoleRequest) throws NoSuchEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagRoleRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagRoleResponse untagRole(Consumer<UntagRoleRequest.Builder> untagRoleRequest) throws NoSuchEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagRoleRequest.Builder avoiding the need to
create one manually via UntagRoleRequest.builder()
untagRoleRequest - A Consumer that will call methods on
UntagRoleRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagSamlProviderResponse untagSAMLProvider(UntagSamlProviderRequest untagSamlProviderRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagSamlProviderRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagSamlProviderResponse untagSAMLProvider(Consumer<UntagSamlProviderRequest.Builder> untagSamlProviderRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagSamlProviderRequest.Builder avoiding the need
to create one manually via UntagSamlProviderRequest.builder()
untagSamlProviderRequest - A Consumer that will call methods on
UntagSamlProviderRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagServerCertificateResponse untagServerCertificate(UntagServerCertificateRequest untagServerCertificateRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
untagServerCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagServerCertificateResponse untagServerCertificate(Consumer<UntagServerCertificateRequest.Builder> untagServerCertificateRequest) throws NoSuchEntityException, InvalidInputException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
This is a convenience which creates an instance of the UntagServerCertificateRequest.Builder avoiding the
need to create one manually via UntagServerCertificateRequest.builder()
untagServerCertificateRequest - A Consumer that will call methods on
UntagServerCertificateRequest.Builder to create a
request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagUserResponse untagUser(UntagUserRequest untagUserRequest) throws NoSuchEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
untagUserRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagUserResponse untagUser(Consumer<UntagUserRequest.Builder> untagUserRequest) throws NoSuchEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
This is a convenience which creates an instance of the UntagUserRequest.Builder avoiding the need to
create one manually via UntagUserRequest.builder()
untagUserRequest - A Consumer that will call methods on
UntagUserRequest.Builder to create a request.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required. This operation
works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage
Amazon Web Services account root user credentials even if the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is not required. This operation
works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage
Amazon Web Services account root user credentials even if the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault UpdateAccountPasswordPolicyResponse updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Updates the password policy settings for the Amazon Web Services account.
This operation 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. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault UpdateAccountPasswordPolicyResponse updateAccountPasswordPolicy(Consumer<UpdateAccountPasswordPolicyRequest.Builder> updateAccountPasswordPolicyRequest) throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Updates the password policy settings for the Amazon Web Services account.
This operation 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. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault UpdateAccountPasswordPolicyResponse updateAccountPasswordPolicy() throws NoSuchEntityException, MalformedPolicyDocumentException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Updates the password policy settings for the Amazon Web Services account.
This operation 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. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptionupdateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest),
AWS API Documentationdefault 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, see Using roles to delegate permissions and federate identities.
updateAssumeRolePolicyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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, see 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
account limits. The error message describes the limit exceeded.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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.
The person making the request (the principal), must have permission to change the role group with the old name
and the new name. For example, to change the group named Managers to MGRs, the
principal must have a policy that allows them to update both groups. If the principal has permission to update
the Managers group, but not the MGRs group, then the update fails. For more information
about permissions, see Access
management.
updateGroupRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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.
The person making the request (the principal), must have permission to change the role group with the old name
and the new name. For example, to change the group named Managers to MGRs, the
principal must have a policy that allows them to update both groups. If the principal has permission to update
the Managers group, but not the MGRs group, then the update fails. For more information
about permissions, see Access
management.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault UpdateLoginProfileResponse updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault UpdateLoginProfileResponse updateLoginProfile(Consumer<UpdateLoginProfileRequest.Builder> updateLoginProfileRequest) throws EntityTemporarilyUnmodifiableException, NoSuchEntityException, PasswordPolicyViolationException, LimitExceededException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider 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.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint.
Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider 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.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint.
Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation 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 a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoleResponse updateRole(UpdateRoleRequest updateRoleRequest) throws UnmodifiableEntityException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Updates the description or maximum session duration setting of a role.
updateRoleRequest - UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoleResponse updateRole(Consumer<UpdateRoleRequest.Builder> updateRoleRequest) throws UnmodifiableEntityException, NoSuchEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Updates the description or maximum session duration setting of a role.
This is a convenience which creates an instance of the UpdateRoleRequest.Builder avoiding the need to
create one manually via UpdateRoleRequest.builder()
updateRoleRequest - A Consumer that will call methods on
UpdateRoleRequest.Builder to create a request.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoleDescriptionResponse updateRoleDescription(UpdateRoleDescriptionRequest updateRoleDescriptionRequest) throws NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the
Description parameter in the UpdateRole operation.
updateRoleDescriptionRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault UpdateRoleDescriptionResponse updateRoleDescription(Consumer<UpdateRoleDescriptionRequest.Builder> updateRoleDescriptionRequest) throws NoSuchEntityException, UnmodifiableEntityException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the
Description parameter in the UpdateRole operation.
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 a resource entity that does not exist. The error message
describes the resource.UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. 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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 operation 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 operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
updateSshPublicKeyRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
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.
The person making the request (the principal), must have permission to change the server certificate with the old
name and the new name. For example, to change the certificate named ProductionCert to
ProdCert, the principal must have a policy that allows them to update both certificates. If the
principal has permission to update the ProductionCert group, but not the ProdCert
certificate, then the update fails. For more information about permissions, see Access management in the IAM User
Guide.
updateServerCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
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.
The person making the request (the principal), must have permission to change the server certificate with the old
name and the new name. For example, to change the certificate named ProductionCert to
ProdCert, the principal must have a policy that allows them to update both certificates. If the
principal has permission to update the ProductionCert group, but not the ProdCert
certificate, then the update fails. 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 a resource entity that does not exist. The error message
describes the resource.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 Amazon Web Services
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.AwsServiceExceptiondefault 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 operation
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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation
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 a resource entity that does not exist. The error message
describes the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation 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 user name is determined implicitly based on the Amazon
Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services account has no associated users.
updateSigningCertificateRequest - NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault 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 operation 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 user name is determined implicitly based on the Amazon
Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.AwsServiceExceptiondefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws NoSuchEntityException, LimitExceededException, EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, ConcurrentModificationException, 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws NoSuchEntityException, LimitExceededException, EntityAlreadyExistsException, EntityTemporarilyUnmodifiableException, ConcurrentModificationException, 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 a resource entity that does not exist. The error message
describes the resource.LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
uploadSshPublicKeyRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault 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 operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the 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 Amazon Web Services
account limits. The error message describes the limit exceeded.NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message
describes the resource.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.AwsServiceExceptiondefault UploadServerCertificateResponse uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, MalformedCertificateException, KeyPairMismatchException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Uploads a server certificate entity for the Amazon Web Services 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 Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas 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, see Signing Amazon Web Services
API requests in the Amazon Web Services General Reference. For general information about using the
Query API with IAM, see 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 Amazon Web Services
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.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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadServerCertificateResponse uploadServerCertificate(Consumer<UploadServerCertificateRequest.Builder> uploadServerCertificateRequest) throws LimitExceededException, InvalidInputException, EntityAlreadyExistsException, MalformedCertificateException, KeyPairMismatchException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Uploads a server certificate entity for the Amazon Web Services 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 Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas 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, see Signing Amazon Web Services
API requests in the Amazon Web Services General Reference. For general information about using the
Query API with IAM, see 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 Amazon Web Services
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.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.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadSigningCertificateResponse uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest) throws LimitExceededException, EntityAlreadyExistsException, MalformedCertificateException, InvalidCertificateException, DuplicateCertificateException, NoSuchEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services
services require you to use certificates to validate requests that are signed with a corresponding private key.
When you upload the certificate, its default status is Active.
For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.
If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services account has no associated users.
Because the body of an 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, see Signing Amazon Web
Services API requests in the Amazon Web Services General Reference. For general information about
using the Query API with IAM, see Making query requests in the
IAM User Guide.
uploadSigningCertificateRequest - LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadSigningCertificateResponse uploadSigningCertificate(Consumer<UploadSigningCertificateRequest.Builder> uploadSigningCertificateRequest) throws LimitExceededException, EntityAlreadyExistsException, MalformedCertificateException, InvalidCertificateException, DuplicateCertificateException, NoSuchEntityException, ConcurrentModificationException, ServiceFailureException, AwsServiceException, SdkClientException, IamException
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services
services require you to use certificates to validate requests that are signed with a corresponding private key.
When you upload the certificate, its default status is Active.
For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.
If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services account has no associated users.
Because the body of an 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, see Signing Amazon Web
Services API requests in the Amazon Web Services General Reference. For general information about
using the Query API with IAM, see 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 Amazon Web Services
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 a resource entity that does not exist. The error message
describes the resource.ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously.
Wait a few minutes and submit your request again.ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault IamWaiter waiter()
IamWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
IamWaiterstatic IamClientBuilder builder()
IamClient.static ServiceMetadata serviceMetadata()
default IamServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.