Interface RolesAnywhereAsyncClient
- 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 Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of Amazon Web Services to obtain temporary Amazon Web Services credentials. Your workloads can use the same IAM policies and roles you have for native Amazon Web Services applications to access Amazon Web Services resources. Using IAM Roles Anywhere eliminates the need to manage long-term credentials for workloads running outside of Amazon Web Services.
To use IAM Roles Anywhere, your workloads must use X.509 certificates issued by their certificate authority (CA). You register the CA with IAM Roles Anywhere as a trust anchor to establish trust between your public key infrastructure (PKI) and IAM Roles Anywhere. If you don't manage your own PKI system, you can use Private Certificate Authority to create a CA and then use that to establish trust with IAM Roles Anywhere.
This guide describes the IAM Roles Anywhere operations that you can call programmatically. For more information about IAM Roles Anywhere, see the IAM Roles Anywhere 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 TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aRolesAnywhereAsyncClient
.static RolesAnywhereAsyncClient
create()
Create aRolesAnywhereAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateProfileResponse> createProfile
(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.default CompletableFuture
<CreateProfileResponse> createProfile
(CreateProfileRequest createProfileRequest) Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.createTrustAnchor
(Consumer<CreateTrustAnchorRequest.Builder> createTrustAnchorRequest) Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).createTrustAnchor
(CreateTrustAnchorRequest createTrustAnchorRequest) Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).deleteAttributeMapping
(Consumer<DeleteAttributeMappingRequest.Builder> deleteAttributeMappingRequest) Delete an entry from the attribute mapping rules enforced by a given profile.deleteAttributeMapping
(DeleteAttributeMappingRequest deleteAttributeMappingRequest) Delete an entry from the attribute mapping rules enforced by a given profile.default CompletableFuture
<DeleteCrlResponse> deleteCrl
(Consumer<DeleteCrlRequest.Builder> deleteCrlRequest) Deletes a certificate revocation list (CRL).default CompletableFuture
<DeleteCrlResponse> deleteCrl
(DeleteCrlRequest deleteCrlRequest) Deletes a certificate revocation list (CRL).default CompletableFuture
<DeleteProfileResponse> deleteProfile
(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes a profile.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(DeleteProfileRequest deleteProfileRequest) Deletes a profile.deleteTrustAnchor
(Consumer<DeleteTrustAnchorRequest.Builder> deleteTrustAnchorRequest) Deletes a trust anchor.deleteTrustAnchor
(DeleteTrustAnchorRequest deleteTrustAnchorRequest) Deletes a trust anchor.default CompletableFuture
<DisableCrlResponse> disableCrl
(Consumer<DisableCrlRequest.Builder> disableCrlRequest) Disables a certificate revocation list (CRL).default CompletableFuture
<DisableCrlResponse> disableCrl
(DisableCrlRequest disableCrlRequest) Disables a certificate revocation list (CRL).default CompletableFuture
<DisableProfileResponse> disableProfile
(Consumer<DisableProfileRequest.Builder> disableProfileRequest) Disables a profile.default CompletableFuture
<DisableProfileResponse> disableProfile
(DisableProfileRequest disableProfileRequest) Disables a profile.disableTrustAnchor
(Consumer<DisableTrustAnchorRequest.Builder> disableTrustAnchorRequest) Disables a trust anchor.disableTrustAnchor
(DisableTrustAnchorRequest disableTrustAnchorRequest) Disables a trust anchor.default CompletableFuture
<EnableCrlResponse> enableCrl
(Consumer<EnableCrlRequest.Builder> enableCrlRequest) Enables a certificate revocation list (CRL).default CompletableFuture
<EnableCrlResponse> enableCrl
(EnableCrlRequest enableCrlRequest) Enables a certificate revocation list (CRL).default CompletableFuture
<EnableProfileResponse> enableProfile
(Consumer<EnableProfileRequest.Builder> enableProfileRequest) Enables temporary credential requests for a profile.default CompletableFuture
<EnableProfileResponse> enableProfile
(EnableProfileRequest enableProfileRequest) Enables temporary credential requests for a profile.enableTrustAnchor
(Consumer<EnableTrustAnchorRequest.Builder> enableTrustAnchorRequest) Enables a trust anchor.enableTrustAnchor
(EnableTrustAnchorRequest enableTrustAnchorRequest) Enables a trust anchor.default CompletableFuture
<GetCrlResponse> getCrl
(Consumer<GetCrlRequest.Builder> getCrlRequest) Gets a certificate revocation list (CRL).default CompletableFuture
<GetCrlResponse> getCrl
(GetCrlRequest getCrlRequest) Gets a certificate revocation list (CRL).default CompletableFuture
<GetProfileResponse> getProfile
(Consumer<GetProfileRequest.Builder> getProfileRequest) Gets a profile.default CompletableFuture
<GetProfileResponse> getProfile
(GetProfileRequest getProfileRequest) Gets a profile.default CompletableFuture
<GetSubjectResponse> getSubject
(Consumer<GetSubjectRequest.Builder> getSubjectRequest) Gets a subject, which associates a certificate identity with authentication attempts.default CompletableFuture
<GetSubjectResponse> getSubject
(GetSubjectRequest getSubjectRequest) Gets a subject, which associates a certificate identity with authentication attempts.default CompletableFuture
<GetTrustAnchorResponse> getTrustAnchor
(Consumer<GetTrustAnchorRequest.Builder> getTrustAnchorRequest) Gets a trust anchor.default CompletableFuture
<GetTrustAnchorResponse> getTrustAnchor
(GetTrustAnchorRequest getTrustAnchorRequest) Gets a trust anchor.default CompletableFuture
<ImportCrlResponse> importCrl
(Consumer<ImportCrlRequest.Builder> importCrlRequest) Imports the certificate revocation list (CRL).default CompletableFuture
<ImportCrlResponse> importCrl
(ImportCrlRequest importCrlRequest) Imports the certificate revocation list (CRL).default CompletableFuture
<ListCrlsResponse> listCrls
(Consumer<ListCrlsRequest.Builder> listCrlsRequest) Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.default CompletableFuture
<ListCrlsResponse> listCrls
(ListCrlsRequest listCrlsRequest) Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.default ListCrlsPublisher
listCrlsPaginator
(Consumer<ListCrlsRequest.Builder> listCrlsRequest) This is a variant oflistCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation.default ListCrlsPublisher
listCrlsPaginator
(ListCrlsRequest listCrlsRequest) This is a variant oflistCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation.default CompletableFuture
<ListProfilesResponse> listProfiles
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) Lists all profiles in the authenticated account and Amazon Web Services Region.default CompletableFuture
<ListProfilesResponse> listProfiles
(ListProfilesRequest listProfilesRequest) Lists all profiles in the authenticated account and Amazon Web Services Region.default ListProfilesPublisher
listProfilesPaginator
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation.default ListProfilesPublisher
listProfilesPaginator
(ListProfilesRequest listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation.default CompletableFuture
<ListSubjectsResponse> listSubjects
(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) Lists the subjects in the authenticated account and Amazon Web Services Region.default CompletableFuture
<ListSubjectsResponse> listSubjects
(ListSubjectsRequest listSubjectsRequest) Lists the subjects in the authenticated account and Amazon Web Services Region.default ListSubjectsPublisher
listSubjectsPaginator
(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) This is a variant oflistSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation.default ListSubjectsPublisher
listSubjectsPaginator
(ListSubjectsRequest listSubjectsRequest) This is a variant oflistSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to the resource.listTrustAnchors
(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) Lists the trust anchors in the authenticated account and Amazon Web Services Region.listTrustAnchors
(ListTrustAnchorsRequest listTrustAnchorsRequest) Lists the trust anchors in the authenticated account and Amazon Web Services Region.default ListTrustAnchorsPublisher
listTrustAnchorsPaginator
(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) This is a variant oflistTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation.default ListTrustAnchorsPublisher
listTrustAnchorsPaginator
(ListTrustAnchorsRequest listTrustAnchorsRequest) This is a variant oflistTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation.putAttributeMapping
(Consumer<PutAttributeMappingRequest.Builder> putAttributeMappingRequest) Put an entry in the attribute mapping rules that will be enforced by a given profile.putAttributeMapping
(PutAttributeMappingRequest putAttributeMappingRequest) Put an entry in the attribute mapping rules that will be enforced by a given profile.putNotificationSettings
(Consumer<PutNotificationSettingsRequest.Builder> putNotificationSettingsRequest) Attaches a list of notification settings to a trust anchor.putNotificationSettings
(PutNotificationSettingsRequest putNotificationSettingsRequest) Attaches a list of notification settings to a trust anchor.resetNotificationSettings
(Consumer<ResetNotificationSettingsRequest.Builder> resetNotificationSettingsRequest) Resets the custom notification setting to IAM Roles Anywhere default setting.resetNotificationSettings
(ResetNotificationSettingsRequest resetNotificationSettingsRequest) Resets the custom notification setting to IAM Roles Anywhere default setting.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches tags to a resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Attaches tags to a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the resource.default CompletableFuture
<UpdateCrlResponse> updateCrl
(Consumer<UpdateCrlRequest.Builder> updateCrlRequest) Updates the certificate revocation list (CRL).default CompletableFuture
<UpdateCrlResponse> updateCrl
(UpdateCrlRequest updateCrlRequest) Updates the certificate revocation list (CRL).default CompletableFuture
<UpdateProfileResponse> updateProfile
(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.default CompletableFuture
<UpdateProfileResponse> updateProfile
(UpdateProfileRequest updateProfileRequest) Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.updateTrustAnchor
(Consumer<UpdateTrustAnchorRequest.Builder> updateTrustAnchorRequest) Updates a trust anchor.updateTrustAnchor
(UpdateTrustAnchorRequest updateTrustAnchorRequest) Updates a trust anchor.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
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest) Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions:
rolesanywhere:CreateProfile
.- Parameters:
createProfileRequest
-- Returns:
- A Java Future containing the result of the CreateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions:
rolesanywhere:CreateProfile
.
This is a convenience which creates an instance of the
CreateProfileRequest.Builder
avoiding the need to create one manually viaCreateProfileRequest.builder()
- Parameters:
createProfileRequest
- AConsumer
that will call methods onCreateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrustAnchor
default CompletableFuture<CreateTrustAnchorResponse> createTrustAnchor(CreateTrustAnchorRequest createTrustAnchorRequest) Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions:
rolesanywhere:CreateTrustAnchor
.- Parameters:
createTrustAnchorRequest
-- Returns:
- A Java Future containing the result of the CreateTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrustAnchor
default CompletableFuture<CreateTrustAnchorResponse> createTrustAnchor(Consumer<CreateTrustAnchorRequest.Builder> createTrustAnchorRequest) Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions:
rolesanywhere:CreateTrustAnchor
.
This is a convenience which creates an instance of the
CreateTrustAnchorRequest.Builder
avoiding the need to create one manually viaCreateTrustAnchorRequest.builder()
- Parameters:
createTrustAnchorRequest
- AConsumer
that will call methods onCreateTrustAnchorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAttributeMapping
default CompletableFuture<DeleteAttributeMappingResponse> deleteAttributeMapping(DeleteAttributeMappingRequest deleteAttributeMappingRequest) Delete an entry from the attribute mapping rules enforced by a given profile.
- Parameters:
deleteAttributeMappingRequest
-- Returns:
- A Java Future containing the result of the DeleteAttributeMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAttributeMapping
default CompletableFuture<DeleteAttributeMappingResponse> deleteAttributeMapping(Consumer<DeleteAttributeMappingRequest.Builder> deleteAttributeMappingRequest) Delete an entry from the attribute mapping rules enforced by a given profile.
This is a convenience which creates an instance of the
DeleteAttributeMappingRequest.Builder
avoiding the need to create one manually viaDeleteAttributeMappingRequest.builder()
- Parameters:
deleteAttributeMappingRequest
- AConsumer
that will call methods onDeleteAttributeMappingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAttributeMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCrl
Deletes a certificate revocation list (CRL).
Required permissions:
rolesanywhere:DeleteCrl
.- Parameters:
deleteCrlRequest
-- Returns:
- A Java Future containing the result of the DeleteCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCrl
default CompletableFuture<DeleteCrlResponse> deleteCrl(Consumer<DeleteCrlRequest.Builder> deleteCrlRequest) Deletes a certificate revocation list (CRL).
Required permissions:
rolesanywhere:DeleteCrl
.
This is a convenience which creates an instance of the
DeleteCrlRequest.Builder
avoiding the need to create one manually viaDeleteCrlRequest.builder()
- Parameters:
deleteCrlRequest
- AConsumer
that will call methods onDeleteCrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest) Deletes a profile.
Required permissions:
rolesanywhere:DeleteProfile
.- Parameters:
deleteProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes a profile.
Required permissions:
rolesanywhere:DeleteProfile
.
This is a convenience which creates an instance of the
DeleteProfileRequest.Builder
avoiding the need to create one manually viaDeleteProfileRequest.builder()
- Parameters:
deleteProfileRequest
- AConsumer
that will call methods onDeleteProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrustAnchor
default CompletableFuture<DeleteTrustAnchorResponse> deleteTrustAnchor(DeleteTrustAnchorRequest deleteTrustAnchorRequest) Deletes a trust anchor.
Required permissions:
rolesanywhere:DeleteTrustAnchor
.- Parameters:
deleteTrustAnchorRequest
-- Returns:
- A Java Future containing the result of the DeleteTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrustAnchor
default CompletableFuture<DeleteTrustAnchorResponse> deleteTrustAnchor(Consumer<DeleteTrustAnchorRequest.Builder> deleteTrustAnchorRequest) Deletes a trust anchor.
Required permissions:
rolesanywhere:DeleteTrustAnchor
.
This is a convenience which creates an instance of the
DeleteTrustAnchorRequest.Builder
avoiding the need to create one manually viaDeleteTrustAnchorRequest.builder()
- Parameters:
deleteTrustAnchorRequest
- AConsumer
that will call methods onDeleteTrustAnchorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableCrl
Disables a certificate revocation list (CRL).
Required permissions:
rolesanywhere:DisableCrl
.- Parameters:
disableCrlRequest
-- Returns:
- A Java Future containing the result of the DisableCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableCrl
default CompletableFuture<DisableCrlResponse> disableCrl(Consumer<DisableCrlRequest.Builder> disableCrlRequest) Disables a certificate revocation list (CRL).
Required permissions:
rolesanywhere:DisableCrl
.
This is a convenience which creates an instance of the
DisableCrlRequest.Builder
avoiding the need to create one manually viaDisableCrlRequest.builder()
- Parameters:
disableCrlRequest
- AConsumer
that will call methods onDisableCrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableProfile
default CompletableFuture<DisableProfileResponse> disableProfile(DisableProfileRequest disableProfileRequest) Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions:
rolesanywhere:DisableProfile
.- Parameters:
disableProfileRequest
-- Returns:
- A Java Future containing the result of the DisableProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableProfile
default CompletableFuture<DisableProfileResponse> disableProfile(Consumer<DisableProfileRequest.Builder> disableProfileRequest) Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions:
rolesanywhere:DisableProfile
.
This is a convenience which creates an instance of the
DisableProfileRequest.Builder
avoiding the need to create one manually viaDisableProfileRequest.builder()
- Parameters:
disableProfileRequest
- AConsumer
that will call methods onDisableProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableTrustAnchor
default CompletableFuture<DisableTrustAnchorResponse> disableTrustAnchor(DisableTrustAnchorRequest disableTrustAnchorRequest) Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized.
Required permissions:
rolesanywhere:DisableTrustAnchor
.- Parameters:
disableTrustAnchorRequest
-- Returns:
- A Java Future containing the result of the DisableTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableTrustAnchor
default CompletableFuture<DisableTrustAnchorResponse> disableTrustAnchor(Consumer<DisableTrustAnchorRequest.Builder> disableTrustAnchorRequest) Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized.
Required permissions:
rolesanywhere:DisableTrustAnchor
.
This is a convenience which creates an instance of the
DisableTrustAnchorRequest.Builder
avoiding the need to create one manually viaDisableTrustAnchorRequest.builder()
- Parameters:
disableTrustAnchorRequest
- AConsumer
that will call methods onDisableTrustAnchorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableCrl
Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.
Required permissions:
rolesanywhere:EnableCrl
.- Parameters:
enableCrlRequest
-- Returns:
- A Java Future containing the result of the EnableCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableCrl
default CompletableFuture<EnableCrlResponse> enableCrl(Consumer<EnableCrlRequest.Builder> enableCrlRequest) Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.
Required permissions:
rolesanywhere:EnableCrl
.
This is a convenience which creates an instance of the
EnableCrlRequest.Builder
avoiding the need to create one manually viaEnableCrlRequest.builder()
- Parameters:
enableCrlRequest
- AConsumer
that will call methods onEnableCrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableProfile
default CompletableFuture<EnableProfileResponse> enableProfile(EnableProfileRequest enableProfileRequest) Enables temporary credential requests for a profile.
Required permissions:
rolesanywhere:EnableProfile
.- Parameters:
enableProfileRequest
-- Returns:
- A Java Future containing the result of the EnableProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableProfile
default CompletableFuture<EnableProfileResponse> enableProfile(Consumer<EnableProfileRequest.Builder> enableProfileRequest) Enables temporary credential requests for a profile.
Required permissions:
rolesanywhere:EnableProfile
.
This is a convenience which creates an instance of the
EnableProfileRequest.Builder
avoiding the need to create one manually viaEnableProfileRequest.builder()
- Parameters:
enableProfileRequest
- AConsumer
that will call methods onEnableProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableTrustAnchor
default CompletableFuture<EnableTrustAnchorResponse> enableTrustAnchor(EnableTrustAnchorRequest enableTrustAnchorRequest) Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions:
rolesanywhere:EnableTrustAnchor
.- Parameters:
enableTrustAnchorRequest
-- Returns:
- A Java Future containing the result of the EnableTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableTrustAnchor
default CompletableFuture<EnableTrustAnchorResponse> enableTrustAnchor(Consumer<EnableTrustAnchorRequest.Builder> enableTrustAnchorRequest) Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions:
rolesanywhere:EnableTrustAnchor
.
This is a convenience which creates an instance of the
EnableTrustAnchorRequest.Builder
avoiding the need to create one manually viaEnableTrustAnchorRequest.builder()
- Parameters:
enableTrustAnchorRequest
- AConsumer
that will call methods onEnableTrustAnchorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCrl
Gets a certificate revocation list (CRL).
Required permissions:
rolesanywhere:GetCrl
.- Parameters:
getCrlRequest
-- Returns:
- A Java Future containing the result of the GetCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCrl
Gets a certificate revocation list (CRL).
Required permissions:
rolesanywhere:GetCrl
.
This is a convenience which creates an instance of the
GetCrlRequest.Builder
avoiding the need to create one manually viaGetCrlRequest.builder()
- Parameters:
getCrlRequest
- AConsumer
that will call methods onGetCrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfile
Gets a profile.
Required permissions:
rolesanywhere:GetProfile
.- Parameters:
getProfileRequest
-- Returns:
- A Java Future containing the result of the GetProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfile
default CompletableFuture<GetProfileResponse> getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) Gets a profile.
Required permissions:
rolesanywhere:GetProfile
.
This is a convenience which creates an instance of the
GetProfileRequest.Builder
avoiding the need to create one manually viaGetProfileRequest.builder()
- Parameters:
getProfileRequest
- AConsumer
that will call methods onGetProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSubject
Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.
Required permissions:
rolesanywhere:GetSubject
.- Parameters:
getSubjectRequest
-- Returns:
- A Java Future containing the result of the GetSubject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSubject
default CompletableFuture<GetSubjectResponse> getSubject(Consumer<GetSubjectRequest.Builder> getSubjectRequest) Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.
Required permissions:
rolesanywhere:GetSubject
.
This is a convenience which creates an instance of the
GetSubjectRequest.Builder
avoiding the need to create one manually viaGetSubjectRequest.builder()
- Parameters:
getSubjectRequest
- AConsumer
that will call methods onGetSubjectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSubject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrustAnchor
default CompletableFuture<GetTrustAnchorResponse> getTrustAnchor(GetTrustAnchorRequest getTrustAnchorRequest) Gets a trust anchor.
Required permissions:
rolesanywhere:GetTrustAnchor
.- Parameters:
getTrustAnchorRequest
-- Returns:
- A Java Future containing the result of the GetTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrustAnchor
default CompletableFuture<GetTrustAnchorResponse> getTrustAnchor(Consumer<GetTrustAnchorRequest.Builder> getTrustAnchorRequest) Gets a trust anchor.
Required permissions:
rolesanywhere:GetTrustAnchor
.
This is a convenience which creates an instance of the
GetTrustAnchorRequest.Builder
avoiding the need to create one manually viaGetTrustAnchorRequest.builder()
- Parameters:
getTrustAnchorRequest
- AConsumer
that will call methods onGetTrustAnchorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importCrl
Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions:
rolesanywhere:ImportCrl
.- Parameters:
importCrlRequest
-- Returns:
- A Java Future containing the result of the ImportCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importCrl
default CompletableFuture<ImportCrlResponse> importCrl(Consumer<ImportCrlRequest.Builder> importCrlRequest) Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions:
rolesanywhere:ImportCrl
.
This is a convenience which creates an instance of the
ImportCrlRequest.Builder
avoiding the need to create one manually viaImportCrlRequest.builder()
- Parameters:
importCrlRequest
- AConsumer
that will call methods onImportCrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrls
Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListCrls
.- Parameters:
listCrlsRequest
-- Returns:
- A Java Future containing the result of the ListCrls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrls
default CompletableFuture<ListCrlsResponse> listCrls(Consumer<ListCrlsRequest.Builder> listCrlsRequest) Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListCrls
.
This is a convenience which creates an instance of the
ListCrlsRequest.Builder
avoiding the need to create one manually viaListCrlsRequest.builder()
- Parameters:
listCrlsRequest
- AConsumer
that will call methods onListCrlsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCrls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrlsPaginator
This is a variant of
listCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
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.rolesanywhere.paginators.ListCrlsPublisher publisher = client.listCrlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsPublisher publisher = client.listCrlsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListCrlsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsResponse response) { //... }; });
Please notice that the configuration of null 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
listCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation.- Parameters:
listCrlsRequest
-- 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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrlsPaginator
This is a variant of
listCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
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.rolesanywhere.paginators.ListCrlsPublisher publisher = client.listCrlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsPublisher publisher = client.listCrlsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListCrlsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsResponse response) { //... }; });
Please notice that the configuration of null 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
listCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation.
This is a convenience which creates an instance of the
ListCrlsRequest.Builder
avoiding the need to create one manually viaListCrlsRequest.builder()
- Parameters:
listCrlsRequest
- AConsumer
that will call methods onListCrlsRequest.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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(ListProfilesRequest listProfilesRequest) Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListProfiles
.- Parameters:
listProfilesRequest
-- Returns:
- A Java Future containing the result of the ListProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest) Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListProfiles
.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
This is a variant of
listProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
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.rolesanywhere.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesResponse response) { //... }; });
Please notice that the configuration of null 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
listProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation.- Parameters:
listProfilesRequest
-- 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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
default ListProfilesPublisher listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant of
listProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
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.rolesanywhere.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesResponse response) { //... }; });
Please notice that the configuration of null 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
listProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubjects
default CompletableFuture<ListSubjectsResponse> listSubjects(ListSubjectsRequest listSubjectsRequest) Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListSubjects
.- Parameters:
listSubjectsRequest
-- Returns:
- A Java Future containing the result of the ListSubjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubjects
default CompletableFuture<ListSubjectsResponse> listSubjects(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListSubjects
.
This is a convenience which creates an instance of the
ListSubjectsRequest.Builder
avoiding the need to create one manually viaListSubjectsRequest.builder()
- Parameters:
listSubjectsRequest
- AConsumer
that will call methods onListSubjectsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSubjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubjectsPaginator
This is a variant of
listSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
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.rolesanywhere.paginators.ListSubjectsPublisher publisher = client.listSubjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsPublisher publisher = client.listSubjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsResponse response) { //... }; });
Please notice that the configuration of null 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
listSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation.- Parameters:
listSubjectsRequest
-- 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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubjectsPaginator
default ListSubjectsPublisher listSubjectsPaginator(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) This is a variant of
listSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
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.rolesanywhere.paginators.ListSubjectsPublisher publisher = client.listSubjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsPublisher publisher = client.listSubjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsResponse response) { //... }; });
Please notice that the configuration of null 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
listSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation.
This is a convenience which creates an instance of the
ListSubjectsRequest.Builder
avoiding the need to create one manually viaListSubjectsRequest.builder()
- Parameters:
listSubjectsRequest
- AConsumer
that will call methods onListSubjectsRequest.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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to the resource.
Required permissions:
rolesanywhere:ListTagsForResource
.- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to the resource.
Required permissions:
rolesanywhere:ListTagsForResource
.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrustAnchors
default CompletableFuture<ListTrustAnchorsResponse> listTrustAnchors(ListTrustAnchorsRequest listTrustAnchorsRequest) Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListTrustAnchors
.- Parameters:
listTrustAnchorsRequest
-- Returns:
- A Java Future containing the result of the ListTrustAnchors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrustAnchors
default CompletableFuture<ListTrustAnchorsResponse> listTrustAnchors(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListTrustAnchors
.
This is a convenience which creates an instance of the
ListTrustAnchorsRequest.Builder
avoiding the need to create one manually viaListTrustAnchorsRequest.builder()
- Parameters:
listTrustAnchorsRequest
- AConsumer
that will call methods onListTrustAnchorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTrustAnchors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrustAnchorsPaginator
default ListTrustAnchorsPublisher listTrustAnchorsPaginator(ListTrustAnchorsRequest listTrustAnchorsRequest) This is a variant of
listTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
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.rolesanywhere.paginators.ListTrustAnchorsPublisher publisher = client.listTrustAnchorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsPublisher publisher = client.listTrustAnchorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsResponse response) { //... }; });
Please notice that the configuration of null 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
listTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation.- Parameters:
listTrustAnchorsRequest
-- 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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrustAnchorsPaginator
default ListTrustAnchorsPublisher listTrustAnchorsPaginator(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) This is a variant of
listTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
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.rolesanywhere.paginators.ListTrustAnchorsPublisher publisher = client.listTrustAnchorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsPublisher publisher = client.listTrustAnchorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsResponse response) { //... }; });
Please notice that the configuration of null 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
listTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation.
This is a convenience which creates an instance of the
ListTrustAnchorsRequest.Builder
avoiding the need to create one manually viaListTrustAnchorsRequest.builder()
- Parameters:
listTrustAnchorsRequest
- AConsumer
that will call methods onListTrustAnchorsRequest.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.- ValidationException Validation exception error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAttributeMapping
default CompletableFuture<PutAttributeMappingResponse> putAttributeMapping(PutAttributeMappingRequest putAttributeMappingRequest) Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.
- Parameters:
putAttributeMappingRequest
-- Returns:
- A Java Future containing the result of the PutAttributeMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAttributeMapping
default CompletableFuture<PutAttributeMappingResponse> putAttributeMapping(Consumer<PutAttributeMappingRequest.Builder> putAttributeMappingRequest) Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.
This is a convenience which creates an instance of the
PutAttributeMappingRequest.Builder
avoiding the need to create one manually viaPutAttributeMappingRequest.builder()
- Parameters:
putAttributeMappingRequest
- AConsumer
that will call methods onPutAttributeMappingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAttributeMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putNotificationSettings
default CompletableFuture<PutNotificationSettingsResponse> putNotificationSettings(PutNotificationSettingsRequest putNotificationSettingsRequest) Attaches a list of notification settings to a trust anchor.
A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.
Required permissions:
rolesanywhere:PutNotificationSettings
.- Parameters:
putNotificationSettingsRequest
-- Returns:
- A Java Future containing the result of the PutNotificationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putNotificationSettings
default CompletableFuture<PutNotificationSettingsResponse> putNotificationSettings(Consumer<PutNotificationSettingsRequest.Builder> putNotificationSettingsRequest) Attaches a list of notification settings to a trust anchor.
A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.
Required permissions:
rolesanywhere:PutNotificationSettings
.
This is a convenience which creates an instance of the
PutNotificationSettingsRequest.Builder
avoiding the need to create one manually viaPutNotificationSettingsRequest.builder()
- Parameters:
putNotificationSettingsRequest
- AConsumer
that will call methods onPutNotificationSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutNotificationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetNotificationSettings
default CompletableFuture<ResetNotificationSettingsResponse> resetNotificationSettings(ResetNotificationSettingsRequest resetNotificationSettingsRequest) Resets the custom notification setting to IAM Roles Anywhere default setting.
Required permissions:
rolesanywhere:ResetNotificationSettings
.- Parameters:
resetNotificationSettingsRequest
-- Returns:
- A Java Future containing the result of the ResetNotificationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetNotificationSettings
default CompletableFuture<ResetNotificationSettingsResponse> resetNotificationSettings(Consumer<ResetNotificationSettingsRequest.Builder> resetNotificationSettingsRequest) Resets the custom notification setting to IAM Roles Anywhere default setting.
Required permissions:
rolesanywhere:ResetNotificationSettings
.
This is a convenience which creates an instance of the
ResetNotificationSettingsRequest.Builder
avoiding the need to create one manually viaResetNotificationSettingsRequest.builder()
- Parameters:
resetNotificationSettingsRequest
- AConsumer
that will call methods onResetNotificationSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetNotificationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Attaches tags to a resource.
Required permissions:
rolesanywhere:TagResource
.- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyTagsException Too many tags.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches tags to a resource.
Required permissions:
rolesanywhere:TagResource
.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyTagsException Too many tags.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the resource.
Required permissions:
rolesanywhere:UntagResource
.- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource.
Required permissions:
rolesanywhere:UntagResource
.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCrl
Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions:
rolesanywhere:UpdateCrl
.- Parameters:
updateCrlRequest
-- Returns:
- A Java Future containing the result of the UpdateCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCrl
default CompletableFuture<UpdateCrlResponse> updateCrl(Consumer<UpdateCrlRequest.Builder> updateCrlRequest) Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions:
rolesanywhere:UpdateCrl
.
This is a convenience which creates an instance of the
UpdateCrlRequest.Builder
avoiding the need to create one manually viaUpdateCrlRequest.builder()
- Parameters:
updateCrlRequest
- AConsumer
that will call methods onUpdateCrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest) Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions:
rolesanywhere:UpdateProfile
.- Parameters:
updateProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions:
rolesanywhere:UpdateProfile
.
This is a convenience which creates an instance of the
UpdateProfileRequest.Builder
avoiding the need to create one manually viaUpdateProfileRequest.builder()
- Parameters:
updateProfileRequest
- AConsumer
that will call methods onUpdateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrustAnchor
default CompletableFuture<UpdateTrustAnchorResponse> updateTrustAnchor(UpdateTrustAnchorRequest updateTrustAnchorRequest) Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions:
rolesanywhere:UpdateTrustAnchor
.- Parameters:
updateTrustAnchorRequest
-- Returns:
- A Java Future containing the result of the UpdateTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrustAnchor
default CompletableFuture<UpdateTrustAnchorResponse> updateTrustAnchor(Consumer<UpdateTrustAnchorRequest.Builder> updateTrustAnchorRequest) Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions:
rolesanywhere:UpdateTrustAnchor
.
This is a convenience which creates an instance of the
UpdateTrustAnchorRequest.Builder
avoiding the need to create one manually viaUpdateTrustAnchorRequest.builder()
- Parameters:
updateTrustAnchorRequest
- AConsumer
that will call methods onUpdateTrustAnchorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTrustAnchor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Validation exception error.
- ResourceNotFoundException The resource could not be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RolesAnywhereException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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
-
create
Create aRolesAnywhereAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRolesAnywhereAsyncClient
.
-