Interface MpaClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
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 StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic MpaClientBuilderbuilder()Create a builder that can be used to configure and create aMpaClient.default CancelSessionResponsecancelSession(Consumer<CancelSessionRequest.Builder> cancelSessionRequest) Cancels an approval session.default CancelSessionResponsecancelSession(CancelSessionRequest cancelSessionRequest) Cancels an approval session.static MpaClientcreate()Create aMpaClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateApprovalTeamResponsecreateApprovalTeam(Consumer<CreateApprovalTeamRequest.Builder> createApprovalTeamRequest) Creates a new approval team.default CreateApprovalTeamResponsecreateApprovalTeam(CreateApprovalTeamRequest createApprovalTeamRequest) Creates a new approval team.default CreateIdentitySourceResponsecreateIdentitySource(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) Creates a new identity source.default CreateIdentitySourceResponsecreateIdentitySource(CreateIdentitySourceRequest createIdentitySourceRequest) Creates a new identity source.default DeleteIdentitySourceResponsedeleteIdentitySource(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) Deletes an identity source.default DeleteIdentitySourceResponsedeleteIdentitySource(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 GetApprovalTeamResponsegetApprovalTeam(Consumer<GetApprovalTeamRequest.Builder> getApprovalTeamRequest) Returns details for an approval team.default GetApprovalTeamResponsegetApprovalTeam(GetApprovalTeamRequest getApprovalTeamRequest) Returns details for an approval team.default GetIdentitySourceResponsegetIdentitySource(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) Returns details for an identity source.default GetIdentitySourceResponsegetIdentitySource(GetIdentitySourceRequest getIdentitySourceRequest) Returns details for an identity source.default GetPolicyVersionResponsegetPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Returns details for the version of a policy.default GetPolicyVersionResponsegetPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) Returns details for the version of a policy.default GetResourcePolicyResponsegetResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Returns details about a policy for a resource.default GetResourcePolicyResponsegetResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Returns details about a policy for a resource.default GetSessionResponsegetSession(Consumer<GetSessionRequest.Builder> getSessionRequest) Returns details for an approval session.default GetSessionResponsegetSession(GetSessionRequest getSessionRequest) Returns details for an approval session.default ListApprovalTeamsResponselistApprovalTeams(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) Returns a list of approval teams.default ListApprovalTeamsResponselistApprovalTeams(ListApprovalTeamsRequest listApprovalTeamsRequest) Returns a list of approval teams.default ListApprovalTeamsIterablelistApprovalTeamsPaginator(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) This is a variant oflistApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)operation.default ListApprovalTeamsIterablelistApprovalTeamsPaginator(ListApprovalTeamsRequest listApprovalTeamsRequest) This is a variant oflistApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)operation.default ListIdentitySourcesResponselistIdentitySources(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) Returns a list of identity sources.default ListIdentitySourcesResponselistIdentitySources(ListIdentitySourcesRequest listIdentitySourcesRequest) Returns a list of identity sources.default ListIdentitySourcesIterablelistIdentitySourcesPaginator(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)operation.default ListIdentitySourcesIterablelistIdentitySourcesPaginator(ListIdentitySourcesRequest listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)operation.default ListPoliciesResponselistPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns a list of policies.default ListPoliciesResponselistPolicies(ListPoliciesRequest listPoliciesRequest) Returns a list of policies.default ListPoliciesIterablelistPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)operation.default ListPoliciesIterablelistPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)operation.default ListPolicyVersionsResponselistPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) Returns a list of the versions for policies.default ListPolicyVersionsResponselistPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) Returns a list of the versions for policies.default ListPolicyVersionsIterablelistPolicyVersionsPaginator(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)operation.default ListPolicyVersionsIterablelistPolicyVersionsPaginator(ListPolicyVersionsRequest listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)operation.default ListResourcePoliciesResponselistResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns a list of policies for a resource.default ListResourcePoliciesResponselistResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns a list of policies for a resource.default ListResourcePoliciesIterablelistResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)operation.default ListResourcePoliciesIterablelistResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)operation.default ListSessionsResponselistSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Returns a list of approval sessions.default ListSessionsResponselistSessions(ListSessionsRequest listSessionsRequest) Returns a list of approval sessions.default ListSessionsIterablelistSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)operation.default ListSessionsIterablelistSessionsPaginator(ListSessionsRequest listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of the tags for a resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags for a resource.default MpaServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatastartActiveApprovalTeamDeletion(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 TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates or updates a resource tag.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Creates or updates a resource tag.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a resource tag.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes a resource tag.default UpdateApprovalTeamResponseupdateApprovalTeam(Consumer<UpdateApprovalTeamRequest.Builder> updateApprovalTeamRequest) Updates an approval team.default UpdateApprovalTeamResponseupdateApprovalTeam(UpdateApprovalTeamRequest updateApprovalTeamRequest) Updates an approval team.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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 CancelSessionResponse cancelSession(CancelSessionRequest cancelSessionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.
- Parameters:
cancelSessionRequest-- Returns:
- Result of the CancelSession operation returned by the service.
- See Also:
-
cancelSession
default CancelSessionResponse cancelSession(Consumer<CancelSessionRequest.Builder> cancelSessionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaCancelSessionRequest.builder()- Parameters:
cancelSessionRequest- AConsumerthat will call methods onCancelSessionRequest.Builderto create a request.- Returns:
- Result of the CancelSession operation returned by the service.
- See Also:
-
createApprovalTeam
default CreateApprovalTeamResponse createApprovalTeam(CreateApprovalTeamRequest createApprovalTeamRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.
- Parameters:
createApprovalTeamRequest-- Returns:
- Result of the CreateApprovalTeam operation returned by the service.
- See Also:
-
createApprovalTeam
default CreateApprovalTeamResponse createApprovalTeam(Consumer<CreateApprovalTeamRequest.Builder> createApprovalTeamRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaCreateApprovalTeamRequest.builder()- Parameters:
createApprovalTeamRequest- AConsumerthat will call methods onCreateApprovalTeamRequest.Builderto create a request.- Returns:
- Result of the CreateApprovalTeam operation returned by the service.
- See Also:
-
createIdentitySource
default CreateIdentitySourceResponse createIdentitySource(CreateIdentitySourceRequest createIdentitySourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, MpaException Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
createIdentitySourceRequest-- Returns:
- Result of the CreateIdentitySource operation returned by the service.
- See Also:
-
createIdentitySource
default CreateIdentitySourceResponse createIdentitySource(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaCreateIdentitySourceRequest.builder()- Parameters:
createIdentitySourceRequest- AConsumerthat will call methods onCreateIdentitySourceRequest.Builderto create a request.- Returns:
- Result of the CreateIdentitySource operation returned by the service.
- See Also:
-
deleteIdentitySource
default DeleteIdentitySourceResponse deleteIdentitySource(DeleteIdentitySourceRequest deleteIdentitySourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
deleteIdentitySourceRequest-- Returns:
- Result of the DeleteIdentitySource operation returned by the service.
- See Also:
-
deleteIdentitySource
default DeleteIdentitySourceResponse deleteIdentitySource(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaDeleteIdentitySourceRequest.builder()- Parameters:
deleteIdentitySourceRequest- AConsumerthat will call methods onDeleteIdentitySourceRequest.Builderto create a request.- Returns:
- Result of the DeleteIdentitySource operation returned by the service.
- See Also:
-
deleteInactiveApprovalTeamVersion
default DeleteInactiveApprovalTeamVersionResponse deleteInactiveApprovalTeamVersion(DeleteInactiveApprovalTeamVersionRequest deleteInactiveApprovalTeamVersionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the DeleteInactiveApprovalTeamVersion operation returned by the service.
- See Also:
-
deleteInactiveApprovalTeamVersion
default DeleteInactiveApprovalTeamVersionResponse deleteInactiveApprovalTeamVersion(Consumer<DeleteInactiveApprovalTeamVersionRequest.Builder> deleteInactiveApprovalTeamVersionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaDeleteInactiveApprovalTeamVersionRequest.builder()- Parameters:
deleteInactiveApprovalTeamVersionRequest- AConsumerthat will call methods onDeleteInactiveApprovalTeamVersionRequest.Builderto create a request.- Returns:
- Result of the DeleteInactiveApprovalTeamVersion operation returned by the service.
- See Also:
-
getApprovalTeam
default GetApprovalTeamResponse getApprovalTeam(GetApprovalTeamRequest getApprovalTeamRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns details for an approval team.
- Parameters:
getApprovalTeamRequest-- Returns:
- Result of the GetApprovalTeam operation returned by the service.
- See Also:
-
getApprovalTeam
default GetApprovalTeamResponse getApprovalTeam(Consumer<GetApprovalTeamRequest.Builder> getApprovalTeamRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns details for an approval team.
This is a convenience which creates an instance of the
GetApprovalTeamRequest.Builderavoiding the need to create one manually viaGetApprovalTeamRequest.builder()- Parameters:
getApprovalTeamRequest- AConsumerthat will call methods onGetApprovalTeamRequest.Builderto create a request.- Returns:
- Result of the GetApprovalTeam operation returned by the service.
- See Also:
-
getIdentitySource
default GetIdentitySourceResponse getIdentitySource(GetIdentitySourceRequest getIdentitySourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
getIdentitySourceRequest-- Returns:
- Result of the GetIdentitySource operation returned by the service.
- See Also:
-
getIdentitySource
default GetIdentitySourceResponse getIdentitySource(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaGetIdentitySourceRequest.builder()- Parameters:
getIdentitySourceRequest- AConsumerthat will call methods onGetIdentitySourceRequest.Builderto create a request.- Returns:
- Result of the GetIdentitySource operation returned by the service.
- See Also:
-
getPolicyVersion
default GetPolicyVersionResponse getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the GetPolicyVersion operation returned by the service.
- See Also:
-
getPolicyVersion
default GetPolicyVersionResponse getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaGetPolicyVersionRequest.builder()- Parameters:
getPolicyVersionRequest- AConsumerthat will call methods onGetPolicyVersionRequest.Builderto create a request.- Returns:
- Result of the GetPolicyVersion operation returned by the service.
- See Also:
-
getResourcePolicy
default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) throws AccessDeniedException, ValidationException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, MpaException Returns details about a policy for a resource.
- Parameters:
getResourcePolicyRequest-- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- See Also:
-
getResourcePolicy
default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) throws AccessDeniedException, ValidationException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, MpaException Returns details about a policy for a resource.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builderavoiding the need to create one manually viaGetResourcePolicyRequest.builder()- Parameters:
getResourcePolicyRequest- AConsumerthat will call methods onGetResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- See Also:
-
getSession
default GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.
- Parameters:
getSessionRequest-- Returns:
- Result of the GetSession operation returned by the service.
- See Also:
-
getSession
default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaGetSessionRequest.builder()- Parameters:
getSessionRequest- AConsumerthat will call methods onGetSessionRequest.Builderto create a request.- Returns:
- Result of the GetSession operation returned by the service.
- See Also:
-
listApprovalTeams
default ListApprovalTeamsResponse listApprovalTeams(ListApprovalTeamsRequest listApprovalTeamsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of approval teams.
- Parameters:
listApprovalTeamsRequest-- Returns:
- Result of the ListApprovalTeams operation returned by the service.
- See Also:
-
listApprovalTeams
default ListApprovalTeamsResponse listApprovalTeams(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of approval teams.
This is a convenience which creates an instance of the
ListApprovalTeamsRequest.Builderavoiding the need to create one manually viaListApprovalTeamsRequest.builder()- Parameters:
listApprovalTeamsRequest- AConsumerthat will call methods onListApprovalTeamsRequest.Builderto create a request.- Returns:
- Result of the ListApprovalTeams operation returned by the service.
- See Also:
-
listApprovalTeamsPaginator
default ListApprovalTeamsIterable listApprovalTeamsPaginator(ListApprovalTeamsRequest listApprovalTeamsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsIterable responses = client.listApprovalTeamsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsIterable responses = client .listApprovalTeamsPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListApprovalTeamsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsIterable responses = client.listApprovalTeamsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listApprovalTeamsPaginator
default ListApprovalTeamsIterable listApprovalTeamsPaginator(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsIterable responses = client.listApprovalTeamsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsIterable responses = client .listApprovalTeamsPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListApprovalTeamsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListApprovalTeamsIterable responses = client.listApprovalTeamsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListApprovalTeamsRequest.builder()- Parameters:
listApprovalTeamsRequest- AConsumerthat will call methods onListApprovalTeamsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentitySources
default ListIdentitySourcesResponse listIdentitySources(ListIdentitySourcesRequest listIdentitySourcesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.
- Parameters:
listIdentitySourcesRequest-- Returns:
- Result of the ListIdentitySources operation returned by the service.
- See Also:
-
listIdentitySources
default ListIdentitySourcesResponse listIdentitySources(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaListIdentitySourcesRequest.builder()- Parameters:
listIdentitySourcesRequest- AConsumerthat will call methods onListIdentitySourcesRequest.Builderto create a request.- Returns:
- Result of the ListIdentitySources operation returned by the service.
- See Also:
-
listIdentitySourcesPaginator
default ListIdentitySourcesIterable listIdentitySourcesPaginator(ListIdentitySourcesRequest listIdentitySourcesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesIterable responses = client .listIdentitySourcesPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListIdentitySourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentitySourcesPaginator
default ListIdentitySourcesIterable listIdentitySourcesPaginator(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesIterable responses = client .listIdentitySourcesPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListIdentitySourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListIdentitySourcesRequest.builder()- Parameters:
listIdentitySourcesRequest- AConsumerthat will call methods onListIdentitySourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicies
default ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the ListPolicies operation returned by the service.
- See Also:
-
listPolicies
default ListPoliciesResponse listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaListPoliciesRequest.builder()- Parameters:
listPoliciesRequest- AConsumerthat will call methods onListPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListPolicies operation returned by the service.
- See Also:
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPoliciesRequest.builder()- Parameters:
listPoliciesRequest- AConsumerthat will call methods onListPoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyVersions
default ListPolicyVersionsResponse listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the ListPolicyVersions operation returned by the service.
- See Also:
-
listPolicyVersions
default ListPolicyVersionsResponse listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaListPolicyVersionsRequest.builder()- Parameters:
listPolicyVersionsRequest- AConsumerthat will call methods onListPolicyVersionsRequest.Builderto create a request.- Returns:
- Result of the ListPolicyVersions operation returned by the service.
- See Also:
-
listPolicyVersionsPaginator
default ListPolicyVersionsIterable listPolicyVersionsPaginator(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsIterable responses = client .listPolicyVersionsPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListPolicyVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyVersionsPaginator
default ListPolicyVersionsIterable listPolicyVersionsPaginator(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsIterable responses = client .listPolicyVersionsPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListPolicyVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListPolicyVersionsIterable responses = client.listPolicyVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPolicyVersionsRequest.builder()- Parameters:
listPolicyVersionsRequest- AConsumerthat will call methods onListPolicyVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcePolicies
default ListResourcePoliciesResponse listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of policies for a resource.
- Parameters:
listResourcePoliciesRequest-- Returns:
- Result of the ListResourcePolicies operation returned by the service.
- See Also:
-
listResourcePolicies
default ListResourcePoliciesResponse listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of policies for a resource.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builderavoiding the need to create one manually viaListResourcePoliciesRequest.builder()- Parameters:
listResourcePoliciesRequest- AConsumerthat will call methods onListResourcePoliciesRequest.Builderto create a request.- Returns:
- Result of the ListResourcePolicies operation returned by the service.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesIterable listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesIterable responses = client .listResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListResourcePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesIterable listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesIterable responses = client .listResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListResourcePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListResourcePoliciesRequest.builder()- Parameters:
listResourcePoliciesRequest- AConsumerthat will call methods onListResourcePoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSessions
default ListSessionsResponse listSessions(ListSessionsRequest listSessionsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.
- Parameters:
listSessionsRequest-- Returns:
- Result of the ListSessions operation returned by the service.
- See Also:
-
listSessions
default ListSessionsResponse listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaListSessionsRequest.builder()- Parameters:
listSessionsRequest- AConsumerthat will call methods onListSessionsRequest.Builderto create a request.- Returns:
- Result of the ListSessions operation returned by the service.
- See Also:
-
listSessionsPaginator
default ListSessionsIterable listSessionsPaginator(ListSessionsRequest listSessionsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSessionsPaginator
default ListSessionsIterable listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException This is a variant of
listSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.mpa.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.mpa.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); for (software.amazon.awssdk.services.mpa.model.ListSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.mpa.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListSessionsRequest.builder()- Parameters:
listSessionsRequest- AConsumerthat will call methods onListSessionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of the tags for a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException Returns a list of the tags for a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startActiveApprovalTeamDeletion
default StartActiveApprovalTeamDeletionResponse startActiveApprovalTeamDeletion(StartActiveApprovalTeamDeletionRequest startActiveApprovalTeamDeletionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the StartActiveApprovalTeamDeletion operation returned by the service.
- See Also:
-
startActiveApprovalTeamDeletion
default StartActiveApprovalTeamDeletionResponse startActiveApprovalTeamDeletion(Consumer<StartActiveApprovalTeamDeletionRequest.Builder> startActiveApprovalTeamDeletionRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaStartActiveApprovalTeamDeletionRequest.builder()- Parameters:
startActiveApprovalTeamDeletionRequest- AConsumerthat will call methods onStartActiveApprovalTeamDeletionRequest.Builderto create a request.- Returns:
- Result of the StartActiveApprovalTeamDeletion operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApprovalTeam
default UpdateApprovalTeamResponse updateApprovalTeam(UpdateApprovalTeamRequest updateApprovalTeamRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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:
- Result of the UpdateApprovalTeam operation returned by the service.
- See Also:
-
updateApprovalTeam
default UpdateApprovalTeamResponse updateApprovalTeam(Consumer<UpdateApprovalTeamRequest.Builder> updateApprovalTeamRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, MpaException 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.Builderavoiding the need to create one manually viaUpdateApprovalTeamRequest.builder()- Parameters:
updateApprovalTeamRequest- AConsumerthat will call methods onUpdateApprovalTeamRequest.Builderto create a request.- Returns:
- Result of the UpdateApprovalTeam operation returned by the service.
- See Also:
-
create
Create aMpaClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aMpaClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-