Interface RolesAnywhereClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic RolesAnywhereClientBuilder
builder()
Create a builder that can be used to configure and create aRolesAnywhereClient
.static RolesAnywhereClient
create()
Create aRolesAnywhereClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateProfileResponse
createProfile
(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.default CreateProfileResponse
createProfile
(CreateProfileRequest createProfileRequest) Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.default CreateTrustAnchorResponse
createTrustAnchor
(Consumer<CreateTrustAnchorRequest.Builder> createTrustAnchorRequest) Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).default CreateTrustAnchorResponse
createTrustAnchor
(CreateTrustAnchorRequest createTrustAnchorRequest) Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).default DeleteAttributeMappingResponse
deleteAttributeMapping
(Consumer<DeleteAttributeMappingRequest.Builder> deleteAttributeMappingRequest) Delete an entry from the attribute mapping rules enforced by a given profile.default DeleteAttributeMappingResponse
deleteAttributeMapping
(DeleteAttributeMappingRequest deleteAttributeMappingRequest) Delete an entry from the attribute mapping rules enforced by a given profile.default DeleteCrlResponse
deleteCrl
(Consumer<DeleteCrlRequest.Builder> deleteCrlRequest) Deletes a certificate revocation list (CRL).default DeleteCrlResponse
deleteCrl
(DeleteCrlRequest deleteCrlRequest) Deletes a certificate revocation list (CRL).default DeleteProfileResponse
deleteProfile
(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes a profile.default DeleteProfileResponse
deleteProfile
(DeleteProfileRequest deleteProfileRequest) Deletes a profile.default DeleteTrustAnchorResponse
deleteTrustAnchor
(Consumer<DeleteTrustAnchorRequest.Builder> deleteTrustAnchorRequest) Deletes a trust anchor.default DeleteTrustAnchorResponse
deleteTrustAnchor
(DeleteTrustAnchorRequest deleteTrustAnchorRequest) Deletes a trust anchor.default DisableCrlResponse
disableCrl
(Consumer<DisableCrlRequest.Builder> disableCrlRequest) Disables a certificate revocation list (CRL).default DisableCrlResponse
disableCrl
(DisableCrlRequest disableCrlRequest) Disables a certificate revocation list (CRL).default DisableProfileResponse
disableProfile
(Consumer<DisableProfileRequest.Builder> disableProfileRequest) Disables a profile.default DisableProfileResponse
disableProfile
(DisableProfileRequest disableProfileRequest) Disables a profile.default DisableTrustAnchorResponse
disableTrustAnchor
(Consumer<DisableTrustAnchorRequest.Builder> disableTrustAnchorRequest) Disables a trust anchor.default DisableTrustAnchorResponse
disableTrustAnchor
(DisableTrustAnchorRequest disableTrustAnchorRequest) Disables a trust anchor.default EnableCrlResponse
enableCrl
(Consumer<EnableCrlRequest.Builder> enableCrlRequest) Enables a certificate revocation list (CRL).default EnableCrlResponse
enableCrl
(EnableCrlRequest enableCrlRequest) Enables a certificate revocation list (CRL).default EnableProfileResponse
enableProfile
(Consumer<EnableProfileRequest.Builder> enableProfileRequest) Enables temporary credential requests for a profile.default EnableProfileResponse
enableProfile
(EnableProfileRequest enableProfileRequest) Enables temporary credential requests for a profile.default EnableTrustAnchorResponse
enableTrustAnchor
(Consumer<EnableTrustAnchorRequest.Builder> enableTrustAnchorRequest) Enables a trust anchor.default EnableTrustAnchorResponse
enableTrustAnchor
(EnableTrustAnchorRequest enableTrustAnchorRequest) Enables a trust anchor.default GetCrlResponse
getCrl
(Consumer<GetCrlRequest.Builder> getCrlRequest) Gets a certificate revocation list (CRL).default GetCrlResponse
getCrl
(GetCrlRequest getCrlRequest) Gets a certificate revocation list (CRL).default GetProfileResponse
getProfile
(Consumer<GetProfileRequest.Builder> getProfileRequest) Gets a profile.default GetProfileResponse
getProfile
(GetProfileRequest getProfileRequest) Gets a profile.default GetSubjectResponse
getSubject
(Consumer<GetSubjectRequest.Builder> getSubjectRequest) Gets a subject, which associates a certificate identity with authentication attempts.default GetSubjectResponse
getSubject
(GetSubjectRequest getSubjectRequest) Gets a subject, which associates a certificate identity with authentication attempts.default GetTrustAnchorResponse
getTrustAnchor
(Consumer<GetTrustAnchorRequest.Builder> getTrustAnchorRequest) Gets a trust anchor.default GetTrustAnchorResponse
getTrustAnchor
(GetTrustAnchorRequest getTrustAnchorRequest) Gets a trust anchor.default ImportCrlResponse
importCrl
(Consumer<ImportCrlRequest.Builder> importCrlRequest) Imports the certificate revocation list (CRL).default ImportCrlResponse
importCrl
(ImportCrlRequest importCrlRequest) Imports the certificate revocation list (CRL).default ListCrlsResponse
listCrls
(Consumer<ListCrlsRequest.Builder> listCrlsRequest) Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.default ListCrlsResponse
listCrls
(ListCrlsRequest listCrlsRequest) Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.default ListCrlsIterable
listCrlsPaginator
(Consumer<ListCrlsRequest.Builder> listCrlsRequest) This is a variant oflistCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation.default ListCrlsIterable
listCrlsPaginator
(ListCrlsRequest listCrlsRequest) This is a variant oflistCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation.default ListProfilesResponse
listProfiles
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) Lists all profiles in the authenticated account and Amazon Web Services Region.default ListProfilesResponse
listProfiles
(ListProfilesRequest listProfilesRequest) Lists all profiles in the authenticated account and Amazon Web Services Region.default ListProfilesIterable
listProfilesPaginator
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation.default ListProfilesIterable
listProfilesPaginator
(ListProfilesRequest listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation.default ListSubjectsResponse
listSubjects
(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) Lists the subjects in the authenticated account and Amazon Web Services Region.default ListSubjectsResponse
listSubjects
(ListSubjectsRequest listSubjectsRequest) Lists the subjects in the authenticated account and Amazon Web Services Region.default ListSubjectsIterable
listSubjectsPaginator
(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) This is a variant oflistSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation.default ListSubjectsIterable
listSubjectsPaginator
(ListSubjectsRequest listSubjectsRequest) This is a variant oflistSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to the resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to the resource.default ListTrustAnchorsResponse
listTrustAnchors
(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) Lists the trust anchors in the authenticated account and Amazon Web Services Region.default ListTrustAnchorsResponse
listTrustAnchors
(ListTrustAnchorsRequest listTrustAnchorsRequest) Lists the trust anchors in the authenticated account and Amazon Web Services Region.default ListTrustAnchorsIterable
listTrustAnchorsPaginator
(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) This is a variant oflistTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation.default ListTrustAnchorsIterable
listTrustAnchorsPaginator
(ListTrustAnchorsRequest listTrustAnchorsRequest) This is a variant oflistTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation.default PutAttributeMappingResponse
putAttributeMapping
(Consumer<PutAttributeMappingRequest.Builder> putAttributeMappingRequest) Put an entry in the attribute mapping rules that will be enforced by a given profile.default PutAttributeMappingResponse
putAttributeMapping
(PutAttributeMappingRequest putAttributeMappingRequest) Put an entry in the attribute mapping rules that will be enforced by a given profile.default PutNotificationSettingsResponse
putNotificationSettings
(Consumer<PutNotificationSettingsRequest.Builder> putNotificationSettingsRequest) Attaches a list of notification settings to a trust anchor.default PutNotificationSettingsResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches tags to a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Attaches tags to a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the resource.default UpdateCrlResponse
updateCrl
(Consumer<UpdateCrlRequest.Builder> updateCrlRequest) Updates the certificate revocation list (CRL).default UpdateCrlResponse
updateCrl
(UpdateCrlRequest updateCrlRequest) Updates the certificate revocation list (CRL).default UpdateProfileResponse
updateProfile
(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.default UpdateProfileResponse
updateProfile
(UpdateProfileRequest updateProfileRequest) Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.default UpdateTrustAnchorResponse
updateTrustAnchor
(Consumer<UpdateTrustAnchorRequest.Builder> updateTrustAnchorRequest) Updates a trust anchor.default UpdateTrustAnchorResponse
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 CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the CreateProfile operation returned by the service.
- See Also:
-
createProfile
default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the CreateProfile operation returned by the service.
- See Also:
-
createTrustAnchor
default CreateTrustAnchorResponse createTrustAnchor(CreateTrustAnchorRequest createTrustAnchorRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the CreateTrustAnchor operation returned by the service.
- See Also:
-
createTrustAnchor
default CreateTrustAnchorResponse createTrustAnchor(Consumer<CreateTrustAnchorRequest.Builder> createTrustAnchorRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the CreateTrustAnchor operation returned by the service.
- See Also:
-
deleteAttributeMapping
default DeleteAttributeMappingResponse deleteAttributeMapping(DeleteAttributeMappingRequest deleteAttributeMappingRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Delete an entry from the attribute mapping rules enforced by a given profile.
- Parameters:
deleteAttributeMappingRequest
-- Returns:
- Result of the DeleteAttributeMapping operation returned by the service.
- See Also:
-
deleteAttributeMapping
default DeleteAttributeMappingResponse deleteAttributeMapping(Consumer<DeleteAttributeMappingRequest.Builder> deleteAttributeMappingRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DeleteAttributeMapping operation returned by the service.
- See Also:
-
deleteCrl
default DeleteCrlResponse deleteCrl(DeleteCrlRequest deleteCrlRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Deletes a certificate revocation list (CRL).
Required permissions:
rolesanywhere:DeleteCrl
.- Parameters:
deleteCrlRequest
-- Returns:
- Result of the DeleteCrl operation returned by the service.
- See Also:
-
deleteCrl
default DeleteCrlResponse deleteCrl(Consumer<DeleteCrlRequest.Builder> deleteCrlRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DeleteCrl operation returned by the service.
- See Also:
-
deleteProfile
default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Deletes a profile.
Required permissions:
rolesanywhere:DeleteProfile
.- Parameters:
deleteProfileRequest
-- Returns:
- Result of the DeleteProfile operation returned by the service.
- See Also:
-
deleteProfile
default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DeleteProfile operation returned by the service.
- See Also:
-
deleteTrustAnchor
default DeleteTrustAnchorResponse deleteTrustAnchor(DeleteTrustAnchorRequest deleteTrustAnchorRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Deletes a trust anchor.
Required permissions:
rolesanywhere:DeleteTrustAnchor
.- Parameters:
deleteTrustAnchorRequest
-- Returns:
- Result of the DeleteTrustAnchor operation returned by the service.
- See Also:
-
deleteTrustAnchor
default DeleteTrustAnchorResponse deleteTrustAnchor(Consumer<DeleteTrustAnchorRequest.Builder> deleteTrustAnchorRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DeleteTrustAnchor operation returned by the service.
- See Also:
-
disableCrl
default DisableCrlResponse disableCrl(DisableCrlRequest disableCrlRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Disables a certificate revocation list (CRL).
Required permissions:
rolesanywhere:DisableCrl
.- Parameters:
disableCrlRequest
-- Returns:
- Result of the DisableCrl operation returned by the service.
- See Also:
-
disableCrl
default DisableCrlResponse disableCrl(Consumer<DisableCrlRequest.Builder> disableCrlRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DisableCrl operation returned by the service.
- See Also:
-
disableProfile
default DisableProfileResponse disableProfile(DisableProfileRequest disableProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions:
rolesanywhere:DisableProfile
.- Parameters:
disableProfileRequest
-- Returns:
- Result of the DisableProfile operation returned by the service.
- See Also:
-
disableProfile
default DisableProfileResponse disableProfile(Consumer<DisableProfileRequest.Builder> disableProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DisableProfile operation returned by the service.
- See Also:
-
disableTrustAnchor
default DisableTrustAnchorResponse disableTrustAnchor(DisableTrustAnchorRequest disableTrustAnchorRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized.
Required permissions:
rolesanywhere:DisableTrustAnchor
.- Parameters:
disableTrustAnchorRequest
-- Returns:
- Result of the DisableTrustAnchor operation returned by the service.
- See Also:
-
disableTrustAnchor
default DisableTrustAnchorResponse disableTrustAnchor(Consumer<DisableTrustAnchorRequest.Builder> disableTrustAnchorRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the DisableTrustAnchor operation returned by the service.
- See Also:
-
enableCrl
default EnableCrlResponse enableCrl(EnableCrlRequest enableCrlRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the EnableCrl operation returned by the service.
- See Also:
-
enableCrl
default EnableCrlResponse enableCrl(Consumer<EnableCrlRequest.Builder> enableCrlRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the EnableCrl operation returned by the service.
- See Also:
-
enableProfile
default EnableProfileResponse enableProfile(EnableProfileRequest enableProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Enables temporary credential requests for a profile.
Required permissions:
rolesanywhere:EnableProfile
.- Parameters:
enableProfileRequest
-- Returns:
- Result of the EnableProfile operation returned by the service.
- See Also:
-
enableProfile
default EnableProfileResponse enableProfile(Consumer<EnableProfileRequest.Builder> enableProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the EnableProfile operation returned by the service.
- See Also:
-
enableTrustAnchor
default EnableTrustAnchorResponse enableTrustAnchor(EnableTrustAnchorRequest enableTrustAnchorRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions:
rolesanywhere:EnableTrustAnchor
.- Parameters:
enableTrustAnchorRequest
-- Returns:
- Result of the EnableTrustAnchor operation returned by the service.
- See Also:
-
enableTrustAnchor
default EnableTrustAnchorResponse enableTrustAnchor(Consumer<EnableTrustAnchorRequest.Builder> enableTrustAnchorRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the EnableTrustAnchor operation returned by the service.
- See Also:
-
getCrl
default GetCrlResponse getCrl(GetCrlRequest getCrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, RolesAnywhereException Gets a certificate revocation list (CRL).
Required permissions:
rolesanywhere:GetCrl
.- Parameters:
getCrlRequest
-- Returns:
- Result of the GetCrl operation returned by the service.
- See Also:
-
getCrl
default GetCrlResponse getCrl(Consumer<GetCrlRequest.Builder> getCrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the GetCrl operation returned by the service.
- See Also:
-
getProfile
default GetProfileResponse getProfile(GetProfileRequest getProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Gets a profile.
Required permissions:
rolesanywhere:GetProfile
.- Parameters:
getProfileRequest
-- Returns:
- Result of the GetProfile operation returned by the service.
- See Also:
-
getProfile
default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the GetProfile operation returned by the service.
- See Also:
-
getSubject
default GetSubjectResponse getSubject(GetSubjectRequest getSubjectRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the GetSubject operation returned by the service.
- See Also:
-
getSubject
default GetSubjectResponse getSubject(Consumer<GetSubjectRequest.Builder> getSubjectRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the GetSubject operation returned by the service.
- See Also:
-
getTrustAnchor
default GetTrustAnchorResponse getTrustAnchor(GetTrustAnchorRequest getTrustAnchorRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Gets a trust anchor.
Required permissions:
rolesanywhere:GetTrustAnchor
.- Parameters:
getTrustAnchorRequest
-- Returns:
- Result of the GetTrustAnchor operation returned by the service.
- See Also:
-
getTrustAnchor
default GetTrustAnchorResponse getTrustAnchor(Consumer<GetTrustAnchorRequest.Builder> getTrustAnchorRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the GetTrustAnchor operation returned by the service.
- See Also:
-
importCrl
default ImportCrlResponse importCrl(ImportCrlRequest importCrlRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ImportCrl operation returned by the service.
- See Also:
-
importCrl
default ImportCrlResponse importCrl(Consumer<ImportCrlRequest.Builder> importCrlRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ImportCrl operation returned by the service.
- See Also:
-
listCrls
default ListCrlsResponse listCrls(ListCrlsRequest listCrlsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListCrls
.- Parameters:
listCrlsRequest
-- Returns:
- Result of the ListCrls operation returned by the service.
- See Also:
-
listCrls
default ListCrlsResponse listCrls(Consumer<ListCrlsRequest.Builder> listCrlsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ListCrls operation returned by the service.
- See Also:
-
listCrlsPaginator
default ListCrlsIterable listCrlsPaginator(ListCrlsRequest listCrlsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsIterable responses = client.listCrlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsIterable responses = client.listCrlsPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListCrlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsIterable responses = client.listCrlsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listCrlsPaginator
default ListCrlsIterable listCrlsPaginator(Consumer<ListCrlsRequest.Builder> listCrlsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listCrls(software.amazon.awssdk.services.rolesanywhere.model.ListCrlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsIterable responses = client.listCrlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsIterable responses = client.listCrlsPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListCrlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListCrlsIterable responses = client.listCrlsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listProfiles
default ListProfilesResponse listProfiles(ListProfilesRequest listProfilesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListProfiles
.- Parameters:
listProfilesRequest
-- Returns:
- Result of the ListProfiles operation returned by the service.
- See Also:
-
listProfiles
default ListProfilesResponse listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ListProfiles operation returned by the service.
- See Also:
-
listProfilesPaginator
default ListProfilesIterable listProfilesPaginator(ListProfilesRequest listProfilesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesIterable responses = client .listProfilesPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listProfilesPaginator
default ListProfilesIterable listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listProfiles(software.amazon.awssdk.services.rolesanywhere.model.ListProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesIterable responses = client .listProfilesPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubjects
default ListSubjectsResponse listSubjects(ListSubjectsRequest listSubjectsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListSubjects
.- Parameters:
listSubjectsRequest
-- Returns:
- Result of the ListSubjects operation returned by the service.
- See Also:
-
listSubjects
default ListSubjectsResponse listSubjects(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ListSubjects operation returned by the service.
- See Also:
-
listSubjectsPaginator
default ListSubjectsIterable listSubjectsPaginator(ListSubjectsRequest listSubjectsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsIterable responses = client.listSubjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsIterable responses = client .listSubjectsPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsIterable responses = client.listSubjectsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubjectsPaginator
default ListSubjectsIterable listSubjectsPaginator(Consumer<ListSubjectsRequest.Builder> listSubjectsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listSubjects(software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsIterable responses = client.listSubjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsIterable responses = client .listSubjectsPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListSubjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListSubjectsIterable responses = client.listSubjectsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Lists the tags attached to the resource.
Required permissions:
rolesanywhere:ListTagsForResource
.- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTrustAnchors
default ListTrustAnchorsResponse listTrustAnchors(ListTrustAnchorsRequest listTrustAnchorsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions:
rolesanywhere:ListTrustAnchors
.- Parameters:
listTrustAnchorsRequest
-- Returns:
- Result of the ListTrustAnchors operation returned by the service.
- See Also:
-
listTrustAnchors
default ListTrustAnchorsResponse listTrustAnchors(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ListTrustAnchors operation returned by the service.
- See Also:
-
listTrustAnchorsPaginator
default ListTrustAnchorsIterable listTrustAnchorsPaginator(ListTrustAnchorsRequest listTrustAnchorsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsIterable responses = client.listTrustAnchorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsIterable responses = client .listTrustAnchorsPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsIterable responses = client.listTrustAnchorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTrustAnchorsPaginator
default ListTrustAnchorsIterable listTrustAnchorsPaginator(Consumer<ListTrustAnchorsRequest.Builder> listTrustAnchorsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException This is a variant of
listTrustAnchors(software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsIterable responses = client.listTrustAnchorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsIterable responses = client .listTrustAnchorsPaginator(request); for (software.amazon.awssdk.services.rolesanywhere.model.ListTrustAnchorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rolesanywhere.paginators.ListTrustAnchorsIterable responses = client.listTrustAnchorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
putAttributeMapping
default PutAttributeMappingResponse putAttributeMapping(PutAttributeMappingRequest putAttributeMappingRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the PutAttributeMapping operation returned by the service.
- See Also:
-
putAttributeMapping
default PutAttributeMappingResponse putAttributeMapping(Consumer<PutAttributeMappingRequest.Builder> putAttributeMappingRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the PutAttributeMapping operation returned by the service.
- See Also:
-
putNotificationSettings
default PutNotificationSettingsResponse putNotificationSettings(PutNotificationSettingsRequest putNotificationSettingsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the PutNotificationSettings operation returned by the service.
- See Also:
-
putNotificationSettings
default PutNotificationSettingsResponse putNotificationSettings(Consumer<PutNotificationSettingsRequest.Builder> putNotificationSettingsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the PutNotificationSettings operation returned by the service.
- See Also:
-
resetNotificationSettings
default ResetNotificationSettingsResponse resetNotificationSettings(ResetNotificationSettingsRequest resetNotificationSettingsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Resets the custom notification setting to IAM Roles Anywhere default setting.
Required permissions:
rolesanywhere:ResetNotificationSettings
.- Parameters:
resetNotificationSettingsRequest
-- Returns:
- Result of the ResetNotificationSettings operation returned by the service.
- See Also:
-
resetNotificationSettings
default ResetNotificationSettingsResponse resetNotificationSettings(Consumer<ResetNotificationSettingsRequest.Builder> resetNotificationSettingsRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the ResetNotificationSettings operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, TooManyTagsException, AwsServiceException, SdkClientException, RolesAnywhereException Attaches tags to a resource.
Required permissions:
rolesanywhere:TagResource
.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, TooManyTagsException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException Removes tags from the resource.
Required permissions:
rolesanywhere:UntagResource
.- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCrl
default UpdateCrlResponse updateCrl(UpdateCrlRequest updateCrlRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UpdateCrl operation returned by the service.
- See Also:
-
updateCrl
default UpdateCrlResponse updateCrl(Consumer<UpdateCrlRequest.Builder> updateCrlRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UpdateCrl operation returned by the service.
- See Also:
-
updateProfile
default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UpdateProfile operation returned by the service.
- See Also:
-
updateProfile
default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UpdateProfile operation returned by the service.
- See Also:
-
updateTrustAnchor
default UpdateTrustAnchorResponse updateTrustAnchor(UpdateTrustAnchorRequest updateTrustAnchorRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UpdateTrustAnchor operation returned by the service.
- See Also:
-
updateTrustAnchor
default UpdateTrustAnchorResponse updateTrustAnchor(Consumer<UpdateTrustAnchorRequest.Builder> updateTrustAnchorRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, RolesAnywhereException 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:
- Result of the UpdateTrustAnchor operation returned by the service.
- See Also:
-
create
Create aRolesAnywhereClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRolesAnywhereClient
. -
serviceMetadata
-
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
-