Interface IamAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddClientIDToOpenIDConnectProvider
(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.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.addRoleToInstanceProfile
(Consumer<AddRoleToInstanceProfileRequest.Builder> addRoleToInstanceProfileRequest) Adds the specified IAM role to the specified instance profile.addRoleToInstanceProfile
(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest) Adds the specified IAM role to the specified instance profile.default CompletableFuture
<AddUserToGroupResponse> addUserToGroup
(Consumer<AddUserToGroupRequest.Builder> addUserToGroupRequest) Adds the specified user to the specified group.default CompletableFuture
<AddUserToGroupResponse> addUserToGroup
(AddUserToGroupRequest addUserToGroupRequest) Adds the specified user to the specified group.attachGroupPolicy
(Consumer<AttachGroupPolicyRequest.Builder> attachGroupPolicyRequest) Attaches the specified managed policy to the specified IAM group.attachGroupPolicy
(AttachGroupPolicyRequest attachGroupPolicyRequest) Attaches the specified managed policy to the specified IAM group.attachRolePolicy
(Consumer<AttachRolePolicyRequest.Builder> attachRolePolicyRequest) Attaches the specified managed policy to the specified IAM role.attachRolePolicy
(AttachRolePolicyRequest attachRolePolicyRequest) Attaches the specified managed policy to the specified IAM role.attachUserPolicy
(Consumer<AttachUserPolicyRequest.Builder> attachUserPolicyRequest) Attaches the specified managed policy to the specified user.attachUserPolicy
(AttachUserPolicyRequest attachUserPolicyRequest) Attaches the specified managed policy to the specified user.static IamAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aIamAsyncClient
.default CompletableFuture
<ChangePasswordResponse> changePassword
(Consumer<ChangePasswordRequest.Builder> changePasswordRequest) Changes the password of the IAM user who is calling this operation.default CompletableFuture
<ChangePasswordResponse> changePassword
(ChangePasswordRequest changePasswordRequest) Changes the password of the IAM user who is calling this operation.default CompletableFuture
<CreateAccessKeyResponse> Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user.default CompletableFuture
<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 CompletableFuture
<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.createAccountAlias
(Consumer<CreateAccountAliasRequest.Builder> createAccountAliasRequest) Creates an alias for your Amazon Web Services account.createAccountAlias
(CreateAccountAliasRequest createAccountAliasRequest) Creates an alias for your Amazon Web Services account.default CompletableFuture
<CreateGroupResponse> createGroup
(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates a new group.default CompletableFuture
<CreateGroupResponse> createGroup
(CreateGroupRequest createGroupRequest) Creates a new group.createInstanceProfile
(Consumer<CreateInstanceProfileRequest.Builder> createInstanceProfileRequest) Creates a new instance profile.createInstanceProfile
(CreateInstanceProfileRequest createInstanceProfileRequest) Creates a new instance profile.createLoginProfile
(Consumer<CreateLoginProfileRequest.Builder> createLoginProfileRequest) Creates a password for the specified IAM user.createLoginProfile
(CreateLoginProfileRequest createLoginProfileRequest) Creates a password for the specified IAM user.createOpenIDConnectProvider
(Consumer<CreateOpenIdConnectProviderRequest.Builder> createOpenIdConnectProviderRequest) Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).createOpenIDConnectProvider
(CreateOpenIdConnectProviderRequest createOpenIdConnectProviderRequest) Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).default CompletableFuture
<CreatePolicyResponse> createPolicy
(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) Creates a new managed policy for your Amazon Web Services account.default CompletableFuture
<CreatePolicyResponse> createPolicy
(CreatePolicyRequest createPolicyRequest) Creates a new managed policy for your Amazon Web Services account.createPolicyVersion
(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest) Creates a new version of the specified managed policy.createPolicyVersion
(CreatePolicyVersionRequest createPolicyVersionRequest) Creates a new version of the specified managed policy.default CompletableFuture
<CreateRoleResponse> createRole
(Consumer<CreateRoleRequest.Builder> createRoleRequest) Creates a new role for your Amazon Web Services account.default CompletableFuture
<CreateRoleResponse> createRole
(CreateRoleRequest createRoleRequest) Creates a new role for your Amazon Web Services account.createSAMLProvider
(Consumer<CreateSamlProviderRequest.Builder> createSamlProviderRequest) Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.createSAMLProvider
(CreateSamlProviderRequest createSamlProviderRequest) Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.createServiceLinkedRole
(Consumer<CreateServiceLinkedRoleRequest.Builder> createServiceLinkedRoleRequest) Creates an IAM role that is linked to a specific Amazon Web Services service.createServiceLinkedRole
(CreateServiceLinkedRoleRequest createServiceLinkedRoleRequest) Creates an IAM role that is linked to a specific Amazon Web Services service.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.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 CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new IAM user for your Amazon Web Services account.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates a new IAM user for your Amazon Web Services account.createVirtualMFADevice
(Consumer<CreateVirtualMfaDeviceRequest.Builder> createVirtualMfaDeviceRequest) Creates a new virtual MFA device for the Amazon Web Services account.createVirtualMFADevice
(CreateVirtualMfaDeviceRequest createVirtualMfaDeviceRequest) Creates a new virtual MFA device for the Amazon Web Services account.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.deactivateMFADevice
(DeactivateMfaDeviceRequest deactivateMfaDeviceRequest) Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.default CompletableFuture
<DeleteAccessKeyResponse> deleteAccessKey
(Consumer<DeleteAccessKeyRequest.Builder> deleteAccessKeyRequest) Deletes the access key pair associated with the specified IAM user.default CompletableFuture
<DeleteAccessKeyResponse> deleteAccessKey
(DeleteAccessKeyRequest deleteAccessKeyRequest) Deletes the access key pair associated with the specified IAM user.deleteAccountAlias
(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest) Deletes the specified Amazon Web Services account alias.deleteAccountAlias
(DeleteAccountAliasRequest deleteAccountAliasRequest) Deletes the specified Amazon Web Services account alias.Deletes the password policy for the Amazon Web Services account.deleteAccountPasswordPolicy
(Consumer<DeleteAccountPasswordPolicyRequest.Builder> deleteAccountPasswordPolicyRequest) Deletes the password policy for the Amazon Web Services account.deleteAccountPasswordPolicy
(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest) Deletes the password policy for the Amazon Web Services account.default CompletableFuture
<DeleteGroupResponse> deleteGroup
(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes the specified IAM group.default CompletableFuture
<DeleteGroupResponse> deleteGroup
(DeleteGroupRequest deleteGroupRequest) Deletes the specified IAM group.deleteGroupPolicy
(Consumer<DeleteGroupPolicyRequest.Builder> deleteGroupPolicyRequest) Deletes the specified inline policy that is embedded in the specified IAM group.deleteGroupPolicy
(DeleteGroupPolicyRequest deleteGroupPolicyRequest) Deletes the specified inline policy that is embedded in the specified IAM group.deleteInstanceProfile
(Consumer<DeleteInstanceProfileRequest.Builder> deleteInstanceProfileRequest) Deletes the specified instance profile.deleteInstanceProfile
(DeleteInstanceProfileRequest deleteInstanceProfileRequest) Deletes the specified instance profile.deleteLoginProfile
(Consumer<DeleteLoginProfileRequest.Builder> deleteLoginProfileRequest) Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.deleteLoginProfile
(DeleteLoginProfileRequest deleteLoginProfileRequest) Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.deleteOpenIDConnectProvider
(Consumer<DeleteOpenIdConnectProviderRequest.Builder> deleteOpenIdConnectProviderRequest) Deletes an OpenID Connect identity provider (IdP) resource object in IAM.deleteOpenIDConnectProvider
(DeleteOpenIdConnectProviderRequest deleteOpenIdConnectProviderRequest) Deletes an OpenID Connect identity provider (IdP) resource object in IAM.default CompletableFuture
<DeletePolicyResponse> deletePolicy
(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Deletes the specified managed policy.default CompletableFuture
<DeletePolicyResponse> deletePolicy
(DeletePolicyRequest deletePolicyRequest) Deletes the specified managed policy.deletePolicyVersion
(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest) Deletes the specified version from the specified managed policy.deletePolicyVersion
(DeletePolicyVersionRequest deletePolicyVersionRequest) Deletes the specified version from the specified managed policy.default CompletableFuture
<DeleteRoleResponse> deleteRole
(Consumer<DeleteRoleRequest.Builder> deleteRoleRequest) Deletes the specified role.default CompletableFuture
<DeleteRoleResponse> deleteRole
(DeleteRoleRequest deleteRoleRequest) Deletes the specified role.deleteRolePermissionsBoundary
(Consumer<DeleteRolePermissionsBoundaryRequest.Builder> deleteRolePermissionsBoundaryRequest) Deletes the permissions boundary for the specified IAM role.deleteRolePermissionsBoundary
(DeleteRolePermissionsBoundaryRequest deleteRolePermissionsBoundaryRequest) Deletes the permissions boundary for the specified IAM role.deleteRolePolicy
(Consumer<DeleteRolePolicyRequest.Builder> deleteRolePolicyRequest) Deletes the specified inline policy that is embedded in the specified IAM role.deleteRolePolicy
(DeleteRolePolicyRequest deleteRolePolicyRequest) Deletes the specified inline policy that is embedded in the specified IAM role.deleteSAMLProvider
(Consumer<DeleteSamlProviderRequest.Builder> deleteSamlProviderRequest) Deletes a SAML provider resource in IAM.deleteSAMLProvider
(DeleteSamlProviderRequest deleteSamlProviderRequest) Deletes a SAML provider resource in IAM.deleteServerCertificate
(Consumer<DeleteServerCertificateRequest.Builder> deleteServerCertificateRequest) Deletes the specified server certificate.deleteServerCertificate
(DeleteServerCertificateRequest deleteServerCertificateRequest) Deletes the specified server certificate.deleteServiceLinkedRole
(Consumer<DeleteServiceLinkedRoleRequest.Builder> deleteServiceLinkedRoleRequest) Submits a service-linked role deletion request and returns aDeletionTaskId
, which you can use to check the status of the deletion.deleteServiceLinkedRole
(DeleteServiceLinkedRoleRequest deleteServiceLinkedRoleRequest) Submits a service-linked role deletion request and returns aDeletionTaskId
, which you can use to check the status of the deletion.deleteServiceSpecificCredential
(Consumer<DeleteServiceSpecificCredentialRequest.Builder> deleteServiceSpecificCredentialRequest) Deletes the specified service-specific credential.deleteServiceSpecificCredential
(DeleteServiceSpecificCredentialRequest deleteServiceSpecificCredentialRequest) Deletes the specified service-specific credential.deleteSigningCertificate
(Consumer<DeleteSigningCertificateRequest.Builder> deleteSigningCertificateRequest) Deletes a signing certificate associated with the specified IAM user.deleteSigningCertificate
(DeleteSigningCertificateRequest deleteSigningCertificateRequest) Deletes a signing certificate associated with the specified IAM user.deleteSSHPublicKey
(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) Deletes the specified SSH public key.deleteSSHPublicKey
(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) Deletes the specified SSH public key.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes the specified IAM user.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes the specified IAM user.deleteUserPermissionsBoundary
(Consumer<DeleteUserPermissionsBoundaryRequest.Builder> deleteUserPermissionsBoundaryRequest) Deletes the permissions boundary for the specified IAM user.deleteUserPermissionsBoundary
(DeleteUserPermissionsBoundaryRequest deleteUserPermissionsBoundaryRequest) Deletes the permissions boundary for the specified IAM user.deleteUserPolicy
(Consumer<DeleteUserPolicyRequest.Builder> deleteUserPolicyRequest) Deletes the specified inline policy that is embedded in the specified IAM user.deleteUserPolicy
(DeleteUserPolicyRequest deleteUserPolicyRequest) Deletes the specified inline policy that is embedded in the specified IAM user.deleteVirtualMFADevice
(Consumer<DeleteVirtualMfaDeviceRequest.Builder> deleteVirtualMfaDeviceRequest) Deletes a virtual MFA device.deleteVirtualMFADevice
(DeleteVirtualMfaDeviceRequest deleteVirtualMfaDeviceRequest) Deletes a virtual MFA device.detachGroupPolicy
(Consumer<DetachGroupPolicyRequest.Builder> detachGroupPolicyRequest) Removes the specified managed policy from the specified IAM group.detachGroupPolicy
(DetachGroupPolicyRequest detachGroupPolicyRequest) Removes the specified managed policy from the specified IAM group.detachRolePolicy
(Consumer<DetachRolePolicyRequest.Builder> detachRolePolicyRequest) Removes the specified managed policy from the specified role.detachRolePolicy
(DetachRolePolicyRequest detachRolePolicyRequest) Removes the specified managed policy from the specified role.detachUserPolicy
(Consumer<DetachUserPolicyRequest.Builder> detachUserPolicyRequest) Removes the specified managed policy from the specified user.detachUserPolicy
(DetachUserPolicyRequest detachUserPolicyRequest) Removes the specified managed policy from the specified user.default CompletableFuture
<EnableMfaDeviceResponse> enableMFADevice
(Consumer<EnableMfaDeviceRequest.Builder> enableMfaDeviceRequest) Enables the specified MFA device and associates it with the specified IAM user.default CompletableFuture
<EnableMfaDeviceResponse> enableMFADevice
(EnableMfaDeviceRequest enableMfaDeviceRequest) Enables the specified MFA device and associates it with the specified IAM user.Generates a credential report for the Amazon Web Services account.generateCredentialReport
(Consumer<GenerateCredentialReportRequest.Builder> generateCredentialReportRequest) Generates a credential report for the Amazon Web Services account.generateCredentialReport
(GenerateCredentialReportRequest generateCredentialReportRequest) Generates a credential report for the Amazon Web Services account.generateOrganizationsAccessReport
(Consumer<GenerateOrganizationsAccessReportRequest.Builder> generateOrganizationsAccessReportRequest) Generates a report for service last accessed data for Organizations.generateOrganizationsAccessReport
(GenerateOrganizationsAccessReportRequest generateOrganizationsAccessReportRequest) Generates a report for service last accessed data for Organizations.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.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.getAccessKeyLastUsed
(Consumer<GetAccessKeyLastUsedRequest.Builder> getAccessKeyLastUsedRequest) Retrieves information about when the specified access key was last used.getAccessKeyLastUsed
(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest) Retrieves information about when the specified access key was last used.Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another.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.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.This is a variant ofgetAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation.getAccountAuthorizationDetailsPaginator
(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest) This is a variant ofgetAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation.getAccountAuthorizationDetailsPaginator
(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest) This is a variant ofgetAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation.Retrieves the password policy for the Amazon Web Services account.getAccountPasswordPolicy
(Consumer<GetAccountPasswordPolicyRequest.Builder> getAccountPasswordPolicyRequest) Retrieves the password policy for the Amazon Web Services account.getAccountPasswordPolicy
(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest) Retrieves the password policy for the Amazon Web Services account.Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.getAccountSummary
(Consumer<GetAccountSummaryRequest.Builder> getAccountSummaryRequest) Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.getAccountSummary
(GetAccountSummaryRequest getAccountSummaryRequest) Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.getContextKeysForCustomPolicy
(Consumer<GetContextKeysForCustomPolicyRequest.Builder> getContextKeysForCustomPolicyRequest) Gets a list of all of the context keys referenced in the input policies.getContextKeysForCustomPolicy
(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest) Gets a list of all of the context keys referenced in the input policies.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.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.Retrieves a credential report for the Amazon Web Services account.getCredentialReport
(Consumer<GetCredentialReportRequest.Builder> getCredentialReportRequest) Retrieves a credential report for the Amazon Web Services account.getCredentialReport
(GetCredentialReportRequest getCredentialReportRequest) Retrieves a credential report for the Amazon Web Services account.default CompletableFuture
<GetGroupResponse> getGroup
(Consumer<GetGroupRequest.Builder> getGroupRequest) Returns a list of IAM users that are in the specified IAM group.default CompletableFuture
<GetGroupResponse> getGroup
(GetGroupRequest getGroupRequest) Returns a list of IAM users that are in the specified IAM group.default GetGroupPublisher
getGroupPaginator
(Consumer<GetGroupRequest.Builder> getGroupRequest) This is a variant ofgetGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation.default GetGroupPublisher
getGroupPaginator
(GetGroupRequest getGroupRequest) This is a variant ofgetGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation.default CompletableFuture
<GetGroupPolicyResponse> getGroupPolicy
(Consumer<GetGroupPolicyRequest.Builder> getGroupPolicyRequest) Retrieves the specified inline policy document that is embedded in the specified IAM group.default CompletableFuture
<GetGroupPolicyResponse> getGroupPolicy
(GetGroupPolicyRequest getGroupPolicyRequest) Retrieves the specified inline policy document that is embedded in the specified IAM group.getInstanceProfile
(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest) Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role.getInstanceProfile
(GetInstanceProfileRequest getInstanceProfileRequest) Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role.default CompletableFuture
<GetLoginProfileResponse> getLoginProfile
(Consumer<GetLoginProfileRequest.Builder> getLoginProfileRequest) Retrieves the user name for the specified IAM user.default CompletableFuture
<GetLoginProfileResponse> getLoginProfile
(GetLoginProfileRequest getLoginProfileRequest) Retrieves the user name for the specified IAM user.default CompletableFuture
<GetMfaDeviceResponse> getMFADevice
(Consumer<GetMfaDeviceRequest.Builder> getMfaDeviceRequest) Retrieves information about an MFA device for a specified user.default CompletableFuture
<GetMfaDeviceResponse> getMFADevice
(GetMfaDeviceRequest getMfaDeviceRequest) Retrieves information about an MFA device for a specified user.getOpenIDConnectProvider
(Consumer<GetOpenIdConnectProviderRequest.Builder> getOpenIdConnectProviderRequest) Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.getOpenIDConnectProvider
(GetOpenIdConnectProviderRequest getOpenIdConnectProviderRequest) Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.getOrganizationsAccessReport
(Consumer<GetOrganizationsAccessReportRequest.Builder> getOrganizationsAccessReportRequest) Retrieves the service last accessed data report for Organizations that was previously generated using theGenerateOrganizationsAccessReport
operation.getOrganizationsAccessReport
(GetOrganizationsAccessReportRequest getOrganizationsAccessReportRequest) Retrieves the service last accessed data report for Organizations that was previously generated using theGenerateOrganizationsAccessReport
operation.default CompletableFuture
<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 CompletableFuture
<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.getPolicyVersion
(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Retrieves information about the specified version of the specified managed policy, including the policy document.getPolicyVersion
(GetPolicyVersionRequest getPolicyVersionRequest) Retrieves information about the specified version of the specified managed policy, including the policy document.default CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<GetRolePolicyResponse> getRolePolicy
(Consumer<GetRolePolicyRequest.Builder> getRolePolicyRequest) Retrieves the specified inline policy document that is embedded with the specified IAM role.default CompletableFuture
<GetRolePolicyResponse> getRolePolicy
(GetRolePolicyRequest getRolePolicyRequest) Retrieves the specified inline policy document that is embedded with the specified IAM role.default CompletableFuture
<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 CompletableFuture
<GetSamlProviderResponse> getSAMLProvider
(GetSamlProviderRequest getSamlProviderRequest) Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.getServerCertificate
(Consumer<GetServerCertificateRequest.Builder> getServerCertificateRequest) Retrieves information about the specified server certificate stored in IAM.getServerCertificate
(GetServerCertificateRequest getServerCertificateRequest) Retrieves information about the specified server certificate stored in IAM.getServiceLastAccessedDetails
(Consumer<GetServiceLastAccessedDetailsRequest.Builder> getServiceLastAccessedDetailsRequest) Retrieves a service last accessed report that was created using theGenerateServiceLastAccessedDetails
operation.getServiceLastAccessedDetails
(GetServiceLastAccessedDetailsRequest getServiceLastAccessedDetailsRequest) Retrieves a service last accessed report that was created using theGenerateServiceLastAccessedDetails
operation.getServiceLastAccessedDetailsWithEntities
(Consumer<GetServiceLastAccessedDetailsWithEntitiesRequest.Builder> getServiceLastAccessedDetailsWithEntitiesRequest) After you generate a group or policy report using theGenerateServiceLastAccessedDetails
operation, you can use theJobId
parameter inGetServiceLastAccessedDetailsWithEntities
.getServiceLastAccessedDetailsWithEntities
(GetServiceLastAccessedDetailsWithEntitiesRequest getServiceLastAccessedDetailsWithEntitiesRequest) After you generate a group or policy report using theGenerateServiceLastAccessedDetails
operation, you can use theJobId
parameter inGetServiceLastAccessedDetailsWithEntities
.getServiceLinkedRoleDeletionStatus
(Consumer<GetServiceLinkedRoleDeletionStatusRequest.Builder> getServiceLinkedRoleDeletionStatusRequest) Retrieves the status of your service-linked role deletion.getServiceLinkedRoleDeletionStatus
(GetServiceLinkedRoleDeletionStatusRequest getServiceLinkedRoleDeletionStatusRequest) Retrieves the status of your service-linked role deletion.default CompletableFuture
<GetSshPublicKeyResponse> getSSHPublicKey
(Consumer<GetSshPublicKeyRequest.Builder> getSshPublicKeyRequest) Retrieves the specified SSH public key, including metadata about the key.default CompletableFuture
<GetSshPublicKeyResponse> getSSHPublicKey
(GetSshPublicKeyRequest getSshPublicKeyRequest) Retrieves the specified SSH public key, including metadata about the key.default CompletableFuture
<GetUserResponse> getUser()
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.default CompletableFuture
<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 CompletableFuture
<GetUserResponse> getUser
(GetUserRequest getUserRequest) Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.default CompletableFuture
<GetUserPolicyResponse> getUserPolicy
(Consumer<GetUserPolicyRequest.Builder> getUserPolicyRequest) Retrieves the specified inline policy document that is embedded in the specified IAM user.default CompletableFuture
<GetUserPolicyResponse> getUserPolicy
(GetUserPolicyRequest getUserPolicyRequest) Retrieves the specified inline policy document that is embedded in the specified IAM user.default CompletableFuture
<ListAccessKeysResponse> Returns information about the access key IDs associated with the specified IAM user.default CompletableFuture
<ListAccessKeysResponse> listAccessKeys
(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest) Returns information about the access key IDs associated with the specified IAM user.default CompletableFuture
<ListAccessKeysResponse> listAccessKeys
(ListAccessKeysRequest listAccessKeysRequest) Returns information about the access key IDs associated with the specified IAM user.default ListAccessKeysPublisher
This is a variant oflistAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation.default ListAccessKeysPublisher
listAccessKeysPaginator
(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest) This is a variant oflistAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation.default ListAccessKeysPublisher
listAccessKeysPaginator
(ListAccessKeysRequest listAccessKeysRequest) This is a variant oflistAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation.Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).listAccountAliases
(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).listAccountAliases
(ListAccountAliasesRequest listAccountAliasesRequest) Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).default ListAccountAliasesPublisher
This is a variant oflistAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation.default ListAccountAliasesPublisher
listAccountAliasesPaginator
(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) This is a variant oflistAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation.default ListAccountAliasesPublisher
listAccountAliasesPaginator
(ListAccountAliasesRequest listAccountAliasesRequest) This is a variant oflistAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation.listAttachedGroupPolicies
(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest) Lists all managed policies that are attached to the specified IAM group.listAttachedGroupPolicies
(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest) Lists all managed policies that are attached to the specified IAM group.listAttachedGroupPoliciesPaginator
(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest) This is a variant oflistAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation.listAttachedGroupPoliciesPaginator
(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest) This is a variant oflistAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation.listAttachedRolePolicies
(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest) Lists all managed policies that are attached to the specified IAM role.listAttachedRolePolicies
(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest) Lists all managed policies that are attached to the specified IAM role.listAttachedRolePoliciesPaginator
(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest) This is a variant oflistAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation.listAttachedRolePoliciesPaginator
(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest) This is a variant oflistAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation.listAttachedUserPolicies
(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest) Lists all managed policies that are attached to the specified IAM user.listAttachedUserPolicies
(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest) Lists all managed policies that are attached to the specified IAM user.listAttachedUserPoliciesPaginator
(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest) This is a variant oflistAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation.listAttachedUserPoliciesPaginator
(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest) This is a variant oflistAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation.listEntitiesForPolicy
(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest) Lists all IAM users, groups, and roles that the specified managed policy is attached to.listEntitiesForPolicy
(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest) Lists all IAM users, groups, and roles that the specified managed policy is attached to.default ListEntitiesForPolicyPublisher
listEntitiesForPolicyPaginator
(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest) This is a variant oflistEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation.default ListEntitiesForPolicyPublisher
listEntitiesForPolicyPaginator
(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest) This is a variant oflistEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation.listGroupPolicies
(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM group.listGroupPolicies
(ListGroupPoliciesRequest listGroupPoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM group.default ListGroupPoliciesPublisher
listGroupPoliciesPaginator
(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest) This is a variant oflistGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation.default ListGroupPoliciesPublisher
listGroupPoliciesPaginator
(ListGroupPoliciesRequest listGroupPoliciesRequest) This is a variant oflistGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation.default CompletableFuture
<ListGroupsResponse> Lists the IAM groups that have the specified path prefix.default CompletableFuture
<ListGroupsResponse> listGroups
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists the IAM groups that have the specified path prefix.default CompletableFuture
<ListGroupsResponse> listGroups
(ListGroupsRequest listGroupsRequest) Lists the IAM groups that have the specified path prefix.listGroupsForUser
(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest) Lists the IAM groups that the specified IAM user belongs to.listGroupsForUser
(ListGroupsForUserRequest listGroupsForUserRequest) Lists the IAM groups that the specified IAM user belongs to.default ListGroupsForUserPublisher
listGroupsForUserPaginator
(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest) This is a variant oflistGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation.default ListGroupsForUserPublisher
listGroupsForUserPaginator
(ListGroupsForUserRequest listGroupsForUserRequest) This is a variant oflistGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation.default ListGroupsPublisher
This is a variant oflistGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.default ListGroupsPublisher
listGroupsPaginator
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.default ListGroupsPublisher
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation.Lists the instance profiles that have the specified path prefix.listInstanceProfiles
(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest) Lists the instance profiles that have the specified path prefix.listInstanceProfiles
(ListInstanceProfilesRequest listInstanceProfilesRequest) Lists the instance profiles that have the specified path prefix.listInstanceProfilesForRole
(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest) Lists the instance profiles that have the specified associated IAM role.listInstanceProfilesForRole
(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) Lists the instance profiles that have the specified associated IAM role.listInstanceProfilesForRolePaginator
(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest) This is a variant oflistInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation.listInstanceProfilesForRolePaginator
(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) This is a variant oflistInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation.default ListInstanceProfilesPublisher
This is a variant oflistInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.default ListInstanceProfilesPublisher
listInstanceProfilesPaginator
(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest) This is a variant oflistInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.default ListInstanceProfilesPublisher
listInstanceProfilesPaginator
(ListInstanceProfilesRequest listInstanceProfilesRequest) This is a variant oflistInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation.listInstanceProfileTags
(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest) Lists the tags that are attached to the specified IAM instance profile.listInstanceProfileTags
(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest) Lists the tags that are attached to the specified IAM instance profile.default ListInstanceProfileTagsPublisher
listInstanceProfileTagsPaginator
(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest) This is a variant oflistInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
operation.default ListInstanceProfileTagsPublisher
listInstanceProfileTagsPaginator
(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest) This is a variant oflistInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
operation.default CompletableFuture
<ListMfaDevicesResponse> Lists the MFA devices for an IAM user.default CompletableFuture
<ListMfaDevicesResponse> listMFADevices
(Consumer<ListMfaDevicesRequest.Builder> listMfaDevicesRequest) Lists the MFA devices for an IAM user.default CompletableFuture
<ListMfaDevicesResponse> listMFADevices
(ListMfaDevicesRequest listMfaDevicesRequest) Lists the MFA devices for an IAM user.default ListMFADevicesPublisher
This is a variant oflistMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest)
operation.default ListMFADevicesPublisher
listMFADevicesPaginator
(Consumer<ListMfaDevicesRequest.Builder> listMfaDevicesRequest) This is a variant oflistMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest)
operation.default ListMFADevicesPublisher
listMFADevicesPaginator
(ListMfaDevicesRequest listMfaDevicesRequest) This is a variant oflistMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest)
operation.listMFADeviceTags
(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest) Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.listMFADeviceTags
(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest) Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.default ListMFADeviceTagsPublisher
listMFADeviceTagsPaginator
(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest) This is a variant oflistMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest)
operation.default ListMFADeviceTagsPublisher
listMFADeviceTagsPaginator
(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest) This is a variant oflistMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest)
operation.Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.listOpenIDConnectProviders
(Consumer<ListOpenIdConnectProvidersRequest.Builder> listOpenIdConnectProvidersRequest) Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.listOpenIDConnectProviders
(ListOpenIdConnectProvidersRequest listOpenIdConnectProvidersRequest) Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.listOpenIDConnectProviderTags
(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest) Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.listOpenIDConnectProviderTags
(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest) Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.listOpenIDConnectProviderTagsPaginator
(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest) This is a variant oflistOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
operation.listOpenIDConnectProviderTagsPaginator
(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest) This is a variant oflistOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
operation.default CompletableFuture
<ListPoliciesResponse> 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 CompletableFuture
<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 CompletableFuture
<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.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.listPoliciesGrantingServiceAccess
(ListPoliciesGrantingServiceAccessRequest listPoliciesGrantingServiceAccessRequest) Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.default ListPoliciesPublisher
This is a variant oflistPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation.default ListPoliciesPublisher
listPoliciesPaginator
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation.default ListPoliciesPublisher
listPoliciesPaginator
(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation.default CompletableFuture
<ListPolicyTagsResponse> listPolicyTags
(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest) Lists the tags that are attached to the specified IAM customer managed policy.default CompletableFuture
<ListPolicyTagsResponse> listPolicyTags
(ListPolicyTagsRequest listPolicyTagsRequest) Lists the tags that are attached to the specified IAM customer managed policy.default ListPolicyTagsPublisher
listPolicyTagsPaginator
(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest) This is a variant oflistPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest)
operation.default ListPolicyTagsPublisher
listPolicyTagsPaginator
(ListPolicyTagsRequest listPolicyTagsRequest) This is a variant oflistPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest)
operation.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.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 ListPolicyVersionsPublisher
listPolicyVersionsPaginator
(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation.default ListPolicyVersionsPublisher
listPolicyVersionsPaginator
(ListPolicyVersionsRequest listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation.listRolePolicies
(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM role.listRolePolicies
(ListRolePoliciesRequest listRolePoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM role.default ListRolePoliciesPublisher
listRolePoliciesPaginator
(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest) This is a variant oflistRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation.default ListRolePoliciesPublisher
listRolePoliciesPaginator
(ListRolePoliciesRequest listRolePoliciesRequest) This is a variant oflistRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation.default CompletableFuture
<ListRolesResponse> Lists the IAM roles that have the specified path prefix.default CompletableFuture
<ListRolesResponse> listRoles
(Consumer<ListRolesRequest.Builder> listRolesRequest) Lists the IAM roles that have the specified path prefix.default CompletableFuture
<ListRolesResponse> listRoles
(ListRolesRequest listRolesRequest) Lists the IAM roles that have the specified path prefix.default ListRolesPublisher
This is a variant oflistRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.default ListRolesPublisher
listRolesPaginator
(Consumer<ListRolesRequest.Builder> listRolesRequest) This is a variant oflistRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.default ListRolesPublisher
listRolesPaginator
(ListRolesRequest listRolesRequest) This is a variant oflistRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation.default CompletableFuture
<ListRoleTagsResponse> listRoleTags
(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest) Lists the tags that are attached to the specified role.default CompletableFuture
<ListRoleTagsResponse> listRoleTags
(ListRoleTagsRequest listRoleTagsRequest) Lists the tags that are attached to the specified role.default ListRoleTagsPublisher
listRoleTagsPaginator
(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest) This is a variant oflistRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest)
operation.default ListRoleTagsPublisher
listRoleTagsPaginator
(ListRoleTagsRequest listRoleTagsRequest) This is a variant oflistRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest)
operation.Lists the SAML provider resource objects defined in IAM in the account.listSAMLProviders
(Consumer<ListSamlProvidersRequest.Builder> listSamlProvidersRequest) Lists the SAML provider resource objects defined in IAM in the account.listSAMLProviders
(ListSamlProvidersRequest listSamlProvidersRequest) Lists the SAML provider resource objects defined in IAM in the account.listSAMLProviderTags
(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest) Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.listSAMLProviderTags
(ListSamlProviderTagsRequest listSamlProviderTagsRequest) Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.default ListSAMLProviderTagsPublisher
listSAMLProviderTagsPaginator
(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest) This is a variant oflistSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest)
operation.default ListSAMLProviderTagsPublisher
listSAMLProviderTagsPaginator
(ListSamlProviderTagsRequest listSamlProviderTagsRequest) This is a variant oflistSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest)
operation.Lists the server certificates stored in IAM that have the specified path prefix.listServerCertificates
(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest) Lists the server certificates stored in IAM that have the specified path prefix.listServerCertificates
(ListServerCertificatesRequest listServerCertificatesRequest) Lists the server certificates stored in IAM that have the specified path prefix.default ListServerCertificatesPublisher
This is a variant oflistServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation.default ListServerCertificatesPublisher
listServerCertificatesPaginator
(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest) This is a variant oflistServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation.default ListServerCertificatesPublisher
listServerCertificatesPaginator
(ListServerCertificatesRequest listServerCertificatesRequest) This is a variant oflistServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation.listServerCertificateTags
(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest) Lists the tags that are attached to the specified IAM server certificate.listServerCertificateTags
(ListServerCertificateTagsRequest listServerCertificateTagsRequest) Lists the tags that are attached to the specified IAM server certificate.listServerCertificateTagsPaginator
(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest) This is a variant oflistServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
operation.listServerCertificateTagsPaginator
(ListServerCertificateTagsRequest listServerCertificateTagsRequest) This is a variant oflistServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
operation.Returns information about the service-specific credentials associated with the specified IAM user.listServiceSpecificCredentials
(Consumer<ListServiceSpecificCredentialsRequest.Builder> listServiceSpecificCredentialsRequest) Returns information about the service-specific credentials associated with the specified IAM user.listServiceSpecificCredentials
(ListServiceSpecificCredentialsRequest listServiceSpecificCredentialsRequest) Returns information about the service-specific credentials associated with the specified IAM user.Returns information about the signing certificates associated with the specified IAM user.listSigningCertificates
(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest) Returns information about the signing certificates associated with the specified IAM user.listSigningCertificates
(ListSigningCertificatesRequest listSigningCertificatesRequest) Returns information about the signing certificates associated with the specified IAM user.default ListSigningCertificatesPublisher
This is a variant oflistSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation.default ListSigningCertificatesPublisher
listSigningCertificatesPaginator
(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest) This is a variant oflistSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation.default ListSigningCertificatesPublisher
listSigningCertificatesPaginator
(ListSigningCertificatesRequest listSigningCertificatesRequest) This is a variant oflistSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation.Returns information about the SSH public keys associated with the specified IAM user.listSSHPublicKeys
(Consumer<ListSshPublicKeysRequest.Builder> listSshPublicKeysRequest) Returns information about the SSH public keys associated with the specified IAM user.listSSHPublicKeys
(ListSshPublicKeysRequest listSshPublicKeysRequest) Returns information about the SSH public keys associated with the specified IAM user.default ListSSHPublicKeysPublisher
This is a variant oflistSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest)
operation.default ListSSHPublicKeysPublisher
listSSHPublicKeysPaginator
(Consumer<ListSshPublicKeysRequest.Builder> listSshPublicKeysRequest) This is a variant oflistSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest)
operation.default ListSSHPublicKeysPublisher
listSSHPublicKeysPaginator
(ListSshPublicKeysRequest listSshPublicKeysRequest) This is a variant oflistSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest)
operation.listUserPolicies
(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest) Lists the names of the inline policies embedded in the specified IAM user.listUserPolicies
(ListUserPoliciesRequest listUserPoliciesRequest) Lists the names of the inline policies embedded in the specified IAM user.default ListUserPoliciesPublisher
listUserPoliciesPaginator
(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest) This is a variant oflistUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation.default ListUserPoliciesPublisher
listUserPoliciesPaginator
(ListUserPoliciesRequest listUserPoliciesRequest) This is a variant oflistUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation.default CompletableFuture
<ListUsersResponse> Lists the IAM users that have the specified path prefix.default CompletableFuture
<ListUsersResponse> listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the IAM users that have the specified path prefix.default CompletableFuture
<ListUsersResponse> listUsers
(ListUsersRequest listUsersRequest) Lists the IAM users that have the specified path prefix.default ListUsersPublisher
This is a variant oflistUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.default ListUsersPublisher
listUsersPaginator
(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.default ListUsersPublisher
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation.default CompletableFuture
<ListUserTagsResponse> listUserTags
(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest) Lists the tags that are attached to the specified IAM user.default CompletableFuture
<ListUserTagsResponse> listUserTags
(ListUserTagsRequest listUserTagsRequest) Lists the tags that are attached to the specified IAM user.default ListUserTagsPublisher
listUserTagsPaginator
(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest) This is a variant oflistUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest)
operation.default ListUserTagsPublisher
listUserTagsPaginator
(ListUserTagsRequest listUserTagsRequest) This is a variant oflistUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest)
operation.Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.listVirtualMFADevices
(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest) Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.listVirtualMFADevices
(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest) Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.default ListVirtualMFADevicesPublisher
This is a variant oflistVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation.default ListVirtualMFADevicesPublisher
listVirtualMFADevicesPaginator
(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest) This is a variant oflistVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation.default ListVirtualMFADevicesPublisher
listVirtualMFADevicesPaginator
(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest) This is a variant oflistVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation.default CompletableFuture
<PutGroupPolicyResponse> putGroupPolicy
(Consumer<PutGroupPolicyRequest.Builder> putGroupPolicyRequest) Adds or updates an inline policy document that is embedded in the specified IAM group.default CompletableFuture
<PutGroupPolicyResponse> putGroupPolicy
(PutGroupPolicyRequest putGroupPolicyRequest) Adds or updates an inline policy document that is embedded in the specified IAM group.putRolePermissionsBoundary
(Consumer<PutRolePermissionsBoundaryRequest.Builder> putRolePermissionsBoundaryRequest) Adds or updates the policy that is specified as the IAM role's permissions boundary.putRolePermissionsBoundary
(PutRolePermissionsBoundaryRequest putRolePermissionsBoundaryRequest) Adds or updates the policy that is specified as the IAM role's permissions boundary.default CompletableFuture
<PutRolePolicyResponse> putRolePolicy
(Consumer<PutRolePolicyRequest.Builder> putRolePolicyRequest) Adds or updates an inline policy document that is embedded in the specified IAM role.default CompletableFuture
<PutRolePolicyResponse> putRolePolicy
(PutRolePolicyRequest putRolePolicyRequest) Adds or updates an inline policy document that is embedded in the specified IAM role.putUserPermissionsBoundary
(Consumer<PutUserPermissionsBoundaryRequest.Builder> putUserPermissionsBoundaryRequest) Adds or updates the policy that is specified as the IAM user's permissions boundary.putUserPermissionsBoundary
(PutUserPermissionsBoundaryRequest putUserPermissionsBoundaryRequest) Adds or updates the policy that is specified as the IAM user's permissions boundary.default CompletableFuture
<PutUserPolicyResponse> putUserPolicy
(Consumer<PutUserPolicyRequest.Builder> putUserPolicyRequest) Adds or updates an inline policy document that is embedded in the specified IAM user.default CompletableFuture
<PutUserPolicyResponse> putUserPolicy
(PutUserPolicyRequest putUserPolicyRequest) Adds or updates an inline policy document that is embedded in the specified IAM user.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.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.removeRoleFromInstanceProfile
(Consumer<RemoveRoleFromInstanceProfileRequest.Builder> removeRoleFromInstanceProfileRequest) Removes the specified IAM role from the specified Amazon EC2 instance profile.removeRoleFromInstanceProfile
(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest) Removes the specified IAM role from the specified Amazon EC2 instance profile.removeUserFromGroup
(Consumer<RemoveUserFromGroupRequest.Builder> removeUserFromGroupRequest) Removes the specified user from the specified group.removeUserFromGroup
(RemoveUserFromGroupRequest removeUserFromGroupRequest) Removes the specified user from the specified group.resetServiceSpecificCredential
(Consumer<ResetServiceSpecificCredentialRequest.Builder> resetServiceSpecificCredentialRequest) Resets the password for a service-specific credential.resetServiceSpecificCredential
(ResetServiceSpecificCredentialRequest resetServiceSpecificCredentialRequest) Resets the password for a service-specific credential.default CompletableFuture
<ResyncMfaDeviceResponse> resyncMFADevice
(Consumer<ResyncMfaDeviceRequest.Builder> resyncMfaDeviceRequest) Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.default CompletableFuture
<ResyncMfaDeviceResponse> resyncMFADevice
(ResyncMfaDeviceRequest resyncMfaDeviceRequest) Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.default IamServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetDefaultPolicyVersion
(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest) Sets the specified version of the specified policy as the policy's default (operative) version.setDefaultPolicyVersion
(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) Sets the specified version of the specified policy as the policy's default (operative) version.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.setSecurityTokenServicePreferences
(SetSecurityTokenServicePreferencesRequest setSecurityTokenServicePreferencesRequest) Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.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.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 SimulateCustomPolicyPublisher
simulateCustomPolicyPaginator
(Consumer<SimulateCustomPolicyRequest.Builder> simulateCustomPolicyRequest) This is a variant ofsimulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation.default SimulateCustomPolicyPublisher
simulateCustomPolicyPaginator
(SimulateCustomPolicyRequest simulateCustomPolicyRequest) This is a variant ofsimulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation.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.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 SimulatePrincipalPolicyPublisher
simulatePrincipalPolicyPaginator
(Consumer<SimulatePrincipalPolicyRequest.Builder> simulatePrincipalPolicyRequest) This is a variant ofsimulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation.default SimulatePrincipalPolicyPublisher
simulatePrincipalPolicyPaginator
(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest) This is a variant ofsimulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation.tagInstanceProfile
(Consumer<TagInstanceProfileRequest.Builder> tagInstanceProfileRequest) Adds one or more tags to an IAM instance profile.tagInstanceProfile
(TagInstanceProfileRequest tagInstanceProfileRequest) Adds one or more tags to an IAM instance profile.default CompletableFuture
<TagMfaDeviceResponse> tagMFADevice
(Consumer<TagMfaDeviceRequest.Builder> tagMfaDeviceRequest) Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device.default CompletableFuture
<TagMfaDeviceResponse> tagMFADevice
(TagMfaDeviceRequest tagMfaDeviceRequest) Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device.tagOpenIDConnectProvider
(Consumer<TagOpenIdConnectProviderRequest.Builder> tagOpenIdConnectProviderRequest) Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider.tagOpenIDConnectProvider
(TagOpenIdConnectProviderRequest tagOpenIdConnectProviderRequest) Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider.default CompletableFuture
<TagPolicyResponse> tagPolicy
(Consumer<TagPolicyRequest.Builder> tagPolicyRequest) Adds one or more tags to an IAM customer managed policy.default CompletableFuture
<TagPolicyResponse> tagPolicy
(TagPolicyRequest tagPolicyRequest) Adds one or more tags to an IAM customer managed policy.default CompletableFuture
<TagRoleResponse> tagRole
(Consumer<TagRoleRequest.Builder> tagRoleRequest) Adds one or more tags to an IAM role.default CompletableFuture
<TagRoleResponse> tagRole
(TagRoleRequest tagRoleRequest) Adds one or more tags to an IAM role.default CompletableFuture
<TagSamlProviderResponse> tagSAMLProvider
(Consumer<TagSamlProviderRequest.Builder> tagSamlProviderRequest) Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.default CompletableFuture
<TagSamlProviderResponse> tagSAMLProvider
(TagSamlProviderRequest tagSamlProviderRequest) Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.tagServerCertificate
(Consumer<TagServerCertificateRequest.Builder> tagServerCertificateRequest) Adds one or more tags to an IAM server certificate.tagServerCertificate
(TagServerCertificateRequest tagServerCertificateRequest) Adds one or more tags to an IAM server certificate.default CompletableFuture
<TagUserResponse> tagUser
(Consumer<TagUserRequest.Builder> tagUserRequest) Adds one or more tags to an IAM user.default CompletableFuture
<TagUserResponse> tagUser
(TagUserRequest tagUserRequest) Adds one or more tags to an IAM user.untagInstanceProfile
(Consumer<UntagInstanceProfileRequest.Builder> untagInstanceProfileRequest) Removes the specified tags from the IAM instance profile.untagInstanceProfile
(UntagInstanceProfileRequest untagInstanceProfileRequest) Removes the specified tags from the IAM instance profile.default CompletableFuture
<UntagMfaDeviceResponse> untagMFADevice
(Consumer<UntagMfaDeviceRequest.Builder> untagMfaDeviceRequest) Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.default CompletableFuture
<UntagMfaDeviceResponse> untagMFADevice
(UntagMfaDeviceRequest untagMfaDeviceRequest) Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.untagOpenIDConnectProvider
(Consumer<UntagOpenIdConnectProviderRequest.Builder> untagOpenIdConnectProviderRequest) Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM.untagOpenIDConnectProvider
(UntagOpenIdConnectProviderRequest untagOpenIdConnectProviderRequest) Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM.default CompletableFuture
<UntagPolicyResponse> untagPolicy
(Consumer<UntagPolicyRequest.Builder> untagPolicyRequest) Removes the specified tags from the customer managed policy.default CompletableFuture
<UntagPolicyResponse> untagPolicy
(UntagPolicyRequest untagPolicyRequest) Removes the specified tags from the customer managed policy.default CompletableFuture
<UntagRoleResponse> untagRole
(Consumer<UntagRoleRequest.Builder> untagRoleRequest) Removes the specified tags from the role.default CompletableFuture
<UntagRoleResponse> untagRole
(UntagRoleRequest untagRoleRequest) Removes the specified tags from the role.untagSAMLProvider
(Consumer<UntagSamlProviderRequest.Builder> untagSamlProviderRequest) Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM.untagSAMLProvider
(UntagSamlProviderRequest untagSamlProviderRequest) Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM.untagServerCertificate
(Consumer<UntagServerCertificateRequest.Builder> untagServerCertificateRequest) Removes the specified tags from the IAM server certificate.untagServerCertificate
(UntagServerCertificateRequest untagServerCertificateRequest) Removes the specified tags from the IAM server certificate.default CompletableFuture
<UntagUserResponse> untagUser
(Consumer<UntagUserRequest.Builder> untagUserRequest) Removes the specified tags from the user.default CompletableFuture
<UntagUserResponse> untagUser
(UntagUserRequest untagUserRequest) Removes the specified tags from the user.default CompletableFuture
<UpdateAccessKeyResponse> updateAccessKey
(Consumer<UpdateAccessKeyRequest.Builder> updateAccessKeyRequest) Changes the status of the specified access key from Active to Inactive, or vice versa.default CompletableFuture
<UpdateAccessKeyResponse> updateAccessKey
(UpdateAccessKeyRequest updateAccessKeyRequest) Changes the status of the specified access key from Active to Inactive, or vice versa.Updates the password policy settings for the Amazon Web Services account.updateAccountPasswordPolicy
(Consumer<UpdateAccountPasswordPolicyRequest.Builder> updateAccountPasswordPolicyRequest) Updates the password policy settings for the Amazon Web Services account.updateAccountPasswordPolicy
(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest) Updates the password policy settings for the Amazon Web Services account.updateAssumeRolePolicy
(Consumer<UpdateAssumeRolePolicyRequest.Builder> updateAssumeRolePolicyRequest) Updates the policy that grants an IAM entity permission to assume a role.updateAssumeRolePolicy
(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest) Updates the policy that grants an IAM entity permission to assume a role.default CompletableFuture
<UpdateGroupResponse> updateGroup
(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Updates the name and/or the path of the specified IAM group.default CompletableFuture
<UpdateGroupResponse> updateGroup
(UpdateGroupRequest updateGroupRequest) Updates the name and/or the path of the specified IAM group.updateLoginProfile
(Consumer<UpdateLoginProfileRequest.Builder> updateLoginProfileRequest) Changes the password for the specified IAM user.updateLoginProfile
(UpdateLoginProfileRequest updateLoginProfileRequest) Changes the password for the specified IAM user.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.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 CompletableFuture
<UpdateRoleResponse> updateRole
(Consumer<UpdateRoleRequest.Builder> updateRoleRequest) Updates the description or maximum session duration setting of a role.default CompletableFuture
<UpdateRoleResponse> updateRole
(UpdateRoleRequest updateRoleRequest) Updates the description or maximum session duration setting of a role.updateRoleDescription
(Consumer<UpdateRoleDescriptionRequest.Builder> updateRoleDescriptionRequest) Use UpdateRole instead.updateRoleDescription
(UpdateRoleDescriptionRequest updateRoleDescriptionRequest) Use UpdateRole instead.updateSAMLProvider
(Consumer<UpdateSamlProviderRequest.Builder> updateSamlProviderRequest) Updates the metadata document for an existing SAML provider resource object.updateSAMLProvider
(UpdateSamlProviderRequest updateSamlProviderRequest) Updates the metadata document for an existing SAML provider resource object.updateServerCertificate
(Consumer<UpdateServerCertificateRequest.Builder> updateServerCertificateRequest) Updates the name and/or the path of the specified server certificate stored in IAM.updateServerCertificate
(UpdateServerCertificateRequest updateServerCertificateRequest) Updates the name and/or the path of the specified server certificate stored in IAM.updateServiceSpecificCredential
(Consumer<UpdateServiceSpecificCredentialRequest.Builder> updateServiceSpecificCredentialRequest) Sets the status of a service-specific credential toActive
orInactive
.updateServiceSpecificCredential
(UpdateServiceSpecificCredentialRequest updateServiceSpecificCredentialRequest) Sets the status of a service-specific credential toActive
orInactive
.updateSigningCertificate
(Consumer<UpdateSigningCertificateRequest.Builder> updateSigningCertificateRequest) Changes the status of the specified user signing certificate from active to disabled, or vice versa.updateSigningCertificate
(UpdateSigningCertificateRequest updateSigningCertificateRequest) Changes the status of the specified user signing certificate from active to disabled, or vice versa.updateSSHPublicKey
(Consumer<UpdateSshPublicKeyRequest.Builder> updateSshPublicKeyRequest) Sets the status of an IAM user's SSH public key to active or inactive.updateSSHPublicKey
(UpdateSshPublicKeyRequest updateSshPublicKeyRequest) Sets the status of an IAM user's SSH public key to active or inactive.default CompletableFuture
<UpdateUserResponse> updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates the name and/or the path of the specified IAM user.default CompletableFuture
<UpdateUserResponse> updateUser
(UpdateUserRequest updateUserRequest) Updates the name and/or the path of the specified IAM user.uploadServerCertificate
(Consumer<UploadServerCertificateRequest.Builder> uploadServerCertificateRequest) Uploads a server certificate entity for the Amazon Web Services account.uploadServerCertificate
(UploadServerCertificateRequest uploadServerCertificateRequest) Uploads a server certificate entity for the Amazon Web Services account.uploadSigningCertificate
(Consumer<UploadSigningCertificateRequest.Builder> uploadSigningCertificateRequest) Uploads an X.509 signing certificate and associates it with the specified IAM user.uploadSigningCertificate
(UploadSigningCertificateRequest uploadSigningCertificateRequest) Uploads an X.509 signing certificate and associates it with the specified IAM user.uploadSSHPublicKey
(Consumer<UploadSshPublicKeyRequest.Builder> uploadSshPublicKeyRequest) Uploads an SSH public key and associates it with the specified IAM user.uploadSSHPublicKey
(UploadSshPublicKeyRequest uploadSshPublicKeyRequest) Uploads an SSH public key and associates it with the specified IAM user.default IamAsyncWaiter
waiter()
Create an instance ofIamAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addClientIDToOpenIDConnectProvider
default CompletableFuture<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.
This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
- Parameters:
addClientIdToOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the AddClientIDToOpenIDConnectProvider operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addClientIDToOpenIDConnectProvider
default CompletableFuture<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.
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 viaAddClientIdToOpenIdConnectProviderRequest.builder()
- Parameters:
addClientIdToOpenIdConnectProviderRequest
- AConsumer
that will call methods onAddClientIdToOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddClientIDToOpenIDConnectProvider operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addRoleToInstanceProfile
default CompletableFuture<AddRoleToInstanceProfileResponse> addRoleToInstanceProfile(AddRoleToInstanceProfileRequest addRoleToInstanceProfileRequest) 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.
- Parameters:
addRoleToInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the AddRoleToInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addRoleToInstanceProfile
default CompletableFuture<AddRoleToInstanceProfileResponse> addRoleToInstanceProfile(Consumer<AddRoleToInstanceProfileRequest.Builder> addRoleToInstanceProfileRequest) 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 viaAddRoleToInstanceProfileRequest.builder()
- Parameters:
addRoleToInstanceProfileRequest
- AConsumer
that will call methods onAddRoleToInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddRoleToInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addUserToGroup
default CompletableFuture<AddUserToGroupResponse> addUserToGroup(AddUserToGroupRequest addUserToGroupRequest) Adds the specified user to the specified group.
- Parameters:
addUserToGroupRequest
-- Returns:
- A Java Future containing the result of the AddUserToGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addUserToGroup
default CompletableFuture<AddUserToGroupResponse> addUserToGroup(Consumer<AddUserToGroupRequest.Builder> addUserToGroupRequest) 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 viaAddUserToGroupRequest.builder()
- Parameters:
addUserToGroupRequest
- AConsumer
that will call methods onAddUserToGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddUserToGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachGroupPolicy
default CompletableFuture<AttachGroupPolicyResponse> attachGroupPolicy(AttachGroupPolicyRequest attachGroupPolicyRequest) 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.
- Parameters:
attachGroupPolicyRequest
-- Returns:
- A Java Future containing the result of the AttachGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachGroupPolicy
default CompletableFuture<AttachGroupPolicyResponse> attachGroupPolicy(Consumer<AttachGroupPolicyRequest.Builder> attachGroupPolicyRequest) 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 viaAttachGroupPolicyRequest.builder()
- Parameters:
attachGroupPolicyRequest
- AConsumer
that will call methods onAttachGroupPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachRolePolicy
default CompletableFuture<AttachRolePolicyResponse> attachRolePolicy(AttachRolePolicyRequest attachRolePolicyRequest) 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 usingUpdateAssumerolePolicy
.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.
- Parameters:
attachRolePolicyRequest
-- Returns:
- A Java Future containing the result of the AttachRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachRolePolicy
default CompletableFuture<AttachRolePolicyResponse> attachRolePolicy(Consumer<AttachRolePolicyRequest.Builder> attachRolePolicyRequest) 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 usingUpdateAssumerolePolicy
.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 viaAttachRolePolicyRequest.builder()
- Parameters:
attachRolePolicyRequest
- AConsumer
that will call methods onAttachRolePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachUserPolicy
default CompletableFuture<AttachUserPolicyResponse> attachUserPolicy(AttachUserPolicyRequest attachUserPolicyRequest) 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.
- Parameters:
attachUserPolicyRequest
-- Returns:
- A Java Future containing the result of the AttachUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachUserPolicy
default CompletableFuture<AttachUserPolicyResponse> attachUserPolicy(Consumer<AttachUserPolicyRequest.Builder> attachUserPolicyRequest) 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 viaAttachUserPolicyRequest.builder()
- Parameters:
attachUserPolicyRequest
- AConsumer
that will call methods onAttachUserPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
changePassword
default CompletableFuture<ChangePasswordResponse> changePassword(ChangePasswordRequest changePasswordRequest) 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.
- Parameters:
changePasswordRequest
-- Returns:
- A Java Future containing the result of the ChangePassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
changePassword
default CompletableFuture<ChangePasswordResponse> changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest) 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 viaChangePasswordRequest.builder()
- Parameters:
changePasswordRequest
- AConsumer
that will call methods onChangePasswordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ChangePassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccessKey
default CompletableFuture<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. 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.
- Parameters:
createAccessKeyRequest
-- Returns:
- A Java Future containing the result of the CreateAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccessKey
default CompletableFuture<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. 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 viaCreateAccessKeyRequest.builder()
- Parameters:
createAccessKeyRequest
- AConsumer
that will call methods onCreateAccessKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccessKey
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.
- Returns:
- A Java Future containing the result of the CreateAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccountAlias
default CompletableFuture<CreateAccountAliasResponse> createAccountAlias(CreateAccountAliasRequest createAccountAliasRequest) 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.
- Parameters:
createAccountAliasRequest
-- Returns:
- A Java Future containing the result of the CreateAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccountAlias
default CompletableFuture<CreateAccountAliasResponse> createAccountAlias(Consumer<CreateAccountAliasRequest.Builder> createAccountAliasRequest) 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 viaCreateAccountAliasRequest.builder()
- Parameters:
createAccountAliasRequest
- AConsumer
that will call methods onCreateAccountAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createGroup
Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
- Parameters:
createGroupRequest
-- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createGroup
default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) 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 viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createInstanceProfile
default CompletableFuture<CreateInstanceProfileResponse> createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest) 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.
- Parameters:
createInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the CreateInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createInstanceProfile
default CompletableFuture<CreateInstanceProfileResponse> createInstanceProfile(Consumer<CreateInstanceProfileRequest.Builder> createInstanceProfileRequest) 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 viaCreateInstanceProfileRequest.builder()
- Parameters:
createInstanceProfileRequest
- AConsumer
that will call methods onCreateInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createLoginProfile
default CompletableFuture<CreateLoginProfileResponse> createLoginProfile(CreateLoginProfileRequest createLoginProfileRequest) 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.
- Parameters:
createLoginProfileRequest
-- Returns:
- A Java Future containing the result of the CreateLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createLoginProfile
default CompletableFuture<CreateLoginProfileResponse> createLoginProfile(Consumer<CreateLoginProfileRequest.Builder> createLoginProfileRequest) 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 viaCreateLoginProfileRequest.builder()
- Parameters:
createLoginProfileRequest
- AConsumer
that will call methods onCreateLoginProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createOpenIDConnectProvider
default CompletableFuture<CreateOpenIdConnectProviderResponse> createOpenIDConnectProvider(CreateOpenIdConnectProviderRequest createOpenIdConnectProviderRequest) Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. 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 OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.
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.
- Parameters:
createOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the CreateOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- OpenIdIdpCommunicationErrorException The request failed because IAM cannot connect to the OpenID Connect identity provider URL.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createOpenIDConnectProvider
default CompletableFuture<CreateOpenIdConnectProviderResponse> createOpenIDConnectProvider(Consumer<CreateOpenIdConnectProviderRequest.Builder> createOpenIdConnectProviderRequest) Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. 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 OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.
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 viaCreateOpenIdConnectProviderRequest.builder()
- Parameters:
createOpenIdConnectProviderRequest
- AConsumer
that will call methods onCreateOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- OpenIdIdpCommunicationErrorException The request failed because IAM cannot connect to the OpenID Connect identity provider URL.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createPolicy
default CompletableFuture<CreatePolicyResponse> createPolicy(CreatePolicyRequest createPolicyRequest) 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.
- Parameters:
createPolicyRequest
-- Returns:
- A Java Future containing the result of the CreatePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPolicy
default CompletableFuture<CreatePolicyResponse> createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) 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 viaCreatePolicyRequest.builder()
- Parameters:
createPolicyRequest
- AConsumer
that will call methods onCreatePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPolicyVersion
default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the 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.
- Parameters:
createPolicyVersionRequest
-- Returns:
- A Java Future containing the result of the CreatePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPolicyVersion
default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest) Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the 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 viaCreatePolicyVersionRequest.builder()
- Parameters:
createPolicyVersionRequest
- AConsumer
that will call methods onCreatePolicyVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createRole
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.
- Parameters:
createRoleRequest
-- Returns:
- A Java Future containing the result of the CreateRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createRole
default CompletableFuture<CreateRoleResponse> createRole(Consumer<CreateRoleRequest.Builder> createRoleRequest) 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 viaCreateRoleRequest.builder()
- Parameters:
createRoleRequest
- AConsumer
that will call methods onCreateRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSAMLProvider
default CompletableFuture<CreateSamlProviderResponse> createSAMLProvider(CreateSamlProviderRequest createSamlProviderRequest) 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.
- Parameters:
createSamlProviderRequest
-- Returns:
- A Java Future containing the result of the CreateSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSAMLProvider
default CompletableFuture<CreateSamlProviderResponse> createSAMLProvider(Consumer<CreateSamlProviderRequest.Builder> createSamlProviderRequest) 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 viaCreateSamlProviderRequest.builder()
- Parameters:
createSamlProviderRequest
- AConsumer
that will call methods onCreateSamlProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createServiceLinkedRole
default CompletableFuture<CreateServiceLinkedRoleResponse> createServiceLinkedRole(CreateServiceLinkedRoleRequest createServiceLinkedRoleRequest) 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.
- Parameters:
createServiceLinkedRoleRequest
-- Returns:
- A Java Future containing the result of the CreateServiceLinkedRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createServiceLinkedRole
default CompletableFuture<CreateServiceLinkedRoleResponse> createServiceLinkedRole(Consumer<CreateServiceLinkedRoleRequest.Builder> createServiceLinkedRoleRequest) 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 viaCreateServiceLinkedRoleRequest.builder()
- Parameters:
createServiceLinkedRoleRequest
- AConsumer
that will call methods onCreateServiceLinkedRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateServiceLinkedRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createServiceSpecificCredential
default CompletableFuture<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. 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.
- Parameters:
createServiceSpecificCredentialRequest
-- Returns:
- A Java Future containing the result of the CreateServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createServiceSpecificCredential
default CompletableFuture<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. 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 viaCreateServiceSpecificCredentialRequest.builder()
- Parameters:
createServiceSpecificCredentialRequest
- AConsumer
that will call methods onCreateServiceSpecificCredentialRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createUser
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.
- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) 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 viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createVirtualMFADevice
default CompletableFuture<CreateVirtualMfaDeviceResponse> createVirtualMFADevice(CreateVirtualMfaDeviceRequest createVirtualMfaDeviceRequest) 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.
- Parameters:
createVirtualMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the CreateVirtualMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createVirtualMFADevice
default CompletableFuture<CreateVirtualMfaDeviceResponse> createVirtualMFADevice(Consumer<CreateVirtualMfaDeviceRequest.Builder> createVirtualMfaDeviceRequest) 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 viaCreateVirtualMfaDeviceRequest.builder()
- Parameters:
createVirtualMfaDeviceRequest
- AConsumer
that will call methods onCreateVirtualMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVirtualMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deactivateMFADevice
default CompletableFuture<DeactivateMfaDeviceResponse> deactivateMFADevice(DeactivateMfaDeviceRequest deactivateMfaDeviceRequest) Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.
- Parameters:
deactivateMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the DeactivateMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deactivateMFADevice
default CompletableFuture<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.
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 viaDeactivateMfaDeviceRequest.builder()
- Parameters:
deactivateMfaDeviceRequest
- AConsumer
that will call methods onDeactivateMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeactivateMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccessKey
default CompletableFuture<DeleteAccessKeyResponse> deleteAccessKey(DeleteAccessKeyRequest deleteAccessKeyRequest) 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.
- Parameters:
deleteAccessKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccessKey
default CompletableFuture<DeleteAccessKeyResponse> deleteAccessKey(Consumer<DeleteAccessKeyRequest.Builder> deleteAccessKeyRequest) 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 viaDeleteAccessKeyRequest.builder()
- Parameters:
deleteAccessKeyRequest
- AConsumer
that will call methods onDeleteAccessKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountAlias
default CompletableFuture<DeleteAccountAliasResponse> deleteAccountAlias(DeleteAccountAliasRequest deleteAccountAliasRequest) 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.
- Parameters:
deleteAccountAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountAlias
default CompletableFuture<DeleteAccountAliasResponse> deleteAccountAlias(Consumer<DeleteAccountAliasRequest.Builder> deleteAccountAliasRequest) 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 viaDeleteAccountAliasRequest.builder()
- Parameters:
deleteAccountAliasRequest
- AConsumer
that will call methods onDeleteAccountAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccountAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountPasswordPolicy
default CompletableFuture<DeleteAccountPasswordPolicyResponse> deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest deleteAccountPasswordPolicyRequest) Deletes the password policy for the Amazon Web Services account. There are no parameters.
- Parameters:
deleteAccountPasswordPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountPasswordPolicy
default CompletableFuture<DeleteAccountPasswordPolicyResponse> deleteAccountPasswordPolicy(Consumer<DeleteAccountPasswordPolicyRequest.Builder> deleteAccountPasswordPolicyRequest) 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 viaDeleteAccountPasswordPolicyRequest.builder()
- Parameters:
deleteAccountPasswordPolicyRequest
- AConsumer
that will call methods onDeleteAccountPasswordPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountPasswordPolicy
Deletes the password policy for the Amazon Web Services account. There are no parameters.
- Returns:
- A Java Future containing the result of the DeleteAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteGroup
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
- Parameters:
deleteGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteGroup
default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) 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 viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteGroupPolicy
default CompletableFuture<DeleteGroupPolicyResponse> deleteGroupPolicy(DeleteGroupPolicyRequest deleteGroupPolicyRequest) 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.
- Parameters:
deleteGroupPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteGroupPolicy
default CompletableFuture<DeleteGroupPolicyResponse> deleteGroupPolicy(Consumer<DeleteGroupPolicyRequest.Builder> deleteGroupPolicyRequest) 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 viaDeleteGroupPolicyRequest.builder()
- Parameters:
deleteGroupPolicyRequest
- AConsumer
that will call methods onDeleteGroupPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInstanceProfile
default CompletableFuture<DeleteInstanceProfileResponse> deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest) 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.
- Parameters:
deleteInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInstanceProfile
default CompletableFuture<DeleteInstanceProfileResponse> deleteInstanceProfile(Consumer<DeleteInstanceProfileRequest.Builder> deleteInstanceProfileRequest) 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 viaDeleteInstanceProfileRequest.builder()
- Parameters:
deleteInstanceProfileRequest
- AConsumer
that will call methods onDeleteInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteLoginProfile
default CompletableFuture<DeleteLoginProfileResponse> deleteLoginProfile(DeleteLoginProfileRequest deleteLoginProfileRequest) 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.
- Parameters:
deleteLoginProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteLoginProfile
default CompletableFuture<DeleteLoginProfileResponse> deleteLoginProfile(Consumer<DeleteLoginProfileRequest.Builder> deleteLoginProfileRequest) 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 viaDeleteLoginProfileRequest.builder()
- Parameters:
deleteLoginProfileRequest
- AConsumer
that will call methods onDeleteLoginProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteOpenIDConnectProvider
default CompletableFuture<DeleteOpenIdConnectProviderResponse> deleteOpenIDConnectProvider(DeleteOpenIdConnectProviderRequest deleteOpenIdConnectProviderRequest) 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.
- Parameters:
deleteOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the DeleteOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteOpenIDConnectProvider
default CompletableFuture<DeleteOpenIdConnectProviderResponse> deleteOpenIDConnectProvider(Consumer<DeleteOpenIdConnectProviderRequest.Builder> deleteOpenIdConnectProviderRequest) 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 viaDeleteOpenIdConnectProviderRequest.builder()
- Parameters:
deleteOpenIdConnectProviderRequest
- AConsumer
that will call methods onDeleteOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePolicy
default CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest deletePolicyRequest) 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.
- Parameters:
deletePolicyRequest
-- Returns:
- A Java Future containing the result of the DeletePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
deletePolicy
default CompletableFuture<DeletePolicyResponse> deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) 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 viaDeletePolicyRequest.builder()
- Parameters:
deletePolicyRequest
- AConsumer
that will call methods onDeletePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
deletePolicyVersion
default CompletableFuture<DeletePolicyVersionResponse> deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) 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.
- Parameters:
deletePolicyVersionRequest
-- Returns:
- A Java Future containing the result of the DeletePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePolicyVersion
default CompletableFuture<DeletePolicyVersionResponse> deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest) 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 viaDeletePolicyVersionRequest.builder()
- Parameters:
deletePolicyVersionRequest
- AConsumer
that will call methods onDeletePolicyVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRole
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.
- Parameters:
deleteRoleRequest
-- Returns:
- A Java Future containing the result of the DeleteRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
deleteRole
default CompletableFuture<DeleteRoleResponse> deleteRole(Consumer<DeleteRoleRequest.Builder> deleteRoleRequest) 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 viaDeleteRoleRequest.builder()
- Parameters:
deleteRoleRequest
- AConsumer
that will call methods onDeleteRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
deleteRolePermissionsBoundary
default CompletableFuture<DeleteRolePermissionsBoundaryResponse> deleteRolePermissionsBoundary(DeleteRolePermissionsBoundaryRequest deleteRolePermissionsBoundaryRequest) 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.
- Parameters:
deleteRolePermissionsBoundaryRequest
-- Returns:
- A Java Future containing the result of the DeleteRolePermissionsBoundary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRolePermissionsBoundary
default CompletableFuture<DeleteRolePermissionsBoundaryResponse> deleteRolePermissionsBoundary(Consumer<DeleteRolePermissionsBoundaryRequest.Builder> deleteRolePermissionsBoundaryRequest) 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 viaDeleteRolePermissionsBoundaryRequest.builder()
- Parameters:
deleteRolePermissionsBoundaryRequest
- AConsumer
that will call methods onDeleteRolePermissionsBoundaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRolePermissionsBoundary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRolePolicy
default CompletableFuture<DeleteRolePolicyResponse> deleteRolePolicy(DeleteRolePolicyRequest deleteRolePolicyRequest) 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.
- Parameters:
deleteRolePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRolePolicy
default CompletableFuture<DeleteRolePolicyResponse> deleteRolePolicy(Consumer<DeleteRolePolicyRequest.Builder> deleteRolePolicyRequest) 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 viaDeleteRolePolicyRequest.builder()
- Parameters:
deleteRolePolicyRequest
- AConsumer
that will call methods onDeleteRolePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSAMLProvider
default CompletableFuture<DeleteSamlProviderResponse> deleteSAMLProvider(DeleteSamlProviderRequest deleteSamlProviderRequest) 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.
- Parameters:
deleteSamlProviderRequest
-- Returns:
- A Java Future containing the result of the DeleteSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSAMLProvider
default CompletableFuture<DeleteSamlProviderResponse> deleteSAMLProvider(Consumer<DeleteSamlProviderRequest.Builder> deleteSamlProviderRequest) 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 viaDeleteSamlProviderRequest.builder()
- Parameters:
deleteSamlProviderRequest
- AConsumer
that will call methods onDeleteSamlProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSSHPublicKey
default CompletableFuture<DeleteSshPublicKeyResponse> deleteSSHPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) 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.
- Parameters:
deleteSshPublicKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSSHPublicKey
default CompletableFuture<DeleteSshPublicKeyResponse> deleteSSHPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) 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 viaDeleteSshPublicKeyRequest.builder()
- Parameters:
deleteSshPublicKeyRequest
- AConsumer
that will call methods onDeleteSshPublicKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteServerCertificate
default CompletableFuture<DeleteServerCertificateResponse> deleteServerCertificate(DeleteServerCertificateRequest deleteServerCertificateRequest) 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.
- Parameters:
deleteServerCertificateRequest
-- Returns:
- A Java Future containing the result of the DeleteServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteServerCertificate
default CompletableFuture<DeleteServerCertificateResponse> deleteServerCertificate(Consumer<DeleteServerCertificateRequest.Builder> deleteServerCertificateRequest) 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 viaDeleteServerCertificateRequest.builder()
- Parameters:
deleteServerCertificateRequest
- AConsumer
that will call methods onDeleteServerCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteServiceLinkedRole
default CompletableFuture<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. 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 theDeletionTaskId
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.
- Parameters:
deleteServiceLinkedRoleRequest
-- Returns:
- A Java Future containing the result of the DeleteServiceLinkedRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteServiceLinkedRole
default CompletableFuture<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. 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 theDeletionTaskId
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 viaDeleteServiceLinkedRoleRequest.builder()
- Parameters:
deleteServiceLinkedRoleRequest
- AConsumer
that will call methods onDeleteServiceLinkedRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteServiceLinkedRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteServiceSpecificCredential
default CompletableFuture<DeleteServiceSpecificCredentialResponse> deleteServiceSpecificCredential(DeleteServiceSpecificCredentialRequest deleteServiceSpecificCredentialRequest) Deletes the specified service-specific credential.
- Parameters:
deleteServiceSpecificCredentialRequest
-- Returns:
- A Java Future containing the result of the DeleteServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteServiceSpecificCredential
default CompletableFuture<DeleteServiceSpecificCredentialResponse> deleteServiceSpecificCredential(Consumer<DeleteServiceSpecificCredentialRequest.Builder> deleteServiceSpecificCredentialRequest) 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 viaDeleteServiceSpecificCredentialRequest.builder()
- Parameters:
deleteServiceSpecificCredentialRequest
- AConsumer
that will call methods onDeleteServiceSpecificCredentialRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSigningCertificate
default CompletableFuture<DeleteSigningCertificateResponse> deleteSigningCertificate(DeleteSigningCertificateRequest deleteSigningCertificateRequest) 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.
- Parameters:
deleteSigningCertificateRequest
-- Returns:
- A Java Future containing the result of the DeleteSigningCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSigningCertificate
default CompletableFuture<DeleteSigningCertificateResponse> deleteSigningCertificate(Consumer<DeleteSigningCertificateRequest.Builder> deleteSigningCertificateRequest) 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 viaDeleteSigningCertificateRequest.builder()
- Parameters:
deleteSigningCertificateRequest
- AConsumer
that will call methods onDeleteSigningCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSigningCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteUser
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)
- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) 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 viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
deleteUserPermissionsBoundary
default CompletableFuture<DeleteUserPermissionsBoundaryResponse> deleteUserPermissionsBoundary(DeleteUserPermissionsBoundaryRequest deleteUserPermissionsBoundaryRequest) 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.
- Parameters:
deleteUserPermissionsBoundaryRequest
-- Returns:
- A Java Future containing the result of the DeleteUserPermissionsBoundary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteUserPermissionsBoundary
default CompletableFuture<DeleteUserPermissionsBoundaryResponse> deleteUserPermissionsBoundary(Consumer<DeleteUserPermissionsBoundaryRequest.Builder> deleteUserPermissionsBoundaryRequest) 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 viaDeleteUserPermissionsBoundaryRequest.builder()
- Parameters:
deleteUserPermissionsBoundaryRequest
- AConsumer
that will call methods onDeleteUserPermissionsBoundaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUserPermissionsBoundary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteUserPolicy
default CompletableFuture<DeleteUserPolicyResponse> deleteUserPolicy(DeleteUserPolicyRequest deleteUserPolicyRequest) 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.
- Parameters:
deleteUserPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteUserPolicy
default CompletableFuture<DeleteUserPolicyResponse> deleteUserPolicy(Consumer<DeleteUserPolicyRequest.Builder> deleteUserPolicyRequest) 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 viaDeleteUserPolicyRequest.builder()
- Parameters:
deleteUserPolicyRequest
- AConsumer
that will call methods onDeleteUserPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVirtualMFADevice
default CompletableFuture<DeleteVirtualMfaDeviceResponse> deleteVirtualMFADevice(DeleteVirtualMfaDeviceRequest deleteVirtualMfaDeviceRequest) 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.
- Parameters:
deleteVirtualMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the DeleteVirtualMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVirtualMFADevice
default CompletableFuture<DeleteVirtualMfaDeviceResponse> deleteVirtualMFADevice(Consumer<DeleteVirtualMfaDeviceRequest.Builder> deleteVirtualMfaDeviceRequest) 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 viaDeleteVirtualMfaDeviceRequest.builder()
- Parameters:
deleteVirtualMfaDeviceRequest
- AConsumer
that will call methods onDeleteVirtualMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVirtualMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachGroupPolicy
default CompletableFuture<DetachGroupPolicyResponse> detachGroupPolicy(DetachGroupPolicyRequest detachGroupPolicyRequest) 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.
- Parameters:
detachGroupPolicyRequest
-- Returns:
- A Java Future containing the result of the DetachGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachGroupPolicy
default CompletableFuture<DetachGroupPolicyResponse> detachGroupPolicy(Consumer<DetachGroupPolicyRequest.Builder> detachGroupPolicyRequest) 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 viaDetachGroupPolicyRequest.builder()
- Parameters:
detachGroupPolicyRequest
- AConsumer
that will call methods onDetachGroupPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachRolePolicy
default CompletableFuture<DetachRolePolicyResponse> detachRolePolicy(DetachRolePolicyRequest detachRolePolicyRequest) Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
- Parameters:
detachRolePolicyRequest
-- Returns:
- A Java Future containing the result of the DetachRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachRolePolicy
default CompletableFuture<DetachRolePolicyResponse> detachRolePolicy(Consumer<DetachRolePolicyRequest.Builder> detachRolePolicyRequest) Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use 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 viaDetachRolePolicyRequest.builder()
- Parameters:
detachRolePolicyRequest
- AConsumer
that will call methods onDetachRolePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachUserPolicy
default CompletableFuture<DetachUserPolicyResponse> detachUserPolicy(DetachUserPolicyRequest detachUserPolicyRequest) Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
- Parameters:
detachUserPolicyRequest
-- Returns:
- A Java Future containing the result of the DetachUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachUserPolicy
default CompletableFuture<DetachUserPolicyResponse> detachUserPolicy(Consumer<DetachUserPolicyRequest.Builder> detachUserPolicyRequest) Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use 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 viaDetachUserPolicyRequest.builder()
- Parameters:
detachUserPolicyRequest
- AConsumer
that will call methods onDetachUserPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
enableMFADevice
default CompletableFuture<EnableMfaDeviceResponse> enableMFADevice(EnableMfaDeviceRequest enableMfaDeviceRequest) 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.
- Parameters:
enableMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the EnableMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
enableMFADevice
default CompletableFuture<EnableMfaDeviceResponse> enableMFADevice(Consumer<EnableMfaDeviceRequest.Builder> enableMfaDeviceRequest) 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 viaEnableMfaDeviceRequest.builder()
- Parameters:
enableMfaDeviceRequest
- AConsumer
that will call methods onEnableMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
generateCredentialReport
default CompletableFuture<GenerateCredentialReportResponse> generateCredentialReport(GenerateCredentialReportRequest generateCredentialReportRequest) 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.
- Parameters:
generateCredentialReportRequest
-- Returns:
- A Java Future containing the result of the GenerateCredentialReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
generateCredentialReport
default CompletableFuture<GenerateCredentialReportResponse> generateCredentialReport(Consumer<GenerateCredentialReportRequest.Builder> generateCredentialReportRequest) 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 viaGenerateCredentialReportRequest.builder()
- Parameters:
generateCredentialReportRequest
- AConsumer
that will call methods onGenerateCredentialReportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GenerateCredentialReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
generateCredentialReport
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.
- Returns:
- A Java Future containing the result of the GenerateCredentialReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
generateOrganizationsAccessReport
default CompletableFuture<GenerateOrganizationsAccessReportResponse> generateOrganizationsAccessReport(GenerateOrganizationsAccessReportRequest generateOrganizationsAccessReportRequest) 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 theGetOrganizationsAccessReport
operation to check the status of the report generation. To check the status of this request, use theJobId
parameter in theGetOrganizationsAccessReport
operation and test theJobStatus
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.
- Parameters:
generateOrganizationsAccessReportRequest
-- Returns:
- A Java Future containing the result of the GenerateOrganizationsAccessReport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
generateOrganizationsAccessReport
default CompletableFuture<GenerateOrganizationsAccessReportResponse> generateOrganizationsAccessReport(Consumer<GenerateOrganizationsAccessReportRequest.Builder> generateOrganizationsAccessReportRequest) 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 theGetOrganizationsAccessReport
operation to check the status of the report generation. To check the status of this request, use theJobId
parameter in theGetOrganizationsAccessReport
operation and test theJobStatus
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 viaGenerateOrganizationsAccessReportRequest.builder()
- Parameters:
generateOrganizationsAccessReportRequest
- AConsumer
that will call methods onGenerateOrganizationsAccessReportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GenerateOrganizationsAccessReport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
generateServiceLastAccessedDetails
default CompletableFuture<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. 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 aJobId
. 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 byGenerateServiceLastAccessedDetail
must be used by the same role within a session, or by the same user when used to callGetServiceLastAccessedDetail
. -
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 theJobId
parameter in the same operations and test theJobStatus
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.
- Parameters:
generateServiceLastAccessedDetailsRequest
-- Returns:
- A Java Future containing the result of the GenerateServiceLastAccessedDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
generateServiceLastAccessedDetails
default CompletableFuture<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. 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 aJobId
. 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 byGenerateServiceLastAccessedDetail
must be used by the same role within a session, or by the same user when used to callGetServiceLastAccessedDetail
. -
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 theJobId
parameter in the same operations and test theJobStatus
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 viaGenerateServiceLastAccessedDetailsRequest.builder()
- Parameters:
generateServiceLastAccessedDetailsRequest
- AConsumer
that will call methods onGenerateServiceLastAccessedDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GenerateServiceLastAccessedDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
getAccessKeyLastUsed
default CompletableFuture<GetAccessKeyLastUsedResponse> getAccessKeyLastUsed(GetAccessKeyLastUsedRequest getAccessKeyLastUsedRequest) Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key.
- Parameters:
getAccessKeyLastUsedRequest
-- Returns:
- A Java Future containing the result of the GetAccessKeyLastUsed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessKeyLastUsed
default CompletableFuture<GetAccessKeyLastUsedResponse> getAccessKeyLastUsed(Consumer<GetAccessKeyLastUsedRequest.Builder> getAccessKeyLastUsedRequest) Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the 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 viaGetAccessKeyLastUsedRequest.builder()
- Parameters:
getAccessKeyLastUsedRequest
- AConsumer
that will call methods onGetAccessKeyLastUsedRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccessKeyLastUsed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAuthorizationDetails
default CompletableFuture<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. 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 thejava.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 theMaxItems
andMarker
parameters.- Parameters:
getAccountAuthorizationDetailsRequest
-- Returns:
- A Java Future containing the result of the GetAccountAuthorizationDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAuthorizationDetails
default CompletableFuture<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. 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 thejava.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 theMaxItems
andMarker
parameters.
This is a convenience which creates an instance of the
GetAccountAuthorizationDetailsRequest.Builder
avoiding the need to create one manually viaGetAccountAuthorizationDetailsRequest.builder()
- Parameters:
getAccountAuthorizationDetailsRequest
- AConsumer
that will call methods onGetAccountAuthorizationDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccountAuthorizationDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAuthorizationDetails
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 thejava.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 theMaxItems
andMarker
parameters.- Returns:
- A Java Future containing the result of the GetAccountAuthorizationDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAuthorizationDetailsPaginator
This is a variant of
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsPublisher publisher = client.getAccountAuthorizationDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsPublisher publisher = client.getAccountAuthorizationDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAuthorizationDetailsPaginator
default GetAccountAuthorizationDetailsPublisher getAccountAuthorizationDetailsPaginator(GetAccountAuthorizationDetailsRequest getAccountAuthorizationDetailsRequest) This is a variant of
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsPublisher publisher = client.getAccountAuthorizationDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsPublisher publisher = client.getAccountAuthorizationDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse response) { //... }; });
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.- Parameters:
getAccountAuthorizationDetailsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountAuthorizationDetailsPaginator
default GetAccountAuthorizationDetailsPublisher getAccountAuthorizationDetailsPaginator(Consumer<GetAccountAuthorizationDetailsRequest.Builder> getAccountAuthorizationDetailsRequest) This is a variant of
getAccountAuthorizationDetails(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsPublisher publisher = client.getAccountAuthorizationDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.GetAccountAuthorizationDetailsPublisher publisher = client.getAccountAuthorizationDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.GetAccountAuthorizationDetailsResponse response) { //... }; });
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 viaGetAccountAuthorizationDetailsRequest.builder()
- Parameters:
getAccountAuthorizationDetailsRequest
- AConsumer
that will call methods onGetAccountAuthorizationDetailsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountPasswordPolicy
default CompletableFuture<GetAccountPasswordPolicyResponse> getAccountPasswordPolicy(GetAccountPasswordPolicyRequest getAccountPasswordPolicyRequest) 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.
- Parameters:
getAccountPasswordPolicyRequest
-- Returns:
- A Java Future containing the result of the GetAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountPasswordPolicy
default CompletableFuture<GetAccountPasswordPolicyResponse> getAccountPasswordPolicy(Consumer<GetAccountPasswordPolicyRequest.Builder> getAccountPasswordPolicyRequest) 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 viaGetAccountPasswordPolicyRequest.builder()
- Parameters:
getAccountPasswordPolicyRequest
- AConsumer
that will call methods onGetAccountPasswordPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountPasswordPolicy
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.
- Returns:
- A Java Future containing the result of the GetAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountSummary
default CompletableFuture<GetAccountSummaryResponse> getAccountSummary(GetAccountSummaryRequest getAccountSummaryRequest) 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.
- Parameters:
getAccountSummaryRequest
-- Returns:
- A Java Future containing the result of the GetAccountSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountSummary
default CompletableFuture<GetAccountSummaryResponse> getAccountSummary(Consumer<GetAccountSummaryRequest.Builder> getAccountSummaryRequest) 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 viaGetAccountSummaryRequest.builder()
- Parameters:
getAccountSummaryRequest
- AConsumer
that will call methods onGetAccountSummaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccountSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountSummary
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.
- Returns:
- A Java Future containing the result of the GetAccountSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContextKeysForCustomPolicy
default CompletableFuture<GetContextKeysForCustomPolicyResponse> getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest getContextKeysForCustomPolicyRequest) 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.- Parameters:
getContextKeysForCustomPolicyRequest
-- Returns:
- A Java Future containing the result of the GetContextKeysForCustomPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getContextKeysForCustomPolicy
default CompletableFuture<GetContextKeysForCustomPolicyResponse> getContextKeysForCustomPolicy(Consumer<GetContextKeysForCustomPolicyRequest.Builder> getContextKeysForCustomPolicyRequest) 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 viaGetContextKeysForCustomPolicyRequest.builder()
- Parameters:
getContextKeysForCustomPolicyRequest
- AConsumer
that will call methods onGetContextKeysForCustomPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetContextKeysForCustomPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getContextKeysForPrincipalPolicy
default CompletableFuture<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. 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.
- Parameters:
getContextKeysForPrincipalPolicyRequest
-- Returns:
- A Java Future containing the result of the GetContextKeysForPrincipalPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getContextKeysForPrincipalPolicy
default CompletableFuture<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. 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 viaGetContextKeysForPrincipalPolicyRequest.builder()
- Parameters:
getContextKeysForPrincipalPolicyRequest
- AConsumer
that will call methods onGetContextKeysForPrincipalPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetContextKeysForPrincipalPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getCredentialReport
default CompletableFuture<GetCredentialReportResponse> getCredentialReport(GetCredentialReportRequest getCredentialReportRequest) 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.
- Parameters:
getCredentialReportRequest
-- Returns:
- A Java Future containing the result of the GetCredentialReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getCredentialReport
default CompletableFuture<GetCredentialReportResponse> getCredentialReport(Consumer<GetCredentialReportRequest.Builder> getCredentialReportRequest) 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 viaGetCredentialReportRequest.builder()
- Parameters:
getCredentialReportRequest
- AConsumer
that will call methods onGetCredentialReportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCredentialReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getCredentialReport
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.
- Returns:
- A Java Future containing the result of the GetCredentialReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGroup
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
getGroupRequest
-- Returns:
- A Java Future containing the result of the GetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGroup
default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the
MaxItems
andMarker
parameters.
This is a convenience which creates an instance of the
GetGroupRequest.Builder
avoiding the need to create one manually viaGetGroupRequest.builder()
- Parameters:
getGroupRequest
- AConsumer
that will call methods onGetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGroupPaginator
This is a variant of
getGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.GetGroupPublisher publisher = client.getGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.GetGroupPublisher publisher = client.getGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.GetGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.GetGroupResponse response) { //... }; });
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.- Parameters:
getGroupRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGroupPaginator
This is a variant of
getGroup(software.amazon.awssdk.services.iam.model.GetGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.GetGroupPublisher publisher = client.getGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.GetGroupPublisher publisher = client.getGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.GetGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.GetGroupResponse response) { //... }; });
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 viaGetGroupRequest.builder()
- Parameters:
getGroupRequest
- AConsumer
that will call methods onGetGroupRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGroupPolicy
default CompletableFuture<GetGroupPolicyResponse> getGroupPolicy(GetGroupPolicyRequest getGroupPolicyRequest) 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 thejava.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.
- Parameters:
getGroupPolicyRequest
-- Returns:
- A Java Future containing the result of the GetGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGroupPolicy
default CompletableFuture<GetGroupPolicyResponse> getGroupPolicy(Consumer<GetGroupPolicyRequest.Builder> getGroupPolicyRequest) 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 thejava.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 viaGetGroupPolicyRequest.builder()
- Parameters:
getGroupPolicyRequest
- AConsumer
that will call methods onGetGroupPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getInstanceProfile
default CompletableFuture<GetInstanceProfileResponse> getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest) Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
- Parameters:
getInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the GetInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getInstanceProfile
default CompletableFuture<GetInstanceProfileResponse> getInstanceProfile(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest) 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 viaGetInstanceProfileRequest.builder()
- Parameters:
getInstanceProfileRequest
- AConsumer
that will call methods onGetInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getLoginProfile
default CompletableFuture<GetLoginProfileResponse> getLoginProfile(GetLoginProfileRequest getLoginProfileRequest) 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.- Parameters:
getLoginProfileRequest
-- Returns:
- A Java Future containing the result of the GetLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getLoginProfile
default CompletableFuture<GetLoginProfileResponse> getLoginProfile(Consumer<GetLoginProfileRequest.Builder> getLoginProfileRequest) 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 viaGetLoginProfileRequest.builder()
- Parameters:
getLoginProfileRequest
- AConsumer
that will call methods onGetLoginProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMFADevice
default CompletableFuture<GetMfaDeviceResponse> getMFADevice(GetMfaDeviceRequest getMfaDeviceRequest) Retrieves information about an MFA device for a specified user.
- Parameters:
getMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the GetMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMFADevice
default CompletableFuture<GetMfaDeviceResponse> getMFADevice(Consumer<GetMfaDeviceRequest.Builder> getMfaDeviceRequest) 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 viaGetMfaDeviceRequest.builder()
- Parameters:
getMfaDeviceRequest
- AConsumer
that will call methods onGetMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getOpenIDConnectProvider
default CompletableFuture<GetOpenIdConnectProviderResponse> getOpenIDConnectProvider(GetOpenIdConnectProviderRequest getOpenIdConnectProviderRequest) Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
- Parameters:
getOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the GetOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getOpenIDConnectProvider
default CompletableFuture<GetOpenIdConnectProviderResponse> getOpenIDConnectProvider(Consumer<GetOpenIdConnectProviderRequest.Builder> getOpenIdConnectProviderRequest) 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 viaGetOpenIdConnectProviderRequest.builder()
- Parameters:
getOpenIdConnectProviderRequest
- AConsumer
that will call methods onGetOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getOrganizationsAccessReport
default CompletableFuture<GetOrganizationsAccessReportResponse> getOrganizationsAccessReport(GetOrganizationsAccessReportRequest getOrganizationsAccessReportRequest) 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.
- Parameters:
getOrganizationsAccessReportRequest
-- Returns:
- A Java Future containing the result of the GetOrganizationsAccessReport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getOrganizationsAccessReport
default CompletableFuture<GetOrganizationsAccessReportResponse> getOrganizationsAccessReport(Consumer<GetOrganizationsAccessReportRequest.Builder> getOrganizationsAccessReportRequest) 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 viaGetOrganizationsAccessReportRequest.builder()
- Parameters:
getOrganizationsAccessReportRequest
- AConsumer
that will call methods onGetOrganizationsAccessReportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOrganizationsAccessReport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPolicy
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.
- Parameters:
getPolicyRequest
-- Returns:
- A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPolicy
default CompletableFuture<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. 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 viaGetPolicyRequest.builder()
- Parameters:
getPolicyRequest
- AConsumer
that will call methods onGetPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPolicyVersion
default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) 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 thejava.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.
- Parameters:
getPolicyVersionRequest
-- Returns:
- A Java Future containing the result of the GetPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPolicyVersion
default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) 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 thejava.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 viaGetPolicyVersionRequest.builder()
- Parameters:
getPolicyVersionRequest
- AConsumer
that will call methods onGetPolicyVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRole
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 thejava.net.URLDecoder
utility class in the Java SDK. Other languages and SDKs provide similar functionality.- Parameters:
getRoleRequest
-- Returns:
- A Java Future containing the result of the GetRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRole
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 thejava.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 viaGetRoleRequest.builder()
- Parameters:
getRoleRequest
- AConsumer
that will call methods onGetRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRolePolicy
default CompletableFuture<GetRolePolicyResponse> getRolePolicy(GetRolePolicyRequest getRolePolicyRequest) 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 thejava.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.
- Parameters:
getRolePolicyRequest
-- Returns:
- A Java Future containing the result of the GetRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRolePolicy
default CompletableFuture<GetRolePolicyResponse> getRolePolicy(Consumer<GetRolePolicyRequest.Builder> getRolePolicyRequest) 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 thejava.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 viaGetRolePolicyRequest.builder()
- Parameters:
getRolePolicyRequest
- AConsumer
that will call methods onGetRolePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSAMLProvider
default CompletableFuture<GetSamlProviderResponse> getSAMLProvider(GetSamlProviderRequest getSamlProviderRequest) 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.
- Parameters:
getSamlProviderRequest
-- Returns:
- A Java Future containing the result of the GetSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSAMLProvider
default CompletableFuture<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.
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 viaGetSamlProviderRequest.builder()
- Parameters:
getSamlProviderRequest
- AConsumer
that will call methods onGetSamlProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSSHPublicKey
default CompletableFuture<GetSshPublicKeyResponse> getSSHPublicKey(GetSshPublicKeyRequest getSshPublicKeyRequest) 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.
- Parameters:
getSshPublicKeyRequest
-- Returns:
- A Java Future containing the result of the GetSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSSHPublicKey
default CompletableFuture<GetSshPublicKeyResponse> getSSHPublicKey(Consumer<GetSshPublicKeyRequest.Builder> getSshPublicKeyRequest) 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 viaGetSshPublicKeyRequest.builder()
- Parameters:
getSshPublicKeyRequest
- AConsumer
that will call methods onGetSshPublicKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getServerCertificate
default CompletableFuture<GetServerCertificateResponse> getServerCertificate(GetServerCertificateRequest getServerCertificateRequest) 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.
- Parameters:
getServerCertificateRequest
-- Returns:
- A Java Future containing the result of the GetServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getServerCertificate
default CompletableFuture<GetServerCertificateResponse> getServerCertificate(Consumer<GetServerCertificateRequest.Builder> getServerCertificateRequest) 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 viaGetServerCertificateRequest.builder()
- Parameters:
getServerCertificateRequest
- AConsumer
that will call methods onGetServerCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getServiceLastAccessedDetails
default CompletableFuture<GetServiceLastAccessedDetailsResponse> getServiceLastAccessedDetails(GetServiceLastAccessedDetailsRequest getServiceLastAccessedDetailsRequest) Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails
operation. You can use theJobId
parameter inGetServiceLastAccessedDetails
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.
- Parameters:
getServiceLastAccessedDetailsRequest
-- Returns:
- A Java Future containing the result of the GetServiceLastAccessedDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
getServiceLastAccessedDetails
default CompletableFuture<GetServiceLastAccessedDetailsResponse> getServiceLastAccessedDetails(Consumer<GetServiceLastAccessedDetailsRequest.Builder> getServiceLastAccessedDetailsRequest) Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails
operation. You can use theJobId
parameter inGetServiceLastAccessedDetails
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 viaGetServiceLastAccessedDetailsRequest.builder()
- Parameters:
getServiceLastAccessedDetailsRequest
- AConsumer
that will call methods onGetServiceLastAccessedDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetServiceLastAccessedDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
getServiceLastAccessedDetailsWithEntities
default CompletableFuture<GetServiceLastAccessedDetailsWithEntitiesResponse> getServiceLastAccessedDetailsWithEntities(GetServiceLastAccessedDetailsWithEntitiesRequest getServiceLastAccessedDetailsWithEntitiesRequest) After you generate a group or policy report using the
GenerateServiceLastAccessedDetails
operation, you can use theJobId
parameter inGetServiceLastAccessedDetailsWithEntities
. 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.
- Parameters:
getServiceLastAccessedDetailsWithEntitiesRequest
-- Returns:
- A Java Future containing the result of the GetServiceLastAccessedDetailsWithEntities operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
getServiceLastAccessedDetailsWithEntities
default CompletableFuture<GetServiceLastAccessedDetailsWithEntitiesResponse> getServiceLastAccessedDetailsWithEntities(Consumer<GetServiceLastAccessedDetailsWithEntitiesRequest.Builder> getServiceLastAccessedDetailsWithEntitiesRequest) After you generate a group or policy report using the
GenerateServiceLastAccessedDetails
operation, you can use theJobId
parameter inGetServiceLastAccessedDetailsWithEntities
. 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 viaGetServiceLastAccessedDetailsWithEntitiesRequest.builder()
- Parameters:
getServiceLastAccessedDetailsWithEntitiesRequest
- AConsumer
that will call methods onGetServiceLastAccessedDetailsWithEntitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetServiceLastAccessedDetailsWithEntities operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
getServiceLinkedRoleDeletionStatus
default CompletableFuture<GetServiceLinkedRoleDeletionStatusResponse> getServiceLinkedRoleDeletionStatus(GetServiceLinkedRoleDeletionStatusRequest getServiceLinkedRoleDeletionStatusRequest) 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 inGetServiceLinkedRoleDeletionStatus
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.- Parameters:
getServiceLinkedRoleDeletionStatusRequest
-- Returns:
- A Java Future containing the result of the GetServiceLinkedRoleDeletionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getServiceLinkedRoleDeletionStatus
default CompletableFuture<GetServiceLinkedRoleDeletionStatusResponse> getServiceLinkedRoleDeletionStatus(Consumer<GetServiceLinkedRoleDeletionStatusRequest.Builder> getServiceLinkedRoleDeletionStatusRequest) 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 inGetServiceLinkedRoleDeletionStatus
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 viaGetServiceLinkedRoleDeletionStatusRequest.builder()
- Parameters:
getServiceLinkedRoleDeletionStatusRequest
- AConsumer
that will call methods onGetServiceLinkedRoleDeletionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetServiceLinkedRoleDeletionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUser
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.
- Parameters:
getUserRequest
-- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUser
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 viaGetUserRequest.builder()
- Parameters:
getUserRequest
- AConsumer
that will call methods onGetUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUser
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.
- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUserPolicy
default CompletableFuture<GetUserPolicyResponse> getUserPolicy(GetUserPolicyRequest getUserPolicyRequest) 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 thejava.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.
- Parameters:
getUserPolicyRequest
-- Returns:
- A Java Future containing the result of the GetUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUserPolicy
default CompletableFuture<GetUserPolicyResponse> getUserPolicy(Consumer<GetUserPolicyRequest.Builder> getUserPolicyRequest) 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 thejava.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 viaGetUserPolicyRequest.builder()
- Parameters:
getUserPolicyRequest
- AConsumer
that will call methods onGetUserPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccessKeys
default CompletableFuture<ListAccessKeysResponse> listAccessKeys(ListAccessKeysRequest listAccessKeysRequest) 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
andMarker
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, thenUserName
is required. If a long-term key is assigned to the user, thenUserName
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.
- Parameters:
listAccessKeysRequest
-- Returns:
- A Java Future containing the result of the ListAccessKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccessKeys
default CompletableFuture<ListAccessKeysResponse> listAccessKeys(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest) 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
andMarker
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, thenUserName
is required. If a long-term key is assigned to the user, thenUserName
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 viaListAccessKeysRequest.builder()
- Parameters:
listAccessKeysRequest
- AConsumer
that will call methods onListAccessKeysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccessKeys
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
andMarker
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, thenUserName
is required. If a long-term key is assigned to the user, thenUserName
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.
- Returns:
- A Java Future containing the result of the ListAccessKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccessKeysPaginator
This is a variant of
listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAccessKeysPublisher publisher = client.listAccessKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAccessKeysPublisher publisher = client.listAccessKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAccessKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAccessKeysResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccessKeysPaginator
default ListAccessKeysPublisher listAccessKeysPaginator(ListAccessKeysRequest listAccessKeysRequest) This is a variant of
listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAccessKeysPublisher publisher = client.listAccessKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAccessKeysPublisher publisher = client.listAccessKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAccessKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAccessKeysResponse response) { //... }; });
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.- Parameters:
listAccessKeysRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccessKeysPaginator
default ListAccessKeysPublisher listAccessKeysPaginator(Consumer<ListAccessKeysRequest.Builder> listAccessKeysRequest) This is a variant of
listAccessKeys(software.amazon.awssdk.services.iam.model.ListAccessKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAccessKeysPublisher publisher = client.listAccessKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAccessKeysPublisher publisher = client.listAccessKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAccessKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAccessKeysResponse response) { //... }; });
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 viaListAccessKeysRequest.builder()
- Parameters:
listAccessKeysRequest
- AConsumer
that will call methods onListAccessKeysRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAliases
default CompletableFuture<ListAccountAliasesResponse> listAccountAliases(ListAccountAliasesRequest listAccountAliasesRequest) 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 IAM User Guide.
- Parameters:
listAccountAliasesRequest
-- Returns:
- A Java Future containing the result of the ListAccountAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccountAliases
default CompletableFuture<ListAccountAliasesResponse> listAccountAliases(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) 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 IAM User Guide.
This is a convenience which creates an instance of the
ListAccountAliasesRequest.Builder
avoiding the need to create one manually viaListAccountAliasesRequest.builder()
- Parameters:
listAccountAliasesRequest
- AConsumer
that will call methods onListAccountAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccountAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccountAliases
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 IAM User Guide.
- Returns:
- A Java Future containing the result of the ListAccountAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccountAliasesPaginator
This is a variant of
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAccountAliasesPublisher publisher = client.listAccountAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesPublisher publisher = client.listAccountAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccountAliasesPaginator
default ListAccountAliasesPublisher listAccountAliasesPaginator(ListAccountAliasesRequest listAccountAliasesRequest) This is a variant of
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAccountAliasesPublisher publisher = client.listAccountAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesPublisher publisher = client.listAccountAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse response) { //... }; });
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.- Parameters:
listAccountAliasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccountAliasesPaginator
default ListAccountAliasesPublisher listAccountAliasesPaginator(Consumer<ListAccountAliasesRequest.Builder> listAccountAliasesRequest) This is a variant of
listAccountAliases(software.amazon.awssdk.services.iam.model.ListAccountAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAccountAliasesPublisher publisher = client.listAccountAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAccountAliasesPublisher publisher = client.listAccountAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAccountAliasesResponse response) { //... }; });
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 viaListAccountAliasesRequest.builder()
- Parameters:
listAccountAliasesRequest
- AConsumer
that will call methods onListAccountAliasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAttachedGroupPolicies
default CompletableFuture<ListAttachedGroupPoliciesResponse> listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest) 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
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.- Parameters:
listAttachedGroupPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListAttachedGroupPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedGroupPolicies
default CompletableFuture<ListAttachedGroupPoliciesResponse> listAttachedGroupPolicies(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest) 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
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
This is a convenience which creates an instance of the
ListAttachedGroupPoliciesRequest.Builder
avoiding the need to create one manually viaListAttachedGroupPoliciesRequest.builder()
- Parameters:
listAttachedGroupPoliciesRequest
- AConsumer
that will call methods onListAttachedGroupPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttachedGroupPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedGroupPoliciesPaginator
default ListAttachedGroupPoliciesPublisher listAttachedGroupPoliciesPaginator(ListAttachedGroupPoliciesRequest listAttachedGroupPoliciesRequest) This is a variant of
listAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesPublisher publisher = client.listAttachedGroupPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesPublisher publisher = client.listAttachedGroupPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesResponse response) { //... }; });
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.- Parameters:
listAttachedGroupPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedGroupPoliciesPaginator
default ListAttachedGroupPoliciesPublisher listAttachedGroupPoliciesPaginator(Consumer<ListAttachedGroupPoliciesRequest.Builder> listAttachedGroupPoliciesRequest) This is a variant of
listAttachedGroupPolicies(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesPublisher publisher = client.listAttachedGroupPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAttachedGroupPoliciesPublisher publisher = client.listAttachedGroupPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAttachedGroupPoliciesResponse response) { //... }; });
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 viaListAttachedGroupPoliciesRequest.builder()
- Parameters:
listAttachedGroupPoliciesRequest
- AConsumer
that will call methods onListAttachedGroupPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedRolePolicies
default CompletableFuture<ListAttachedRolePoliciesResponse> listAttachedRolePolicies(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest) 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
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.- Parameters:
listAttachedRolePoliciesRequest
-- Returns:
- A Java Future containing the result of the ListAttachedRolePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedRolePolicies
default CompletableFuture<ListAttachedRolePoliciesResponse> listAttachedRolePolicies(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest) 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
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.
This is a convenience which creates an instance of the
ListAttachedRolePoliciesRequest.Builder
avoiding the need to create one manually viaListAttachedRolePoliciesRequest.builder()
- Parameters:
listAttachedRolePoliciesRequest
- AConsumer
that will call methods onListAttachedRolePoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttachedRolePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedRolePoliciesPaginator
default ListAttachedRolePoliciesPublisher listAttachedRolePoliciesPaginator(ListAttachedRolePoliciesRequest listAttachedRolePoliciesRequest) This is a variant of
listAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesPublisher publisher = client.listAttachedRolePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesPublisher publisher = client.listAttachedRolePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesResponse response) { //... }; });
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.- Parameters:
listAttachedRolePoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedRolePoliciesPaginator
default ListAttachedRolePoliciesPublisher listAttachedRolePoliciesPaginator(Consumer<ListAttachedRolePoliciesRequest.Builder> listAttachedRolePoliciesRequest) This is a variant of
listAttachedRolePolicies(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesPublisher publisher = client.listAttachedRolePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAttachedRolePoliciesPublisher publisher = client.listAttachedRolePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAttachedRolePoliciesResponse response) { //... }; });
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 viaListAttachedRolePoliciesRequest.builder()
- Parameters:
listAttachedRolePoliciesRequest
- AConsumer
that will call methods onListAttachedRolePoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedUserPolicies
default CompletableFuture<ListAttachedUserPoliciesResponse> listAttachedUserPolicies(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest) 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
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.- Parameters:
listAttachedUserPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListAttachedUserPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedUserPolicies
default CompletableFuture<ListAttachedUserPoliciesResponse> listAttachedUserPolicies(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest) 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
andMarker
parameters. You can use thePathPrefix
parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
This is a convenience which creates an instance of the
ListAttachedUserPoliciesRequest.Builder
avoiding the need to create one manually viaListAttachedUserPoliciesRequest.builder()
- Parameters:
listAttachedUserPoliciesRequest
- AConsumer
that will call methods onListAttachedUserPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttachedUserPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedUserPoliciesPaginator
default ListAttachedUserPoliciesPublisher listAttachedUserPoliciesPaginator(ListAttachedUserPoliciesRequest listAttachedUserPoliciesRequest) This is a variant of
listAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesPublisher publisher = client.listAttachedUserPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesPublisher publisher = client.listAttachedUserPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesResponse response) { //... }; });
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.- Parameters:
listAttachedUserPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttachedUserPoliciesPaginator
default ListAttachedUserPoliciesPublisher listAttachedUserPoliciesPaginator(Consumer<ListAttachedUserPoliciesRequest.Builder> listAttachedUserPoliciesRequest) This is a variant of
listAttachedUserPolicies(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesPublisher publisher = client.listAttachedUserPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListAttachedUserPoliciesPublisher publisher = client.listAttachedUserPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListAttachedUserPoliciesResponse response) { //... }; });
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 viaListAttachedUserPoliciesRequest.builder()
- Parameters:
listAttachedUserPoliciesRequest
- AConsumer
that will call methods onListAttachedUserPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listEntitiesForPolicy
default CompletableFuture<ListEntitiesForPolicyResponse> listEntitiesForPolicy(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest) Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional
EntityFilter
parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, setEntityFilter
toRole
.You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listEntitiesForPolicyRequest
-- Returns:
- A Java Future containing the result of the ListEntitiesForPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listEntitiesForPolicy
default CompletableFuture<ListEntitiesForPolicyResponse> listEntitiesForPolicy(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest) Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional
EntityFilter
parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, setEntityFilter
toRole
.You can paginate the results using the
MaxItems
andMarker
parameters.
This is a convenience which creates an instance of the
ListEntitiesForPolicyRequest.Builder
avoiding the need to create one manually viaListEntitiesForPolicyRequest.builder()
- Parameters:
listEntitiesForPolicyRequest
- AConsumer
that will call methods onListEntitiesForPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEntitiesForPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listEntitiesForPolicyPaginator
default ListEntitiesForPolicyPublisher listEntitiesForPolicyPaginator(ListEntitiesForPolicyRequest listEntitiesForPolicyRequest) This is a variant of
listEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyPublisher publisher = client.listEntitiesForPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyPublisher publisher = client.listEntitiesForPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyResponse response) { //... }; });
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.- Parameters:
listEntitiesForPolicyRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listEntitiesForPolicyPaginator
default ListEntitiesForPolicyPublisher listEntitiesForPolicyPaginator(Consumer<ListEntitiesForPolicyRequest.Builder> listEntitiesForPolicyRequest) This is a variant of
listEntitiesForPolicy(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyPublisher publisher = client.listEntitiesForPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListEntitiesForPolicyPublisher publisher = client.listEntitiesForPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListEntitiesForPolicyResponse response) { //... }; });
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 viaListEntitiesForPolicyRequest.builder()
- Parameters:
listEntitiesForPolicyRequest
- AConsumer
that will call methods onListEntitiesForPolicyRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupPolicies
default CompletableFuture<ListGroupPoliciesResponse> listGroupPolicies(ListGroupPoliciesRequest listGroupPoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.- Parameters:
listGroupPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListGroupPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupPolicies
default CompletableFuture<ListGroupPoliciesResponse> listGroupPolicies(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.
This is a convenience which creates an instance of the
ListGroupPoliciesRequest.Builder
avoiding the need to create one manually viaListGroupPoliciesRequest.builder()
- Parameters:
listGroupPoliciesRequest
- AConsumer
that will call methods onListGroupPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroupPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupPoliciesPaginator
default ListGroupPoliciesPublisher listGroupPoliciesPaginator(ListGroupPoliciesRequest listGroupPoliciesRequest) This is a variant of
listGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupPoliciesPublisher publisher = client.listGroupPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesPublisher publisher = client.listGroupPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupPoliciesResponse response) { //... }; });
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.- Parameters:
listGroupPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupPoliciesPaginator
default ListGroupPoliciesPublisher listGroupPoliciesPaginator(Consumer<ListGroupPoliciesRequest.Builder> listGroupPoliciesRequest) This is a variant of
listGroupPolicies(software.amazon.awssdk.services.iam.model.ListGroupPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupPoliciesPublisher publisher = client.listGroupPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupPoliciesPublisher publisher = client.listGroupPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupPoliciesResponse response) { //... }; });
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 viaListGroupPoliciesRequest.builder()
- Parameters:
listGroupPoliciesRequest
- AConsumer
that will call methods onListGroupPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroups
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listGroupsRequest
-- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists the IAM groups that have the specified path prefix.
You can paginate the results using the
MaxItems
andMarker
parameters.
This is a convenience which creates an instance of the
ListGroupsRequest.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the
MaxItems
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsForUser
default CompletableFuture<ListGroupsForUserResponse> listGroupsForUser(ListGroupsForUserRequest listGroupsForUserRequest) Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the
MaxItems
andMarker
parameters.- Parameters:
listGroupsForUserRequest
-- Returns:
- A Java Future containing the result of the ListGroupsForUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupsForUser
default CompletableFuture<ListGroupsForUserResponse> listGroupsForUser(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest) Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the
MaxItems
andMarker
parameters.
This is a convenience which creates an instance of the
ListGroupsForUserRequest.Builder
avoiding the need to create one manually viaListGroupsForUserRequest.builder()
- Parameters:
listGroupsForUserRequest
- AConsumer
that will call methods onListGroupsForUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroupsForUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupsForUserPaginator
default ListGroupsForUserPublisher listGroupsForUserPaginator(ListGroupsForUserRequest listGroupsForUserRequest) This is a variant of
listGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupsForUserPublisher publisher = client.listGroupsForUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupsForUserPublisher publisher = client.listGroupsForUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupsForUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupsForUserResponse response) { //... }; });
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.- Parameters:
listGroupsForUserRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupsForUserPaginator
default ListGroupsForUserPublisher listGroupsForUserPaginator(Consumer<ListGroupsForUserRequest.Builder> listGroupsForUserRequest) This is a variant of
listGroupsForUser(software.amazon.awssdk.services.iam.model.ListGroupsForUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupsForUserPublisher publisher = client.listGroupsForUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupsForUserPublisher publisher = client.listGroupsForUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupsForUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupsForUserResponse response) { //... }; });
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 viaListGroupsForUserRequest.builder()
- Parameters:
listGroupsForUserRequest
- AConsumer
that will call methods onListGroupsForUserRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listGroupsPaginator
This is a variant of
listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupsResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
This is a variant of
listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupsResponse response) { //... }; });
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.- Parameters:
listGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant of
listGroups(software.amazon.awssdk.services.iam.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListGroupsResponse response) { //... }; });
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 viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInstanceProfileTags
default CompletableFuture<ListInstanceProfileTagsResponse> listInstanceProfileTags(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest) 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.
- Parameters:
listInstanceProfileTagsRequest
-- Returns:
- A Java Future containing the result of the ListInstanceProfileTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfileTags
default CompletableFuture<ListInstanceProfileTagsResponse> listInstanceProfileTags(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest) 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 viaListInstanceProfileTagsRequest.builder()
- Parameters:
listInstanceProfileTagsRequest
- AConsumer
that will call methods onListInstanceProfileTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInstanceProfileTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfileTagsPaginator
default ListInstanceProfileTagsPublisher listInstanceProfileTagsPaginator(ListInstanceProfileTagsRequest listInstanceProfileTagsRequest) This is a variant of
listInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsPublisher publisher = client.listInstanceProfileTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsPublisher publisher = client.listInstanceProfileTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsResponse response) { //... }; });
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.- Parameters:
listInstanceProfileTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfileTagsPaginator
default ListInstanceProfileTagsPublisher listInstanceProfileTagsPaginator(Consumer<ListInstanceProfileTagsRequest.Builder> listInstanceProfileTagsRequest) This is a variant of
listInstanceProfileTags(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsPublisher publisher = client.listInstanceProfileTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfileTagsPublisher publisher = client.listInstanceProfileTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfileTagsResponse response) { //... }; });
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 viaListInstanceProfileTagsRequest.builder()
- Parameters:
listInstanceProfileTagsRequest
- AConsumer
that will call methods onListInstanceProfileTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfiles
default CompletableFuture<ListInstanceProfilesResponse> listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest) 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
andMarker
parameters.- Parameters:
listInstanceProfilesRequest
-- Returns:
- A Java Future containing the result of the ListInstanceProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInstanceProfiles
default CompletableFuture<ListInstanceProfilesResponse> listInstanceProfiles(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest) 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
andMarker
parameters.
This is a convenience which creates an instance of the
ListInstanceProfilesRequest.Builder
avoiding the need to create one manually viaListInstanceProfilesRequest.builder()
- Parameters:
listInstanceProfilesRequest
- AConsumer
that will call methods onListInstanceProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInstanceProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInstanceProfiles
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
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListInstanceProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInstanceProfilesForRole
default CompletableFuture<ListInstanceProfilesForRoleResponse> listInstanceProfilesForRole(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) 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
andMarker
parameters.- Parameters:
listInstanceProfilesForRoleRequest
-- Returns:
- A Java Future containing the result of the ListInstanceProfilesForRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfilesForRole
default CompletableFuture<ListInstanceProfilesForRoleResponse> listInstanceProfilesForRole(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest) 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
andMarker
parameters.
This is a convenience which creates an instance of the
ListInstanceProfilesForRoleRequest.Builder
avoiding the need to create one manually viaListInstanceProfilesForRoleRequest.builder()
- Parameters:
listInstanceProfilesForRoleRequest
- AConsumer
that will call methods onListInstanceProfilesForRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInstanceProfilesForRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfilesForRolePaginator
default ListInstanceProfilesForRolePublisher listInstanceProfilesForRolePaginator(ListInstanceProfilesForRoleRequest listInstanceProfilesForRoleRequest) This is a variant of
listInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRolePublisher publisher = client.listInstanceProfilesForRolePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRolePublisher publisher = client.listInstanceProfilesForRolePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleResponse response) { //... }; });
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.- Parameters:
listInstanceProfilesForRoleRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfilesForRolePaginator
default ListInstanceProfilesForRolePublisher listInstanceProfilesForRolePaginator(Consumer<ListInstanceProfilesForRoleRequest.Builder> listInstanceProfilesForRoleRequest) This is a variant of
listInstanceProfilesForRole(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRolePublisher publisher = client.listInstanceProfilesForRolePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesForRolePublisher publisher = client.listInstanceProfilesForRolePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfilesForRoleResponse response) { //... }; });
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 viaListInstanceProfilesForRoleRequest.builder()
- Parameters:
listInstanceProfilesForRoleRequest
- AConsumer
that will call methods onListInstanceProfilesForRoleRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstanceProfilesPaginator
This is a variant of
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfilesPublisher publisher = client.listInstanceProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesPublisher publisher = client.listInstanceProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInstanceProfilesPaginator
default ListInstanceProfilesPublisher listInstanceProfilesPaginator(ListInstanceProfilesRequest listInstanceProfilesRequest) This is a variant of
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfilesPublisher publisher = client.listInstanceProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesPublisher publisher = client.listInstanceProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse response) { //... }; });
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.- Parameters:
listInstanceProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInstanceProfilesPaginator
default ListInstanceProfilesPublisher listInstanceProfilesPaginator(Consumer<ListInstanceProfilesRequest.Builder> listInstanceProfilesRequest) This is a variant of
listInstanceProfiles(software.amazon.awssdk.services.iam.model.ListInstanceProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListInstanceProfilesPublisher publisher = client.listInstanceProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListInstanceProfilesPublisher publisher = client.listInstanceProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListInstanceProfilesResponse response) { //... }; });
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 viaListInstanceProfilesRequest.builder()
- Parameters:
listInstanceProfilesRequest
- AConsumer
that will call methods onListInstanceProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMFADeviceTags
default CompletableFuture<ListMfaDeviceTagsResponse> listMFADeviceTags(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest) 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.
- Parameters:
listMfaDeviceTagsRequest
-- Returns:
- A Java Future containing the result of the ListMFADeviceTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADeviceTags
default CompletableFuture<ListMfaDeviceTagsResponse> listMFADeviceTags(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest) 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 viaListMfaDeviceTagsRequest.builder()
- Parameters:
listMfaDeviceTagsRequest
- AConsumer
that will call methods onListMfaDeviceTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMFADeviceTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADeviceTagsPaginator
default ListMFADeviceTagsPublisher listMFADeviceTagsPaginator(ListMfaDeviceTagsRequest listMfaDeviceTagsRequest) This is a variant of
listMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsPublisher publisher = client.listMFADeviceTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsPublisher publisher = client.listMFADeviceTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsResponse response) { //... }; });
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.- Parameters:
listMfaDeviceTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADeviceTagsPaginator
default ListMFADeviceTagsPublisher listMFADeviceTagsPaginator(Consumer<ListMfaDeviceTagsRequest.Builder> listMfaDeviceTagsRequest) This is a variant of
listMFADeviceTags(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsPublisher publisher = client.listMFADeviceTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListMFADeviceTagsPublisher publisher = client.listMFADeviceTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListMfaDeviceTagsResponse response) { //... }; });
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 viaListMfaDeviceTagsRequest.builder()
- Parameters:
listMfaDeviceTagsRequest
- AConsumer
that will call methods onListMfaDeviceTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADevices
default CompletableFuture<ListMfaDevicesResponse> listMFADevices(ListMfaDevicesRequest listMfaDevicesRequest) 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
andMarker
parameters.- Parameters:
listMfaDevicesRequest
-- Returns:
- A Java Future containing the result of the ListMFADevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADevices
default CompletableFuture<ListMfaDevicesResponse> listMFADevices(Consumer<ListMfaDevicesRequest.Builder> listMfaDevicesRequest) 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
andMarker
parameters.
This is a convenience which creates an instance of the
ListMfaDevicesRequest.Builder
avoiding the need to create one manually viaListMfaDevicesRequest.builder()
- Parameters:
listMfaDevicesRequest
- AConsumer
that will call methods onListMfaDevicesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMFADevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADevices
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
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListMFADevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADevicesPaginator
This is a variant of
listMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListMFADevicesPublisher publisher = client.listMFADevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListMFADevicesPublisher publisher = client.listMFADevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListMfaDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListMfaDevicesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADevicesPaginator
default ListMFADevicesPublisher listMFADevicesPaginator(ListMfaDevicesRequest listMfaDevicesRequest) This is a variant of
listMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListMFADevicesPublisher publisher = client.listMFADevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListMFADevicesPublisher publisher = client.listMFADevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListMfaDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListMfaDevicesResponse response) { //... }; });
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.- Parameters:
listMfaDevicesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMFADevicesPaginator
default ListMFADevicesPublisher listMFADevicesPaginator(Consumer<ListMfaDevicesRequest.Builder> listMfaDevicesRequest) This is a variant of
listMFADevices(software.amazon.awssdk.services.iam.model.ListMfaDevicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListMFADevicesPublisher publisher = client.listMFADevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListMFADevicesPublisher publisher = client.listMFADevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListMfaDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListMfaDevicesResponse response) { //... }; });
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 viaListMfaDevicesRequest.builder()
- Parameters:
listMfaDevicesRequest
- AConsumer
that will call methods onListMfaDevicesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listOpenIDConnectProviderTags
default CompletableFuture<ListOpenIdConnectProviderTagsResponse> listOpenIDConnectProviderTags(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest) 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.
- Parameters:
listOpenIdConnectProviderTagsRequest
-- Returns:
- A Java Future containing the result of the ListOpenIDConnectProviderTags operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listOpenIDConnectProviderTags
default CompletableFuture<ListOpenIdConnectProviderTagsResponse> listOpenIDConnectProviderTags(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest) 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 viaListOpenIdConnectProviderTagsRequest.builder()
- Parameters:
listOpenIdConnectProviderTagsRequest
- AConsumer
that will call methods onListOpenIdConnectProviderTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOpenIDConnectProviderTags operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listOpenIDConnectProviderTagsPaginator
default ListOpenIDConnectProviderTagsPublisher listOpenIDConnectProviderTagsPaginator(ListOpenIdConnectProviderTagsRequest listOpenIdConnectProviderTagsRequest) This is a variant of
listOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsPublisher publisher = client.listOpenIDConnectProviderTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsPublisher publisher = client.listOpenIDConnectProviderTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsResponse response) { //... }; });
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.- Parameters:
listOpenIdConnectProviderTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listOpenIDConnectProviderTagsPaginator
default ListOpenIDConnectProviderTagsPublisher listOpenIDConnectProviderTagsPaginator(Consumer<ListOpenIdConnectProviderTagsRequest.Builder> listOpenIdConnectProviderTagsRequest) This is a variant of
listOpenIDConnectProviderTags(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsPublisher publisher = client.listOpenIDConnectProviderTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListOpenIDConnectProviderTagsPublisher publisher = client.listOpenIDConnectProviderTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListOpenIdConnectProviderTagsResponse response) { //... }; });
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 viaListOpenIdConnectProviderTagsRequest.builder()
- Parameters:
listOpenIdConnectProviderTagsRequest
- AConsumer
that will call methods onListOpenIdConnectProviderTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listOpenIDConnectProviders
default CompletableFuture<ListOpenIdConnectProvidersResponse> listOpenIDConnectProviders(ListOpenIdConnectProvidersRequest listOpenIdConnectProvidersRequest) 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.
- Parameters:
listOpenIdConnectProvidersRequest
-- Returns:
- A Java Future containing the result of the ListOpenIDConnectProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOpenIDConnectProviders
default CompletableFuture<ListOpenIdConnectProvidersResponse> listOpenIDConnectProviders(Consumer<ListOpenIdConnectProvidersRequest.Builder> listOpenIdConnectProvidersRequest) 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 viaListOpenIdConnectProvidersRequest.builder()
- Parameters:
listOpenIdConnectProvidersRequest
- AConsumer
that will call methods onListOpenIdConnectProvidersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOpenIDConnectProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOpenIDConnectProviders
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.
- Returns:
- A Java Future containing the result of the ListOpenIDConnectProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicies
default CompletableFuture<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.
You can filter the list of policies that is returned using the optional
OnlyAttached
,Scope
, andPathPrefix
parameters. For example, to list only the customer managed policies in your Amazon Web Services account, setScope
toLocal
. To list only Amazon Web Services managed policies, setScope
toAWS
.You can paginate the results using the
MaxItems
andMarker
parameters.For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
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.
- Parameters:
listPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicies
default CompletableFuture<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.
You can filter the list of policies that is returned using the optional
OnlyAttached
,Scope
, andPathPrefix
parameters. For example, to list only the customer managed policies in your Amazon Web Services account, setScope
toLocal
. To list only Amazon Web Services managed policies, setScope
toAWS
.You can paginate the results using the
MaxItems
andMarker
parameters.For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
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 viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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.
You can filter the list of policies that is returned using the optional
OnlyAttached
,Scope
, andPathPrefix
parameters. For example, to list only the customer managed policies in your Amazon Web Services account, setScope
toLocal
. To list only Amazon Web Services managed policies, setScope
toAWS
.You can paginate the results using the
MaxItems
andMarker
parameters.For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
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.
- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoliciesGrantingServiceAccess
default CompletableFuture<ListPoliciesGrantingServiceAccessResponse> listPoliciesGrantingServiceAccess(ListPoliciesGrantingServiceAccessRequest listPoliciesGrantingServiceAccessRequest) 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.
- Parameters:
listPoliciesGrantingServiceAccessRequest
-- Returns:
- A Java Future containing the result of the ListPoliciesGrantingServiceAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listPoliciesGrantingServiceAccess
default CompletableFuture<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.
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 viaListPoliciesGrantingServiceAccessRequest.builder()
- Parameters:
listPoliciesGrantingServiceAccessRequest
- AConsumer
that will call methods onListPoliciesGrantingServiceAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPoliciesGrantingServiceAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listPoliciesPaginator
This is a variant of
listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPoliciesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoliciesPaginator
This is a variant of
listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPoliciesResponse response) { //... }; });
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.- Parameters:
listPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoliciesPaginator
default ListPoliciesPublisher listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant of
listPolicies(software.amazon.awssdk.services.iam.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPoliciesResponse response) { //... }; });
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 viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyTags
default CompletableFuture<ListPolicyTagsResponse> listPolicyTags(ListPolicyTagsRequest listPolicyTagsRequest) 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.
- Parameters:
listPolicyTagsRequest
-- Returns:
- A Java Future containing the result of the ListPolicyTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyTags
default CompletableFuture<ListPolicyTagsResponse> listPolicyTags(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest) 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 viaListPolicyTagsRequest.builder()
- Parameters:
listPolicyTagsRequest
- AConsumer
that will call methods onListPolicyTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPolicyTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyTagsPaginator
default ListPolicyTagsPublisher listPolicyTagsPaginator(ListPolicyTagsRequest listPolicyTagsRequest) This is a variant of
listPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPolicyTagsPublisher publisher = client.listPolicyTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPolicyTagsPublisher publisher = client.listPolicyTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPolicyTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPolicyTagsResponse response) { //... }; });
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.- Parameters:
listPolicyTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyTagsPaginator
default ListPolicyTagsPublisher listPolicyTagsPaginator(Consumer<ListPolicyTagsRequest.Builder> listPolicyTagsRequest) This is a variant of
listPolicyTags(software.amazon.awssdk.services.iam.model.ListPolicyTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPolicyTagsPublisher publisher = client.listPolicyTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPolicyTagsPublisher publisher = client.listPolicyTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPolicyTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPolicyTagsResponse response) { //... }; });
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 viaListPolicyTagsRequest.builder()
- Parameters:
listPolicyTagsRequest
- AConsumer
that will call methods onListPolicyTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyVersions
default CompletableFuture<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.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
- Parameters:
listPolicyVersionsRequest
-- Returns:
- A Java Future containing the result of the ListPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyVersions
default CompletableFuture<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.
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 viaListPolicyVersionsRequest.builder()
- Parameters:
listPolicyVersionsRequest
- AConsumer
that will call methods onListPolicyVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyVersionsPaginator
default ListPolicyVersionsPublisher listPolicyVersionsPaginator(ListPolicyVersionsRequest listPolicyVersionsRequest) This is a variant of
listPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPolicyVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPolicyVersionsResponse response) { //... }; });
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.- Parameters:
listPolicyVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPolicyVersionsPaginator
default ListPolicyVersionsPublisher listPolicyVersionsPaginator(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) This is a variant of
listPolicyVersions(software.amazon.awssdk.services.iam.model.ListPolicyVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListPolicyVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListPolicyVersionsResponse response) { //... }; });
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 viaListPolicyVersionsRequest.builder()
- Parameters:
listPolicyVersionsRequest
- AConsumer
that will call methods onListPolicyVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRolePolicies
default CompletableFuture<ListRolePoliciesResponse> listRolePolicies(ListRolePoliciesRequest listRolePoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.- Parameters:
listRolePoliciesRequest
-- Returns:
- A Java Future containing the result of the ListRolePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRolePolicies
default CompletableFuture<ListRolePoliciesResponse> listRolePolicies(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest) Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.
This is a convenience which creates an instance of the
ListRolePoliciesRequest.Builder
avoiding the need to create one manually viaListRolePoliciesRequest.builder()
- Parameters:
listRolePoliciesRequest
- AConsumer
that will call methods onListRolePoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRolePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRolePoliciesPaginator
default ListRolePoliciesPublisher listRolePoliciesPaginator(ListRolePoliciesRequest listRolePoliciesRequest) This is a variant of
listRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRolePoliciesPublisher publisher = client.listRolePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRolePoliciesPublisher publisher = client.listRolePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRolePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRolePoliciesResponse response) { //... }; });
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.- Parameters:
listRolePoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRolePoliciesPaginator
default ListRolePoliciesPublisher listRolePoliciesPaginator(Consumer<ListRolePoliciesRequest.Builder> listRolePoliciesRequest) This is a variant of
listRolePolicies(software.amazon.awssdk.services.iam.model.ListRolePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRolePoliciesPublisher publisher = client.listRolePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRolePoliciesPublisher publisher = client.listRolePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRolePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRolePoliciesResponse response) { //... }; });
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 viaListRolePoliciesRequest.builder()
- Parameters:
listRolePoliciesRequest
- AConsumer
that will call methods onListRolePoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoleTags
default CompletableFuture<ListRoleTagsResponse> listRoleTags(ListRoleTagsRequest listRoleTagsRequest) 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.
- Parameters:
listRoleTagsRequest
-- Returns:
- A Java Future containing the result of the ListRoleTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoleTags
default CompletableFuture<ListRoleTagsResponse> listRoleTags(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest) 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 viaListRoleTagsRequest.builder()
- Parameters:
listRoleTagsRequest
- AConsumer
that will call methods onListRoleTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRoleTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoleTagsPaginator
This is a variant of
listRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRoleTagsPublisher publisher = client.listRoleTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRoleTagsPublisher publisher = client.listRoleTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRoleTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRoleTagsResponse response) { //... }; });
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.- Parameters:
listRoleTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoleTagsPaginator
default ListRoleTagsPublisher listRoleTagsPaginator(Consumer<ListRoleTagsRequest.Builder> listRoleTagsRequest) This is a variant of
listRoleTags(software.amazon.awssdk.services.iam.model.ListRoleTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRoleTagsPublisher publisher = client.listRoleTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRoleTagsPublisher publisher = client.listRoleTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRoleTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRoleTagsResponse response) { //... }; });
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 viaListRoleTagsRequest.builder()
- Parameters:
listRoleTagsRequest
- AConsumer
that will call methods onListRoleTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoles
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
andMarker
parameters.- Parameters:
listRolesRequest
-- Returns:
- A Java Future containing the result of the ListRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listRoles
default CompletableFuture<ListRolesResponse> listRoles(Consumer<ListRolesRequest.Builder> listRolesRequest) 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
andMarker
parameters.
This is a convenience which creates an instance of the
ListRolesRequest.Builder
avoiding the need to create one manually viaListRolesRequest.builder()
- Parameters:
listRolesRequest
- AConsumer
that will call methods onListRolesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listRoles
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
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listRolesPaginator
This is a variant of
listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRolesPublisher publisher = client.listRolesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRolesPublisher publisher = client.listRolesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRolesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRolesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRolesPaginator
This is a variant of
listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRolesPublisher publisher = client.listRolesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRolesPublisher publisher = client.listRolesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRolesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRolesResponse response) { //... }; });
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.- Parameters:
listRolesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRolesPaginator
This is a variant of
listRoles(software.amazon.awssdk.services.iam.model.ListRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListRolesPublisher publisher = client.listRolesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListRolesPublisher publisher = client.listRolesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListRolesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListRolesResponse response) { //... }; });
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 viaListRolesRequest.builder()
- Parameters:
listRolesRequest
- AConsumer
that will call methods onListRolesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSAMLProviderTags
default CompletableFuture<ListSamlProviderTagsResponse> listSAMLProviderTags(ListSamlProviderTagsRequest listSamlProviderTagsRequest) 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.
- Parameters:
listSamlProviderTagsRequest
-- Returns:
- A Java Future containing the result of the ListSAMLProviderTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSAMLProviderTags
default CompletableFuture<ListSamlProviderTagsResponse> listSAMLProviderTags(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest) 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 viaListSamlProviderTagsRequest.builder()
- Parameters:
listSamlProviderTagsRequest
- AConsumer
that will call methods onListSamlProviderTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSAMLProviderTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSAMLProviderTagsPaginator
default ListSAMLProviderTagsPublisher listSAMLProviderTagsPaginator(ListSamlProviderTagsRequest listSamlProviderTagsRequest) This is a variant of
listSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsPublisher publisher = client.listSAMLProviderTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsPublisher publisher = client.listSAMLProviderTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSamlProviderTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsResponse response) { //... }; });
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.- Parameters:
listSamlProviderTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSAMLProviderTagsPaginator
default ListSAMLProviderTagsPublisher listSAMLProviderTagsPaginator(Consumer<ListSamlProviderTagsRequest.Builder> listSamlProviderTagsRequest) This is a variant of
listSAMLProviderTags(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsPublisher publisher = client.listSAMLProviderTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSAMLProviderTagsPublisher publisher = client.listSAMLProviderTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSamlProviderTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSamlProviderTagsResponse response) { //... }; });
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 viaListSamlProviderTagsRequest.builder()
- Parameters:
listSamlProviderTagsRequest
- AConsumer
that will call methods onListSamlProviderTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSAMLProviders
default CompletableFuture<ListSamlProvidersResponse> listSAMLProviders(ListSamlProvidersRequest listSamlProvidersRequest) 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.
- Parameters:
listSamlProvidersRequest
-- Returns:
- A Java Future containing the result of the ListSAMLProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSAMLProviders
default CompletableFuture<ListSamlProvidersResponse> listSAMLProviders(Consumer<ListSamlProvidersRequest.Builder> listSamlProvidersRequest) 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 viaListSamlProvidersRequest.builder()
- Parameters:
listSamlProvidersRequest
- AConsumer
that will call methods onListSamlProvidersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSAMLProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSAMLProviders
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.
- Returns:
- A Java Future containing the result of the ListSAMLProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSSHPublicKeys
default CompletableFuture<ListSshPublicKeysResponse> listSSHPublicKeys(ListSshPublicKeysRequest listSshPublicKeysRequest) 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
andMarker
parameters.- Parameters:
listSshPublicKeysRequest
-- Returns:
- A Java Future containing the result of the ListSSHPublicKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSSHPublicKeys
default CompletableFuture<ListSshPublicKeysResponse> listSSHPublicKeys(Consumer<ListSshPublicKeysRequest.Builder> listSshPublicKeysRequest) 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
andMarker
parameters.
This is a convenience which creates an instance of the
ListSshPublicKeysRequest.Builder
avoiding the need to create one manually viaListSshPublicKeysRequest.builder()
- Parameters:
listSshPublicKeysRequest
- AConsumer
that will call methods onListSshPublicKeysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSSHPublicKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSSHPublicKeys
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
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListSSHPublicKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSSHPublicKeysPaginator
This is a variant of
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysPublisher publisher = client.listSSHPublicKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysPublisher publisher = client.listSSHPublicKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSshPublicKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSshPublicKeysResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSSHPublicKeysPaginator
default ListSSHPublicKeysPublisher listSSHPublicKeysPaginator(ListSshPublicKeysRequest listSshPublicKeysRequest) This is a variant of
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysPublisher publisher = client.listSSHPublicKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysPublisher publisher = client.listSSHPublicKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSshPublicKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSshPublicKeysResponse response) { //... }; });
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.- Parameters:
listSshPublicKeysRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSSHPublicKeysPaginator
default ListSSHPublicKeysPublisher listSSHPublicKeysPaginator(Consumer<ListSshPublicKeysRequest.Builder> listSshPublicKeysRequest) This is a variant of
listSSHPublicKeys(software.amazon.awssdk.services.iam.model.ListSshPublicKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysPublisher publisher = client.listSSHPublicKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSSHPublicKeysPublisher publisher = client.listSSHPublicKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSshPublicKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSshPublicKeysResponse response) { //... }; });
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 viaListSshPublicKeysRequest.builder()
- Parameters:
listSshPublicKeysRequest
- AConsumer
that will call methods onListSshPublicKeysRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServerCertificateTags
default CompletableFuture<ListServerCertificateTagsResponse> listServerCertificateTags(ListServerCertificateTagsRequest listServerCertificateTagsRequest) 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.
- Parameters:
listServerCertificateTagsRequest
-- Returns:
- A Java Future containing the result of the ListServerCertificateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServerCertificateTags
default CompletableFuture<ListServerCertificateTagsResponse> listServerCertificateTags(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest) 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 viaListServerCertificateTagsRequest.builder()
- Parameters:
listServerCertificateTagsRequest
- AConsumer
that will call methods onListServerCertificateTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServerCertificateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServerCertificateTagsPaginator
default ListServerCertificateTagsPublisher listServerCertificateTagsPaginator(ListServerCertificateTagsRequest listServerCertificateTagsRequest) This is a variant of
listServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsPublisher publisher = client.listServerCertificateTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsPublisher publisher = client.listServerCertificateTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListServerCertificateTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsResponse response) { //... }; });
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.- Parameters:
listServerCertificateTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServerCertificateTagsPaginator
default ListServerCertificateTagsPublisher listServerCertificateTagsPaginator(Consumer<ListServerCertificateTagsRequest.Builder> listServerCertificateTagsRequest) This is a variant of
listServerCertificateTags(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsPublisher publisher = client.listServerCertificateTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListServerCertificateTagsPublisher publisher = client.listServerCertificateTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListServerCertificateTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListServerCertificateTagsResponse response) { //... }; });
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 viaListServerCertificateTagsRequest.builder()
- Parameters:
listServerCertificateTagsRequest
- AConsumer
that will call methods onListServerCertificateTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServerCertificates
default CompletableFuture<ListServerCertificatesResponse> listServerCertificates(ListServerCertificatesRequest listServerCertificatesRequest) 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
andMarker
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.
- Parameters:
listServerCertificatesRequest
-- Returns:
- A Java Future containing the result of the ListServerCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServerCertificates
default CompletableFuture<ListServerCertificatesResponse> listServerCertificates(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest) 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
andMarker
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 viaListServerCertificatesRequest.builder()
- Parameters:
listServerCertificatesRequest
- AConsumer
that will call methods onListServerCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServerCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServerCertificates
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
andMarker
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.
- Returns:
- A Java Future containing the result of the ListServerCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServerCertificatesPaginator
This is a variant of
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListServerCertificatesPublisher publisher = client.listServerCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesPublisher publisher = client.listServerCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServerCertificatesPaginator
default ListServerCertificatesPublisher listServerCertificatesPaginator(ListServerCertificatesRequest listServerCertificatesRequest) This is a variant of
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListServerCertificatesPublisher publisher = client.listServerCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesPublisher publisher = client.listServerCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse response) { //... }; });
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.- Parameters:
listServerCertificatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServerCertificatesPaginator
default ListServerCertificatesPublisher listServerCertificatesPaginator(Consumer<ListServerCertificatesRequest.Builder> listServerCertificatesRequest) This is a variant of
listServerCertificates(software.amazon.awssdk.services.iam.model.ListServerCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListServerCertificatesPublisher publisher = client.listServerCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListServerCertificatesPublisher publisher = client.listServerCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListServerCertificatesResponse response) { //... }; });
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 viaListServerCertificatesRequest.builder()
- Parameters:
listServerCertificatesRequest
- AConsumer
that will call methods onListServerCertificatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceSpecificCredentials
default CompletableFuture<ListServiceSpecificCredentialsResponse> listServiceSpecificCredentials(ListServiceSpecificCredentialsRequest listServiceSpecificCredentialsRequest) 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.
- Parameters:
listServiceSpecificCredentialsRequest
-- Returns:
- A Java Future containing the result of the ListServiceSpecificCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServiceSpecificCredentials
default CompletableFuture<ListServiceSpecificCredentialsResponse> listServiceSpecificCredentials(Consumer<ListServiceSpecificCredentialsRequest.Builder> listServiceSpecificCredentialsRequest) 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 viaListServiceSpecificCredentialsRequest.builder()
- Parameters:
listServiceSpecificCredentialsRequest
- AConsumer
that will call methods onListServiceSpecificCredentialsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServiceSpecificCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listServiceSpecificCredentials
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.
- Returns:
- A Java Future containing the result of the ListServiceSpecificCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSigningCertificates
default CompletableFuture<ListSigningCertificatesResponse> listSigningCertificates(ListSigningCertificatesRequest listSigningCertificatesRequest) 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
andMarker
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.- Parameters:
listSigningCertificatesRequest
-- Returns:
- A Java Future containing the result of the ListSigningCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSigningCertificates
default CompletableFuture<ListSigningCertificatesResponse> listSigningCertificates(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest) 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
andMarker
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 viaListSigningCertificatesRequest.builder()
- Parameters:
listSigningCertificatesRequest
- AConsumer
that will call methods onListSigningCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSigningCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSigningCertificates
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
andMarker
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.- Returns:
- A Java Future containing the result of the ListSigningCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSigningCertificatesPaginator
This is a variant of
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSigningCertificatesPublisher publisher = client.listSigningCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesPublisher publisher = client.listSigningCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSigningCertificatesPaginator
default ListSigningCertificatesPublisher listSigningCertificatesPaginator(ListSigningCertificatesRequest listSigningCertificatesRequest) This is a variant of
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSigningCertificatesPublisher publisher = client.listSigningCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesPublisher publisher = client.listSigningCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse response) { //... }; });
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.- Parameters:
listSigningCertificatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSigningCertificatesPaginator
default ListSigningCertificatesPublisher listSigningCertificatesPaginator(Consumer<ListSigningCertificatesRequest.Builder> listSigningCertificatesRequest) This is a variant of
listSigningCertificates(software.amazon.awssdk.services.iam.model.ListSigningCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListSigningCertificatesPublisher publisher = client.listSigningCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListSigningCertificatesPublisher publisher = client.listSigningCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListSigningCertificatesResponse response) { //... }; });
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 viaListSigningCertificatesRequest.builder()
- Parameters:
listSigningCertificatesRequest
- AConsumer
that will call methods onListSigningCertificatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserPolicies
default CompletableFuture<ListUserPoliciesResponse> listUserPolicies(ListUserPoliciesRequest listUserPoliciesRequest) Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.- Parameters:
listUserPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListUserPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserPolicies
default CompletableFuture<ListUserPoliciesResponse> listUserPolicies(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest) Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the
MaxItems
andMarker
parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.
This is a convenience which creates an instance of the
ListUserPoliciesRequest.Builder
avoiding the need to create one manually viaListUserPoliciesRequest.builder()
- Parameters:
listUserPoliciesRequest
- AConsumer
that will call methods onListUserPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUserPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserPoliciesPaginator
default ListUserPoliciesPublisher listUserPoliciesPaginator(ListUserPoliciesRequest listUserPoliciesRequest) This is a variant of
listUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUserPoliciesPublisher publisher = client.listUserPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUserPoliciesPublisher publisher = client.listUserPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUserPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUserPoliciesResponse response) { //... }; });
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.- Parameters:
listUserPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserPoliciesPaginator
default ListUserPoliciesPublisher listUserPoliciesPaginator(Consumer<ListUserPoliciesRequest.Builder> listUserPoliciesRequest) This is a variant of
listUserPolicies(software.amazon.awssdk.services.iam.model.ListUserPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUserPoliciesPublisher publisher = client.listUserPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUserPoliciesPublisher publisher = client.listUserPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUserPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUserPoliciesResponse response) { //... }; });
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 viaListUserPoliciesRequest.builder()
- Parameters:
listUserPoliciesRequest
- AConsumer
that will call methods onListUserPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserTags
default CompletableFuture<ListUserTagsResponse> listUserTags(ListUserTagsRequest listUserTagsRequest) 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.
- Parameters:
listUserTagsRequest
-- Returns:
- A Java Future containing the result of the ListUserTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserTags
default CompletableFuture<ListUserTagsResponse> listUserTags(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest) 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 viaListUserTagsRequest.builder()
- Parameters:
listUserTagsRequest
- AConsumer
that will call methods onListUserTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUserTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserTagsPaginator
This is a variant of
listUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUserTagsPublisher publisher = client.listUserTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUserTagsPublisher publisher = client.listUserTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUserTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUserTagsResponse response) { //... }; });
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.- Parameters:
listUserTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUserTagsPaginator
default ListUserTagsPublisher listUserTagsPaginator(Consumer<ListUserTagsRequest.Builder> listUserTagsRequest) This is a variant of
listUserTags(software.amazon.awssdk.services.iam.model.ListUserTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUserTagsPublisher publisher = client.listUserTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUserTagsPublisher publisher = client.listUserTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUserTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUserTagsResponse response) { //... }; });
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 viaListUserTagsRequest.builder()
- Parameters:
listUserTagsRequest
- AConsumer
that will call methods onListUserTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUsers
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
andMarker
parameters.- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) 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
andMarker
parameters.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listUsers
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
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUsersResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUsersResponse response) { //... }; });
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.- Parameters:
listUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.iam.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListUsersResponse response) { //... }; });
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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualMFADevices
default CompletableFuture<ListVirtualMfaDevicesResponse> listVirtualMFADevices(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest) 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
, orAny
.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
andMarker
parameters.- Parameters:
listVirtualMfaDevicesRequest
-- Returns:
- A Java Future containing the result of the ListVirtualMFADevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualMFADevices
default CompletableFuture<ListVirtualMfaDevicesResponse> listVirtualMFADevices(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest) 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
, orAny
.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
andMarker
parameters.
This is a convenience which creates an instance of the
ListVirtualMfaDevicesRequest.Builder
avoiding the need to create one manually viaListVirtualMfaDevicesRequest.builder()
- Parameters:
listVirtualMfaDevicesRequest
- AConsumer
that will call methods onListVirtualMfaDevicesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVirtualMFADevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualMFADevices
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
, orAny
.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
andMarker
parameters.- Returns:
- A Java Future containing the result of the ListVirtualMFADevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualMFADevicesPaginator
This is a variant of
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesPublisher publisher = client.listVirtualMFADevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesPublisher publisher = client.listVirtualMFADevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualMFADevicesPaginator
default ListVirtualMFADevicesPublisher listVirtualMFADevicesPaginator(ListVirtualMfaDevicesRequest listVirtualMfaDevicesRequest) This is a variant of
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesPublisher publisher = client.listVirtualMFADevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesPublisher publisher = client.listVirtualMFADevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesResponse response) { //... }; });
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.- Parameters:
listVirtualMfaDevicesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualMFADevicesPaginator
default ListVirtualMFADevicesPublisher listVirtualMFADevicesPaginator(Consumer<ListVirtualMfaDevicesRequest.Builder> listVirtualMfaDevicesRequest) This is a variant of
listVirtualMFADevices(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesPublisher publisher = client.listVirtualMFADevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.ListVirtualMFADevicesPublisher publisher = client.listVirtualMFADevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.ListVirtualMfaDevicesResponse response) { //... }; });
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 viaListVirtualMfaDevicesRequest.builder()
- Parameters:
listVirtualMfaDevicesRequest
- AConsumer
that will call methods onListVirtualMfaDevicesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putGroupPolicy
default CompletableFuture<PutGroupPolicyResponse> putGroupPolicy(PutGroupPolicyRequest putGroupPolicyRequest) 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, useCreatePolicy
. 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.- Parameters:
putGroupPolicyRequest
-- Returns:
- A Java Future containing the result of the PutGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putGroupPolicy
default CompletableFuture<PutGroupPolicyResponse> putGroupPolicy(Consumer<PutGroupPolicyRequest.Builder> putGroupPolicyRequest) 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, useCreatePolicy
. 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 viaPutGroupPolicyRequest.builder()
- Parameters:
putGroupPolicyRequest
- AConsumer
that will call methods onPutGroupPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutGroupPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putRolePermissionsBoundary
default CompletableFuture<PutRolePermissionsBoundaryResponse> putRolePermissionsBoundary(PutRolePermissionsBoundaryRequest putRolePermissionsBoundaryRequest) 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.
- Parameters:
putRolePermissionsBoundaryRequest
-- Returns:
- A Java Future containing the result of the PutRolePermissionsBoundary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putRolePermissionsBoundary
default CompletableFuture<PutRolePermissionsBoundaryResponse> putRolePermissionsBoundary(Consumer<PutRolePermissionsBoundaryRequest.Builder> putRolePermissionsBoundaryRequest) 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 viaPutRolePermissionsBoundaryRequest.builder()
- Parameters:
putRolePermissionsBoundaryRequest
- AConsumer
that will call methods onPutRolePermissionsBoundaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRolePermissionsBoundary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putRolePolicy
default CompletableFuture<PutRolePolicyResponse> putRolePolicy(PutRolePolicyRequest putRolePolicyRequest) 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 usingUpdateAssumeRolePolicy
. 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, useCreatePolicy
. 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.- Parameters:
putRolePolicyRequest
-- Returns:
- A Java Future containing the result of the PutRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putRolePolicy
default CompletableFuture<PutRolePolicyResponse> putRolePolicy(Consumer<PutRolePolicyRequest.Builder> putRolePolicyRequest) 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 usingUpdateAssumeRolePolicy
. 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, useCreatePolicy
. 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 viaPutRolePolicyRequest.builder()
- Parameters:
putRolePolicyRequest
- AConsumer
that will call methods onPutRolePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putUserPermissionsBoundary
default CompletableFuture<PutUserPermissionsBoundaryResponse> putUserPermissionsBoundary(PutUserPermissionsBoundaryRequest putUserPermissionsBoundaryRequest) 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.
- Parameters:
putUserPermissionsBoundaryRequest
-- Returns:
- A Java Future containing the result of the PutUserPermissionsBoundary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putUserPermissionsBoundary
default CompletableFuture<PutUserPermissionsBoundaryResponse> putUserPermissionsBoundary(Consumer<PutUserPermissionsBoundaryRequest.Builder> putUserPermissionsBoundaryRequest) 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 viaPutUserPermissionsBoundaryRequest.builder()
- Parameters:
putUserPermissionsBoundaryRequest
- AConsumer
that will call methods onPutUserPermissionsBoundaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutUserPermissionsBoundary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putUserPolicy
default CompletableFuture<PutUserPolicyResponse> putUserPolicy(PutUserPolicyRequest putUserPolicyRequest) 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, useCreatePolicy
. 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.- Parameters:
putUserPolicyRequest
-- Returns:
- A Java Future containing the result of the PutUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putUserPolicy
default CompletableFuture<PutUserPolicyResponse> putUserPolicy(Consumer<PutUserPolicyRequest.Builder> putUserPolicyRequest) 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, useCreatePolicy
. 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 viaPutUserPolicyRequest.builder()
- Parameters:
putUserPolicyRequest
- AConsumer
that will call methods onPutUserPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutUserPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeClientIDFromOpenIDConnectProvider
default CompletableFuture<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.
This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
- Parameters:
removeClientIdFromOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the RemoveClientIDFromOpenIDConnectProvider operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeClientIDFromOpenIDConnectProvider
default CompletableFuture<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.
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 viaRemoveClientIdFromOpenIdConnectProviderRequest.builder()
- Parameters:
removeClientIdFromOpenIdConnectProviderRequest
- AConsumer
that will call methods onRemoveClientIdFromOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveClientIDFromOpenIDConnectProvider operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeRoleFromInstanceProfile
default CompletableFuture<RemoveRoleFromInstanceProfileResponse> removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest removeRoleFromInstanceProfileRequest) Removes the specified IAM role from the specified Amazon 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.
- Parameters:
removeRoleFromInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the RemoveRoleFromInstanceProfile operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeRoleFromInstanceProfile
default CompletableFuture<RemoveRoleFromInstanceProfileResponse> removeRoleFromInstanceProfile(Consumer<RemoveRoleFromInstanceProfileRequest.Builder> removeRoleFromInstanceProfileRequest) Removes the specified IAM role from the specified Amazon 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 viaRemoveRoleFromInstanceProfileRequest.builder()
- Parameters:
removeRoleFromInstanceProfileRequest
- AConsumer
that will call methods onRemoveRoleFromInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveRoleFromInstanceProfile operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeUserFromGroup
default CompletableFuture<RemoveUserFromGroupResponse> removeUserFromGroup(RemoveUserFromGroupRequest removeUserFromGroupRequest) Removes the specified user from the specified group.
- Parameters:
removeUserFromGroupRequest
-- Returns:
- A Java Future containing the result of the RemoveUserFromGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeUserFromGroup
default CompletableFuture<RemoveUserFromGroupResponse> removeUserFromGroup(Consumer<RemoveUserFromGroupRequest.Builder> removeUserFromGroupRequest) 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 viaRemoveUserFromGroupRequest.builder()
- Parameters:
removeUserFromGroupRequest
- AConsumer
that will call methods onRemoveUserFromGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveUserFromGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetServiceSpecificCredential
default CompletableFuture<ResetServiceSpecificCredentialResponse> resetServiceSpecificCredential(ResetServiceSpecificCredentialRequest resetServiceSpecificCredentialRequest) 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.
- Parameters:
resetServiceSpecificCredentialRequest
-- Returns:
- A Java Future containing the result of the ResetServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetServiceSpecificCredential
default CompletableFuture<ResetServiceSpecificCredentialResponse> resetServiceSpecificCredential(Consumer<ResetServiceSpecificCredentialRequest.Builder> resetServiceSpecificCredentialRequest) 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 viaResetServiceSpecificCredentialRequest.builder()
- Parameters:
resetServiceSpecificCredentialRequest
- AConsumer
that will call methods onResetServiceSpecificCredentialRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resyncMFADevice
default CompletableFuture<ResyncMfaDeviceResponse> resyncMFADevice(ResyncMfaDeviceRequest resyncMfaDeviceRequest) 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.
- Parameters:
resyncMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the ResyncMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resyncMFADevice
default CompletableFuture<ResyncMfaDeviceResponse> resyncMFADevice(Consumer<ResyncMfaDeviceRequest.Builder> resyncMfaDeviceRequest) 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 viaResyncMfaDeviceRequest.builder()
- Parameters:
resyncMfaDeviceRequest
- AConsumer
that will call methods onResyncMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResyncMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
setDefaultPolicyVersion
default CompletableFuture<SetDefaultPolicyVersionResponse> setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) 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.
- Parameters:
setDefaultPolicyVersionRequest
-- Returns:
- A Java Future containing the result of the SetDefaultPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
setDefaultPolicyVersion
default CompletableFuture<SetDefaultPolicyVersionResponse> setDefaultPolicyVersion(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest) 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 viaSetDefaultPolicyVersionRequest.builder()
- Parameters:
setDefaultPolicyVersionRequest
- AConsumer
that will call methods onSetDefaultPolicyVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetDefaultPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
setSecurityTokenServicePreferences
default CompletableFuture<SetSecurityTokenServicePreferencesResponse> setSecurityTokenServicePreferences(SetSecurityTokenServicePreferencesRequest setSecurityTokenServicePreferencesRequest) 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.- Parameters:
setSecurityTokenServicePreferencesRequest
-- Returns:
- A Java Future containing the result of the SetSecurityTokenServicePreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setSecurityTokenServicePreferences
default CompletableFuture<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.
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 viaSetSecurityTokenServicePreferencesRequest.builder()
- Parameters:
setSecurityTokenServicePreferencesRequest
- AConsumer
that will call methods onSetSecurityTokenServicePreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetSecurityTokenServicePreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
simulateCustomPolicy
default CompletableFuture<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. 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
andMarker
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.
- Parameters:
simulateCustomPolicyRequest
-- Returns:
- A Java Future containing the result of the SimulateCustomPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulateCustomPolicy
default CompletableFuture<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. 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
andMarker
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 viaSimulateCustomPolicyRequest.builder()
- Parameters:
simulateCustomPolicyRequest
- AConsumer
that will call methods onSimulateCustomPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SimulateCustomPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulateCustomPolicyPaginator
default SimulateCustomPolicyPublisher simulateCustomPolicyPaginator(SimulateCustomPolicyRequest simulateCustomPolicyRequest) This is a variant of
simulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyPublisher publisher = client.simulateCustomPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyPublisher publisher = client.simulateCustomPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.SimulateCustomPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyResponse response) { //... }; });
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.- Parameters:
simulateCustomPolicyRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulateCustomPolicyPaginator
default SimulateCustomPolicyPublisher simulateCustomPolicyPaginator(Consumer<SimulateCustomPolicyRequest.Builder> simulateCustomPolicyRequest) This is a variant of
simulateCustomPolicy(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyPublisher publisher = client.simulateCustomPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.SimulateCustomPolicyPublisher publisher = client.simulateCustomPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.SimulateCustomPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.SimulateCustomPolicyResponse response) { //... }; });
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 viaSimulateCustomPolicyRequest.builder()
- Parameters:
simulateCustomPolicyRequest
- AConsumer
that will call methods onSimulateCustomPolicyRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulatePrincipalPolicy
default CompletableFuture<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. 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
andMarker
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.
- Parameters:
simulatePrincipalPolicyRequest
-- Returns:
- A Java Future containing the result of the SimulatePrincipalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulatePrincipalPolicy
default CompletableFuture<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. 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
andMarker
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 viaSimulatePrincipalPolicyRequest.builder()
- Parameters:
simulatePrincipalPolicyRequest
- AConsumer
that will call methods onSimulatePrincipalPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SimulatePrincipalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulatePrincipalPolicyPaginator
default SimulatePrincipalPolicyPublisher simulatePrincipalPolicyPaginator(SimulatePrincipalPolicyRequest simulatePrincipalPolicyRequest) This is a variant of
simulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyPublisher publisher = client.simulatePrincipalPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyPublisher publisher = client.simulatePrincipalPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyResponse response) { //... }; });
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.- Parameters:
simulatePrincipalPolicyRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
simulatePrincipalPolicyPaginator
default SimulatePrincipalPolicyPublisher simulatePrincipalPolicyPaginator(Consumer<SimulatePrincipalPolicyRequest.Builder> simulatePrincipalPolicyRequest) This is a variant of
simulatePrincipalPolicy(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyPublisher publisher = client.simulatePrincipalPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iam.paginators.SimulatePrincipalPolicyPublisher publisher = client.simulatePrincipalPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iam.model.SimulatePrincipalPolicyResponse response) { //... }; });
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 viaSimulatePrincipalPolicyRequest.builder()
- Parameters:
simulatePrincipalPolicyRequest
- AConsumer
that will call methods onSimulatePrincipalPolicyRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagInstanceProfile
default CompletableFuture<TagInstanceProfileResponse> tagInstanceProfile(TagInstanceProfileRequest tagInstanceProfileRequest) 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.
- Parameters:
tagInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the TagInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagInstanceProfile
default CompletableFuture<TagInstanceProfileResponse> tagInstanceProfile(Consumer<TagInstanceProfileRequest.Builder> tagInstanceProfileRequest) 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 viaTagInstanceProfileRequest.builder()
- Parameters:
tagInstanceProfileRequest
- AConsumer
that will call methods onTagInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagMFADevice
default CompletableFuture<TagMfaDeviceResponse> tagMFADevice(TagMfaDeviceRequest tagMfaDeviceRequest) 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.
- Parameters:
tagMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the TagMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagMFADevice
default CompletableFuture<TagMfaDeviceResponse> tagMFADevice(Consumer<TagMfaDeviceRequest.Builder> tagMfaDeviceRequest) 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 viaTagMfaDeviceRequest.builder()
- Parameters:
tagMfaDeviceRequest
- AConsumer
that will call methods onTagMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagOpenIDConnectProvider
default CompletableFuture<TagOpenIdConnectProviderResponse> tagOpenIDConnectProvider(TagOpenIdConnectProviderRequest tagOpenIdConnectProviderRequest) 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.
- Parameters:
tagOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the TagOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagOpenIDConnectProvider
default CompletableFuture<TagOpenIdConnectProviderResponse> tagOpenIDConnectProvider(Consumer<TagOpenIdConnectProviderRequest.Builder> tagOpenIdConnectProviderRequest) 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 viaTagOpenIdConnectProviderRequest.builder()
- Parameters:
tagOpenIdConnectProviderRequest
- AConsumer
that will call methods onTagOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagPolicy
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.
- Parameters:
tagPolicyRequest
-- Returns:
- A Java Future containing the result of the TagPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagPolicy
default CompletableFuture<TagPolicyResponse> tagPolicy(Consumer<TagPolicyRequest.Builder> tagPolicyRequest) 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 viaTagPolicyRequest.builder()
- Parameters:
tagPolicyRequest
- AConsumer
that will call methods onTagPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagRole
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.
- Parameters:
tagRoleRequest
-- Returns:
- A Java Future containing the result of the TagRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagRole
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 viaTagRoleRequest.builder()
- Parameters:
tagRoleRequest
- AConsumer
that will call methods onTagRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagSAMLProvider
default CompletableFuture<TagSamlProviderResponse> tagSAMLProvider(TagSamlProviderRequest tagSamlProviderRequest) 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.
- Parameters:
tagSamlProviderRequest
-- Returns:
- A Java Future containing the result of the TagSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagSAMLProvider
default CompletableFuture<TagSamlProviderResponse> tagSAMLProvider(Consumer<TagSamlProviderRequest.Builder> tagSamlProviderRequest) 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 viaTagSamlProviderRequest.builder()
- Parameters:
tagSamlProviderRequest
- AConsumer
that will call methods onTagSamlProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagServerCertificate
default CompletableFuture<TagServerCertificateResponse> tagServerCertificate(TagServerCertificateRequest tagServerCertificateRequest) 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.
- Parameters:
tagServerCertificateRequest
-- Returns:
- A Java Future containing the result of the TagServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagServerCertificate
default CompletableFuture<TagServerCertificateResponse> tagServerCertificate(Consumer<TagServerCertificateRequest.Builder> tagServerCertificateRequest) 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 viaTagServerCertificateRequest.builder()
- Parameters:
tagServerCertificateRequest
- AConsumer
that will call methods onTagServerCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagUser
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.
- Parameters:
tagUserRequest
-- Returns:
- A Java Future containing the result of the TagUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
tagUser
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 viaTagUserRequest.builder()
- Parameters:
tagUserRequest
- AConsumer
that will call methods onTagUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
untagInstanceProfile
default CompletableFuture<UntagInstanceProfileResponse> untagInstanceProfile(UntagInstanceProfileRequest untagInstanceProfileRequest) Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
- Parameters:
untagInstanceProfileRequest
-- Returns:
- A Java Future containing the result of the UntagInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagInstanceProfile
default CompletableFuture<UntagInstanceProfileResponse> untagInstanceProfile(Consumer<UntagInstanceProfileRequest.Builder> untagInstanceProfileRequest) 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 viaUntagInstanceProfileRequest.builder()
- Parameters:
untagInstanceProfileRequest
- AConsumer
that will call methods onUntagInstanceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagInstanceProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagMFADevice
default CompletableFuture<UntagMfaDeviceResponse> untagMFADevice(UntagMfaDeviceRequest untagMfaDeviceRequest) 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.
- Parameters:
untagMfaDeviceRequest
-- Returns:
- A Java Future containing the result of the UntagMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagMFADevice
default CompletableFuture<UntagMfaDeviceResponse> untagMFADevice(Consumer<UntagMfaDeviceRequest.Builder> untagMfaDeviceRequest) 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 viaUntagMfaDeviceRequest.builder()
- Parameters:
untagMfaDeviceRequest
- AConsumer
that will call methods onUntagMfaDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagMFADevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagOpenIDConnectProvider
default CompletableFuture<UntagOpenIdConnectProviderResponse> untagOpenIDConnectProvider(UntagOpenIdConnectProviderRequest untagOpenIdConnectProviderRequest) 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.
- Parameters:
untagOpenIdConnectProviderRequest
-- Returns:
- A Java Future containing the result of the UntagOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagOpenIDConnectProvider
default CompletableFuture<UntagOpenIdConnectProviderResponse> untagOpenIDConnectProvider(Consumer<UntagOpenIdConnectProviderRequest.Builder> untagOpenIdConnectProviderRequest) 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 viaUntagOpenIdConnectProviderRequest.builder()
- Parameters:
untagOpenIdConnectProviderRequest
- AConsumer
that will call methods onUntagOpenIdConnectProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagOpenIDConnectProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagPolicy
Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
- Parameters:
untagPolicyRequest
-- Returns:
- A Java Future containing the result of the UntagPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagPolicy
default CompletableFuture<UntagPolicyResponse> untagPolicy(Consumer<UntagPolicyRequest.Builder> untagPolicyRequest) 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 viaUntagPolicyRequest.builder()
- Parameters:
untagPolicyRequest
- AConsumer
that will call methods onUntagPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagRole
Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
- Parameters:
untagRoleRequest
-- Returns:
- A Java Future containing the result of the UntagRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagRole
default CompletableFuture<UntagRoleResponse> untagRole(Consumer<UntagRoleRequest.Builder> untagRoleRequest) 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 viaUntagRoleRequest.builder()
- Parameters:
untagRoleRequest
- AConsumer
that will call methods onUntagRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagSAMLProvider
default CompletableFuture<UntagSamlProviderResponse> untagSAMLProvider(UntagSamlProviderRequest untagSamlProviderRequest) 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.
- Parameters:
untagSamlProviderRequest
-- Returns:
- A Java Future containing the result of the UntagSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagSAMLProvider
default CompletableFuture<UntagSamlProviderResponse> untagSAMLProvider(Consumer<UntagSamlProviderRequest.Builder> untagSamlProviderRequest) 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 viaUntagSamlProviderRequest.builder()
- Parameters:
untagSamlProviderRequest
- AConsumer
that will call methods onUntagSamlProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagServerCertificate
default CompletableFuture<UntagServerCertificateResponse> untagServerCertificate(UntagServerCertificateRequest untagServerCertificateRequest) 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.
- Parameters:
untagServerCertificateRequest
-- Returns:
- A Java Future containing the result of the UntagServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagServerCertificate
default CompletableFuture<UntagServerCertificateResponse> untagServerCertificate(Consumer<UntagServerCertificateRequest.Builder> untagServerCertificateRequest) 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 viaUntagServerCertificateRequest.builder()
- Parameters:
untagServerCertificateRequest
- AConsumer
that will call methods onUntagServerCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagUser
Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
- Parameters:
untagUserRequest
-- Returns:
- A Java Future containing the result of the UntagUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagUser
default CompletableFuture<UntagUserResponse> untagUser(Consumer<UntagUserRequest.Builder> untagUserRequest) 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 viaUntagUserRequest.builder()
- Parameters:
untagUserRequest
- AConsumer
that will call methods onUntagUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccessKey
default CompletableFuture<UpdateAccessKeyResponse> updateAccessKey(UpdateAccessKeyRequest updateAccessKeyRequest) 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, thenUserName
is required. If a long-term key is assigned to the user, thenUserName
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.
- Parameters:
updateAccessKeyRequest
-- Returns:
- A Java Future containing the result of the UpdateAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccessKey
default CompletableFuture<UpdateAccessKeyResponse> updateAccessKey(Consumer<UpdateAccessKeyRequest.Builder> updateAccessKeyRequest) 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, thenUserName
is required. If a long-term key is assigned to the user, thenUserName
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 viaUpdateAccessKeyRequest.builder()
- Parameters:
updateAccessKeyRequest
- AConsumer
that will call methods onUpdateAccessKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccessKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccountPasswordPolicy
default CompletableFuture<UpdateAccountPasswordPolicyResponse> updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest updateAccountPasswordPolicyRequest) 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.
- Parameters:
updateAccountPasswordPolicyRequest
-- Returns:
- A Java Future containing the result of the UpdateAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccountPasswordPolicy
default CompletableFuture<UpdateAccountPasswordPolicyResponse> updateAccountPasswordPolicy(Consumer<UpdateAccountPasswordPolicyRequest.Builder> updateAccountPasswordPolicyRequest) 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 viaUpdateAccountPasswordPolicyRequest.builder()
- Parameters:
updateAccountPasswordPolicyRequest
- AConsumer
that will call methods onUpdateAccountPasswordPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccountPasswordPolicy
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.
- Returns:
- A Java Future containing the result of the UpdateAccountPasswordPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAssumeRolePolicy
default CompletableFuture<UpdateAssumeRolePolicyResponse> updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest updateAssumeRolePolicyRequest) 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.
- Parameters:
updateAssumeRolePolicyRequest
-- Returns:
- A Java Future containing the result of the UpdateAssumeRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAssumeRolePolicy
default CompletableFuture<UpdateAssumeRolePolicyResponse> updateAssumeRolePolicy(Consumer<UpdateAssumeRolePolicyRequest.Builder> updateAssumeRolePolicyRequest) 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 viaUpdateAssumeRolePolicyRequest.builder()
- Parameters:
updateAssumeRolePolicyRequest
- AConsumer
that will call methods onUpdateAssumeRolePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAssumeRolePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateGroup
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
toMGRs
, the principal must have a policy that allows them to update both groups. If the principal has permission to update theManagers
group, but not theMGRs
group, then the update fails. For more information about permissions, see Access management.- Parameters:
updateGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateGroup
default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) 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
toMGRs
, the principal must have a policy that allows them to update both groups. If the principal has permission to update theManagers
group, but not theMGRs
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 viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateLoginProfile
default CompletableFuture<UpdateLoginProfileResponse> updateLoginProfile(UpdateLoginProfileRequest updateLoginProfileRequest) 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.
- Parameters:
updateLoginProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateLoginProfile
default CompletableFuture<UpdateLoginProfileResponse> updateLoginProfile(Consumer<UpdateLoginProfileRequest.Builder> updateLoginProfileRequest) 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 viaUpdateLoginProfileRequest.builder()
- Parameters:
updateLoginProfileRequest
- AConsumer
that will call methods onUpdateLoginProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateLoginProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateOpenIDConnectProviderThumbprint
default CompletableFuture<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.
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 OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.
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.- Parameters:
updateOpenIdConnectProviderThumbprintRequest
-- Returns:
- A Java Future containing the result of the UpdateOpenIDConnectProviderThumbprint operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateOpenIDConnectProviderThumbprint
default CompletableFuture<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.
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 OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.
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 viaUpdateOpenIdConnectProviderThumbprintRequest.builder()
- Parameters:
updateOpenIdConnectProviderThumbprintRequest
- AConsumer
that will call methods onUpdateOpenIdConnectProviderThumbprintRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateOpenIDConnectProviderThumbprint operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRole
Updates the description or maximum session duration setting of a role.
- Parameters:
updateRoleRequest
-- Returns:
- A Java Future containing the result of the UpdateRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRole
default CompletableFuture<UpdateRoleResponse> updateRole(Consumer<UpdateRoleRequest.Builder> updateRoleRequest) 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 viaUpdateRoleRequest.builder()
- Parameters:
updateRoleRequest
- AConsumer
that will call methods onUpdateRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRoleDescription
default CompletableFuture<UpdateRoleDescriptionResponse> updateRoleDescription(UpdateRoleDescriptionRequest updateRoleDescriptionRequest) Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the
Description
parameter in theUpdateRole
operation.- Parameters:
updateRoleDescriptionRequest
-- Returns:
- A Java Future containing the result of the UpdateRoleDescription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRoleDescription
default CompletableFuture<UpdateRoleDescriptionResponse> updateRoleDescription(Consumer<UpdateRoleDescriptionRequest.Builder> updateRoleDescriptionRequest) Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the
Description
parameter in theUpdateRole
operation.
This is a convenience which creates an instance of the
UpdateRoleDescriptionRequest.Builder
avoiding the need to create one manually viaUpdateRoleDescriptionRequest.builder()
- Parameters:
updateRoleDescriptionRequest
- AConsumer
that will call methods onUpdateRoleDescriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRoleDescription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSAMLProvider
default CompletableFuture<UpdateSamlProviderResponse> updateSAMLProvider(UpdateSamlProviderRequest updateSamlProviderRequest) Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
- Parameters:
updateSamlProviderRequest
-- Returns:
- A Java Future containing the result of the UpdateSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSAMLProvider
default CompletableFuture<UpdateSamlProviderResponse> updateSAMLProvider(Consumer<UpdateSamlProviderRequest.Builder> updateSamlProviderRequest) 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 viaUpdateSamlProviderRequest.builder()
- Parameters:
updateSamlProviderRequest
- AConsumer
that will call methods onUpdateSamlProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSAMLProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSSHPublicKey
default CompletableFuture<UpdateSshPublicKeyResponse> updateSSHPublicKey(UpdateSshPublicKeyRequest updateSshPublicKeyRequest) 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.
- Parameters:
updateSshPublicKeyRequest
-- Returns:
- A Java Future containing the result of the UpdateSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSSHPublicKey
default CompletableFuture<UpdateSshPublicKeyResponse> updateSSHPublicKey(Consumer<UpdateSshPublicKeyRequest.Builder> updateSshPublicKeyRequest) 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 viaUpdateSshPublicKeyRequest.builder()
- Parameters:
updateSshPublicKeyRequest
- AConsumer
that will call methods onUpdateSshPublicKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateServerCertificate
default CompletableFuture<UpdateServerCertificateResponse> updateServerCertificate(UpdateServerCertificateRequest updateServerCertificateRequest) 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
toProdCert
, the principal must have a policy that allows them to update both certificates. If the principal has permission to update theProductionCert
group, but not theProdCert
certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.- Parameters:
updateServerCertificateRequest
-- Returns:
- A Java Future containing the result of the UpdateServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateServerCertificate
default CompletableFuture<UpdateServerCertificateResponse> updateServerCertificate(Consumer<UpdateServerCertificateRequest.Builder> updateServerCertificateRequest) 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
toProdCert
, the principal must have a policy that allows them to update both certificates. If the principal has permission to update theProductionCert
group, but not theProdCert
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 viaUpdateServerCertificateRequest.builder()
- Parameters:
updateServerCertificateRequest
- AConsumer
that will call methods onUpdateServerCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateServiceSpecificCredential
default CompletableFuture<UpdateServiceSpecificCredentialResponse> updateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest updateServiceSpecificCredentialRequest) Sets the status of a service-specific credential to
Active
orInactive
. 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.- Parameters:
updateServiceSpecificCredentialRequest
-- Returns:
- A Java Future containing the result of the UpdateServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateServiceSpecificCredential
default CompletableFuture<UpdateServiceSpecificCredentialResponse> updateServiceSpecificCredential(Consumer<UpdateServiceSpecificCredentialRequest.Builder> updateServiceSpecificCredentialRequest) Sets the status of a service-specific credential to
Active
orInactive
. 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 viaUpdateServiceSpecificCredentialRequest.builder()
- Parameters:
updateServiceSpecificCredentialRequest
- AConsumer
that will call methods onUpdateServiceSpecificCredentialRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateServiceSpecificCredential operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSigningCertificate
default CompletableFuture<UpdateSigningCertificateResponse> updateSigningCertificate(UpdateSigningCertificateRequest updateSigningCertificateRequest) 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.- Parameters:
updateSigningCertificateRequest
-- Returns:
- A Java Future containing the result of the UpdateSigningCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSigningCertificate
default CompletableFuture<UpdateSigningCertificateResponse> updateSigningCertificate(Consumer<UpdateSigningCertificateRequest.Builder> updateSigningCertificateRequest) 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 viaUpdateSigningCertificateRequest.builder()
- Parameters:
updateSigningCertificateRequest
- AConsumer
that will call methods onUpdateSigningCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSigningCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUser
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.
- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) 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 viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
uploadSSHPublicKey
default CompletableFuture<UploadSshPublicKeyResponse> uploadSSHPublicKey(UploadSshPublicKeyRequest uploadSshPublicKeyRequest) 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.
- Parameters:
uploadSshPublicKeyRequest
-- Returns:
- A Java Future containing the result of the UploadSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
uploadSSHPublicKey
default CompletableFuture<UploadSshPublicKeyResponse> uploadSSHPublicKey(Consumer<UploadSshPublicKeyRequest.Builder> uploadSshPublicKeyRequest) 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 viaUploadSshPublicKeyRequest.builder()
- Parameters:
uploadSshPublicKeyRequest
- AConsumer
that will call methods onUploadSshPublicKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UploadSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
uploadServerCertificate
default CompletableFuture<UploadServerCertificateResponse> uploadServerCertificate(UploadServerCertificateRequest uploadServerCertificateRequest) 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.- Parameters:
uploadServerCertificateRequest
-- Returns:
- A Java Future containing the result of the UploadServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
uploadServerCertificate
default CompletableFuture<UploadServerCertificateResponse> uploadServerCertificate(Consumer<UploadServerCertificateRequest.Builder> uploadServerCertificateRequest) 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 viaUploadServerCertificateRequest.builder()
- Parameters:
uploadServerCertificateRequest
- AConsumer
that will call methods onUploadServerCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UploadServerCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
uploadSigningCertificate
default CompletableFuture<UploadSigningCertificateResponse> uploadSigningCertificate(UploadSigningCertificateRequest uploadSigningCertificateRequest) 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.- Parameters:
uploadSigningCertificateRequest
-- Returns:
- A Java Future containing the result of the UploadSigningCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
uploadSigningCertificate
default CompletableFuture<UploadSigningCertificateResponse> uploadSigningCertificate(Consumer<UploadSigningCertificateRequest.Builder> uploadSigningCertificateRequest) 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 viaUploadSigningCertificateRequest.builder()
- Parameters:
uploadSigningCertificateRequest
- AConsumer
that will call methods onUploadSigningCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UploadSigningCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
waiter
Create an instance ofIamAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
IamAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
builder
Create a builder that can be used to configure and create aIamAsyncClient
.
-