Interface MpaAsyncClient
- 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.
Multi-party approval is a capability of Organizations that allows you to protect a predefined list of operations through a distributed approval process. Use Multi-party approval to establish approval workflows and transform security processes into team-based decisions.
When to use Multi-party approval:
-
You need to align with the Zero Trust principle of "never trust, always verify"
-
You need to make sure that the right humans have access to the right things in the right way
-
You need distributed decision-making for sensitive or critical operations
-
You need to protect against unintended operations on sensitive or critical resources
-
You need formal reviews and approvals for auditing or compliance reasons
For more information, see What is Multi-party approval in the Multi-party approval 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 TypeMethodDescriptionstatic MpaAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aMpaAsyncClient
.default CompletableFuture
<CancelSessionResponse> cancelSession
(Consumer<CancelSessionRequest.Builder> cancelSessionRequest) Cancels an approval session.default CompletableFuture
<CancelSessionResponse> cancelSession
(CancelSessionRequest cancelSessionRequest) Cancels an approval session.static MpaAsyncClient
create()
Create aMpaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createApprovalTeam
(Consumer<CreateApprovalTeamRequest.Builder> createApprovalTeamRequest) Creates a new approval team.createApprovalTeam
(CreateApprovalTeamRequest createApprovalTeamRequest) Creates a new approval team.createIdentitySource
(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) Creates a new identity source.createIdentitySource
(CreateIdentitySourceRequest createIdentitySourceRequest) Creates a new identity source.deleteIdentitySource
(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) Deletes an identity source.deleteIdentitySource
(DeleteIdentitySourceRequest deleteIdentitySourceRequest) Deletes an identity source.deleteInactiveApprovalTeamVersion
(Consumer<DeleteInactiveApprovalTeamVersionRequest.Builder> deleteInactiveApprovalTeamVersionRequest) Deletes an inactive approval team.deleteInactiveApprovalTeamVersion
(DeleteInactiveApprovalTeamVersionRequest deleteInactiveApprovalTeamVersionRequest) Deletes an inactive approval team.default CompletableFuture
<GetApprovalTeamResponse> getApprovalTeam
(Consumer<GetApprovalTeamRequest.Builder> getApprovalTeamRequest) Returns details for an approval team.default CompletableFuture
<GetApprovalTeamResponse> getApprovalTeam
(GetApprovalTeamRequest getApprovalTeamRequest) Returns details for an approval team.getIdentitySource
(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) Returns details for an identity source.getIdentitySource
(GetIdentitySourceRequest getIdentitySourceRequest) Returns details for an identity source.getPolicyVersion
(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Returns details for the version of a policy.getPolicyVersion
(GetPolicyVersionRequest getPolicyVersionRequest) Returns details for the version of a policy.getResourcePolicy
(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Returns details about a policy for a resource.getResourcePolicy
(GetResourcePolicyRequest getResourcePolicyRequest) Returns details about a policy for a resource.default CompletableFuture
<GetSessionResponse> getSession
(Consumer<GetSessionRequest.Builder> getSessionRequest) Returns details for an approval session.default CompletableFuture
<GetSessionResponse> getSession
(GetSessionRequest getSessionRequest) Returns details for an approval session.listApprovalTeams
(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) Returns a list of approval teams.listApprovalTeams
(ListApprovalTeamsRequest listApprovalTeamsRequest) Returns a list of approval teams.default ListApprovalTeamsPublisher
listApprovalTeamsPaginator
(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) This is a variant oflistApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
operation.default ListApprovalTeamsPublisher
listApprovalTeamsPaginator
(ListApprovalTeamsRequest listApprovalTeamsRequest) This is a variant oflistApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
operation.listIdentitySources
(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) Returns a list of identity sources.listIdentitySources
(ListIdentitySourcesRequest listIdentitySourcesRequest) Returns a list of identity sources.default ListIdentitySourcesPublisher
listIdentitySourcesPaginator
(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
operation.default ListIdentitySourcesPublisher
listIdentitySourcesPaginator
(ListIdentitySourcesRequest listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
operation.default CompletableFuture
<ListPoliciesResponse> listPolicies
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns a list of policies.default CompletableFuture
<ListPoliciesResponse> listPolicies
(ListPoliciesRequest listPoliciesRequest) Returns a list of policies.default ListPoliciesPublisher
listPoliciesPaginator
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation.default ListPoliciesPublisher
listPoliciesPaginator
(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation.listPolicyVersions
(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) Returns a list of the versions for policies.listPolicyVersions
(ListPolicyVersionsRequest listPolicyVersionsRequest) Returns a list of the versions for policies.default ListPolicyVersionsPublisher
listPolicyVersionsPaginator
(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation.default ListPolicyVersionsPublisher
listPolicyVersionsPaginator
(ListPolicyVersionsRequest listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation.listResourcePolicies
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns a list of policies for a resource.listResourcePolicies
(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns a list of policies for a resource.default ListResourcePoliciesPublisher
listResourcePoliciesPaginator
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
operation.default ListResourcePoliciesPublisher
listResourcePoliciesPaginator
(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
operation.default CompletableFuture
<ListSessionsResponse> listSessions
(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Returns a list of approval sessions.default CompletableFuture
<ListSessionsResponse> listSessions
(ListSessionsRequest listSessionsRequest) Returns a list of approval sessions.default ListSessionsPublisher
listSessionsPaginator
(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
operation.default ListSessionsPublisher
listSessionsPaginator
(ListSessionsRequest listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of the tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags for a resource.default MpaServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartActiveApprovalTeamDeletion
(Consumer<StartActiveApprovalTeamDeletionRequest.Builder> startActiveApprovalTeamDeletionRequest) Starts the deletion process for an active approval team.startActiveApprovalTeamDeletion
(StartActiveApprovalTeamDeletionRequest startActiveApprovalTeamDeletionRequest) Starts the deletion process for an active approval team.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates or updates a resource tag.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Creates or updates a resource tag.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a resource tag.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a resource tag.updateApprovalTeam
(Consumer<UpdateApprovalTeamRequest.Builder> updateApprovalTeamRequest) Updates an approval team.updateApprovalTeam
(UpdateApprovalTeamRequest updateApprovalTeamRequest) Updates an approval team.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
-
cancelSession
default CompletableFuture<CancelSessionResponse> cancelSession(CancelSessionRequest cancelSessionRequest) Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.
- Parameters:
cancelSessionRequest
-- Returns:
- A Java Future containing the result of the CancelSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelSession
default CompletableFuture<CancelSessionResponse> cancelSession(Consumer<CancelSessionRequest.Builder> cancelSessionRequest) Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
CancelSessionRequest.Builder
avoiding the need to create one manually viaCancelSessionRequest.builder()
- Parameters:
cancelSessionRequest
- AConsumer
that will call methods onCancelSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApprovalTeam
default CompletableFuture<CreateApprovalTeamResponse> createApprovalTeam(CreateApprovalTeamRequest createApprovalTeamRequest) Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.
- Parameters:
createApprovalTeamRequest
-- Returns:
- A Java Future containing the result of the CreateApprovalTeam operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApprovalTeam
default CompletableFuture<CreateApprovalTeamResponse> createApprovalTeam(Consumer<CreateApprovalTeamRequest.Builder> createApprovalTeamRequest) Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
CreateApprovalTeamRequest.Builder
avoiding the need to create one manually viaCreateApprovalTeamRequest.builder()
- Parameters:
createApprovalTeamRequest
- AConsumer
that will call methods onCreateApprovalTeamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApprovalTeam operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIdentitySource
default CompletableFuture<CreateIdentitySourceResponse> createIdentitySource(CreateIdentitySourceRequest createIdentitySourceRequest) Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
createIdentitySourceRequest
-- Returns:
- A Java Future containing the result of the CreateIdentitySource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIdentitySource
default CompletableFuture<CreateIdentitySourceResponse> createIdentitySource(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
CreateIdentitySourceRequest.Builder
avoiding the need to create one manually viaCreateIdentitySourceRequest.builder()
- Parameters:
createIdentitySourceRequest
- AConsumer
that will call methods onCreateIdentitySourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateIdentitySource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentitySource
default CompletableFuture<DeleteIdentitySourceResponse> deleteIdentitySource(DeleteIdentitySourceRequest deleteIdentitySourceRequest) Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
deleteIdentitySourceRequest
-- Returns:
- A Java Future containing the result of the DeleteIdentitySource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentitySource
default CompletableFuture<DeleteIdentitySourceResponse> deleteIdentitySource(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
DeleteIdentitySourceRequest.Builder
avoiding the need to create one manually viaDeleteIdentitySourceRequest.builder()
- Parameters:
deleteIdentitySourceRequest
- AConsumer
that will call methods onDeleteIdentitySourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIdentitySource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInactiveApprovalTeamVersion
default CompletableFuture<DeleteInactiveApprovalTeamVersionResponse> deleteInactiveApprovalTeamVersion(DeleteInactiveApprovalTeamVersionRequest deleteInactiveApprovalTeamVersionRequest) Deletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide.
You can also use this operation to delete a team draft. For more information, see Interacting with drafts in the Multi-party approval User Guide.
- Parameters:
deleteInactiveApprovalTeamVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteInactiveApprovalTeamVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInactiveApprovalTeamVersion
default CompletableFuture<DeleteInactiveApprovalTeamVersionResponse> deleteInactiveApprovalTeamVersion(Consumer<DeleteInactiveApprovalTeamVersionRequest.Builder> deleteInactiveApprovalTeamVersionRequest) Deletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide.
You can also use this operation to delete a team draft. For more information, see Interacting with drafts in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
DeleteInactiveApprovalTeamVersionRequest.Builder
avoiding the need to create one manually viaDeleteInactiveApprovalTeamVersionRequest.builder()
- Parameters:
deleteInactiveApprovalTeamVersionRequest
- AConsumer
that will call methods onDeleteInactiveApprovalTeamVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInactiveApprovalTeamVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApprovalTeam
default CompletableFuture<GetApprovalTeamResponse> getApprovalTeam(GetApprovalTeamRequest getApprovalTeamRequest) Returns details for an approval team.
- Parameters:
getApprovalTeamRequest
-- Returns:
- A Java Future containing the result of the GetApprovalTeam operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApprovalTeam
default CompletableFuture<GetApprovalTeamResponse> getApprovalTeam(Consumer<GetApprovalTeamRequest.Builder> getApprovalTeamRequest) Returns details for an approval team.
This is a convenience which creates an instance of the
GetApprovalTeamRequest.Builder
avoiding the need to create one manually viaGetApprovalTeamRequest.builder()
- Parameters:
getApprovalTeamRequest
- AConsumer
that will call methods onGetApprovalTeamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApprovalTeam operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentitySource
default CompletableFuture<GetIdentitySourceResponse> getIdentitySource(GetIdentitySourceRequest getIdentitySourceRequest) Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
getIdentitySourceRequest
-- Returns:
- A Java Future containing the result of the GetIdentitySource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentitySource
default CompletableFuture<GetIdentitySourceResponse> getIdentitySource(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
GetIdentitySourceRequest.Builder
avoiding the need to create one manually viaGetIdentitySourceRequest.builder()
- Parameters:
getIdentitySourceRequest
- AConsumer
that will call methods onGetIdentitySourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIdentitySource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPolicyVersion
default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) Returns details for the version of a policy. Policies define the permissions for team resources.
The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Parameters:
getPolicyVersionRequest
-- Returns:
- A Java Future containing the result of the GetPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPolicyVersion
default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Returns details for the version of a policy. Policies define the permissions for team resources.
The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
GetPolicyVersionRequest.Builder
avoiding the need to create one manually viaGetPolicyVersionRequest.builder()
- Parameters:
getPolicyVersionRequest
- AConsumer
that will call methods onGetPolicyVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Returns details about a policy for a resource.
- Parameters:
getResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InvalidParameterException The request contains an invalid parameter value.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Returns details about a policy for a resource.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builder
avoiding the need to create one manually viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InvalidParameterException The request contains an invalid parameter value.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSession
Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.
- Parameters:
getSessionRequest
-- Returns:
- A Java Future containing the result of the GetSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSession
default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
GetSessionRequest.Builder
avoiding the need to create one manually viaGetSessionRequest.builder()
- Parameters:
getSessionRequest
- AConsumer
that will call methods onGetSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApprovalTeams
default CompletableFuture<ListApprovalTeamsResponse> listApprovalTeams(ListApprovalTeamsRequest listApprovalTeamsRequest) Returns a list of approval teams.
- Parameters:
listApprovalTeamsRequest
-- Returns:
- A Java Future containing the result of the ListApprovalTeams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApprovalTeams
default CompletableFuture<ListApprovalTeamsResponse> listApprovalTeams(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) Returns a list of approval teams.
This is a convenience which creates an instance of the
ListApprovalTeamsRequest.Builder
avoiding the need to create one manually viaListApprovalTeamsRequest.builder()
- Parameters:
listApprovalTeamsRequest
- AConsumer
that will call methods onListApprovalTeamsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApprovalTeams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApprovalTeamsPaginator
default ListApprovalTeamsPublisher listApprovalTeamsPaginator(ListApprovalTeamsRequest listApprovalTeamsRequest) This is a variant of
listApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
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.mpa.paginators.ListApprovalTeamsPublisher publisher = client.listApprovalTeamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsPublisher publisher = client.listApprovalTeamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListApprovalTeamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
operation.- Parameters:
listApprovalTeamsRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApprovalTeamsPaginator
default ListApprovalTeamsPublisher listApprovalTeamsPaginator(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) This is a variant of
listApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
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.mpa.paginators.ListApprovalTeamsPublisher publisher = client.listApprovalTeamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsPublisher publisher = client.listApprovalTeamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListApprovalTeamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
operation.
This is a convenience which creates an instance of the
ListApprovalTeamsRequest.Builder
avoiding the need to create one manually viaListApprovalTeamsRequest.builder()
- Parameters:
listApprovalTeamsRequest
- AConsumer
that will call methods onListApprovalTeamsRequest.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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitySources
default CompletableFuture<ListIdentitySourcesResponse> listIdentitySources(ListIdentitySourcesRequest listIdentitySourcesRequest) Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
listIdentitySourcesRequest
-- Returns:
- A Java Future containing the result of the ListIdentitySources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitySources
default CompletableFuture<ListIdentitySourcesResponse> listIdentitySources(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
ListIdentitySourcesRequest.Builder
avoiding the need to create one manually viaListIdentitySourcesRequest.builder()
- Parameters:
listIdentitySourcesRequest
- AConsumer
that will call methods onListIdentitySourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIdentitySources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitySourcesPaginator
default ListIdentitySourcesPublisher listIdentitySourcesPaginator(ListIdentitySourcesRequest listIdentitySourcesRequest) This is a variant of
listIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
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.mpa.paginators.ListIdentitySourcesPublisher publisher = client.listIdentitySourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesPublisher publisher = client.listIdentitySourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListIdentitySourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
operation.- Parameters:
listIdentitySourcesRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitySourcesPaginator
default ListIdentitySourcesPublisher listIdentitySourcesPaginator(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) This is a variant of
listIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
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.mpa.paginators.ListIdentitySourcesPublisher publisher = client.listIdentitySourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesPublisher publisher = client.listIdentitySourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListIdentitySourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
operation.
This is a convenience which creates an instance of the
ListIdentitySourcesRequest.Builder
avoiding the need to create one manually viaListIdentitySourcesRequest.builder()
- Parameters:
listIdentitySourcesRequest
- AConsumer
that will call methods onListIdentitySourcesRequest.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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicies
default CompletableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest listPoliciesRequest) Returns a list of policies. Policies define the permissions for team resources.
The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Parameters:
listPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicies
default CompletableFuture<ListPoliciesResponse> listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns a list of policies. Policies define the permissions for team resources.
The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoliciesPaginator
This is a variant of
listPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mpa.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListPoliciesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation.- Parameters:
listPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoliciesPaginator
default ListPoliciesPublisher listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant of
listPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mpa.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListPoliciesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyVersions
default CompletableFuture<ListPolicyVersionsResponse> listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) Returns a list of the versions for policies. Policies define the permissions for team resources.
The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Parameters:
listPolicyVersionsRequest
-- Returns:
- A Java Future containing the result of the ListPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyVersions
default CompletableFuture<ListPolicyVersionsResponse> listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) Returns a list of the versions for policies. Policies define the permissions for team resources.
The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
ListPolicyVersionsRequest.Builder
avoiding the need to create one manually viaListPolicyVersionsRequest.builder()
- Parameters:
listPolicyVersionsRequest
- AConsumer
that will call methods onListPolicyVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyVersionsPaginator
default ListPolicyVersionsPublisher listPolicyVersionsPaginator(ListPolicyVersionsRequest listPolicyVersionsRequest) This is a variant of
listPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListPolicyVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation.- Parameters:
listPolicyVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyVersionsPaginator
default ListPolicyVersionsPublisher listPolicyVersionsPaginator(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) This is a variant of
listPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsPublisher publisher = client.listPolicyVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListPolicyVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListPolicyVersionsRequest.Builder
avoiding the need to create one manually viaListPolicyVersionsRequest.builder()
- Parameters:
listPolicyVersionsRequest
- AConsumer
that will call methods onListPolicyVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePolicies
default CompletableFuture<ListResourcePoliciesResponse> listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns a list of policies for a resource.
- Parameters:
listResourcePoliciesRequest
-- Returns:
- A Java Future containing the result of the ListResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePolicies
default CompletableFuture<ListResourcePoliciesResponse> listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns a list of policies for a resource.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesPublisher listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant of
listResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
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.mpa.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
operation.- Parameters:
listResourcePoliciesRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesPublisher listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant of
listResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
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.mpa.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessions
default CompletableFuture<ListSessionsResponse> listSessions(ListSessionsRequest listSessionsRequest) Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.
- Parameters:
listSessionsRequest
-- Returns:
- A Java Future containing the result of the ListSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessions
default CompletableFuture<ListSessionsResponse> listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.
This is a convenience which creates an instance of the
ListSessionsRequest.Builder
avoiding the need to create one manually viaListSessionsRequest.builder()
- Parameters:
listSessionsRequest
- AConsumer
that will call methods onListSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessionsPaginator
This is a variant of
listSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
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.mpa.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListSessionsResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
operation.- Parameters:
listSessionsRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessionsPaginator
default ListSessionsPublisher listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant of
listSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
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.mpa.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mpa.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mpa.model.ListSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mpa.model.ListSessionsResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
operation.
This is a convenience which creates an instance of the
ListSessionsRequest.Builder
avoiding the need to create one manually viaListSessionsRequest.builder()
- Parameters:
listSessionsRequest
- AConsumer
that will call methods onListSessionsRequest.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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException 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) Returns a list of the tags for a resource.
- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException 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) Returns a list of the tags for a resource.
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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startActiveApprovalTeamDeletion
default CompletableFuture<StartActiveApprovalTeamDeletionResponse> startActiveApprovalTeamDeletion(StartActiveApprovalTeamDeletionRequest startActiveApprovalTeamDeletionRequest) Starts the deletion process for an active approval team.
Deletions require team approval
Requests to delete an active team must be approved by the team.
- Parameters:
startActiveApprovalTeamDeletionRequest
-- Returns:
- A Java Future containing the result of the StartActiveApprovalTeamDeletion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startActiveApprovalTeamDeletion
default CompletableFuture<StartActiveApprovalTeamDeletionResponse> startActiveApprovalTeamDeletion(Consumer<StartActiveApprovalTeamDeletionRequest.Builder> startActiveApprovalTeamDeletionRequest) Starts the deletion process for an active approval team.
Deletions require team approval
Requests to delete an active team must be approved by the team.
This is a convenience which creates an instance of the
StartActiveApprovalTeamDeletionRequest.Builder
avoiding the need to create one manually viaStartActiveApprovalTeamDeletionRequest.builder()
- Parameters:
startActiveApprovalTeamDeletionRequest
- AConsumer
that will call methods onStartActiveApprovalTeamDeletionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartActiveApprovalTeamDeletion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Creates or updates a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- TooManyTagsException The request exceeds the maximum number of tags allowed for this resource. Remove some tags, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException 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) Creates or updates a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- TooManyTagsException The request exceeds the maximum number of tags allowed for this resource. Remove some tags, and try again.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException 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 a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- 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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException 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 a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
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.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApprovalTeam
default CompletableFuture<UpdateApprovalTeamResponse> updateApprovalTeam(UpdateApprovalTeamRequest updateApprovalTeamRequest) Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.
Updates require team approval
Updates to an active team must be approved by the team.
- Parameters:
updateApprovalTeamRequest
-- Returns:
- A Java Future containing the result of the UpdateApprovalTeam operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApprovalTeam
default CompletableFuture<UpdateApprovalTeamResponse> updateApprovalTeam(Consumer<UpdateApprovalTeamRequest.Builder> updateApprovalTeamRequest) Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.
Updates require team approval
Updates to an active team must be approved by the team.
This is a convenience which creates an instance of the
UpdateApprovalTeamRequest.Builder
avoiding the need to create one manually viaUpdateApprovalTeamRequest.builder()
- Parameters:
updateApprovalTeamRequest
- AConsumer
that will call methods onUpdateApprovalTeamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApprovalTeam operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action. Check your permissions, and try again.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource doesn't exist. Check the resource ID, and try again.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
- InternalServerException The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
- ConflictException The request cannot be completed because it conflicts with the current state of a resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MpaException 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 aMpaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMpaAsyncClient
.
-