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 String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic MpaClientBuilder
builder()
Create a builder that can be used to configure and create aMpaClient
.default CancelSessionResponse
cancelSession
(Consumer<CancelSessionRequest.Builder> cancelSessionRequest) Cancels an approval session.default CancelSessionResponse
cancelSession
(CancelSessionRequest cancelSessionRequest) Cancels an approval session.static MpaClient
create()
Create aMpaClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateApprovalTeamResponse
createApprovalTeam
(Consumer<CreateApprovalTeamRequest.Builder> createApprovalTeamRequest) Creates a new approval team.default CreateApprovalTeamResponse
createApprovalTeam
(CreateApprovalTeamRequest createApprovalTeamRequest) Creates a new approval team.default CreateIdentitySourceResponse
createIdentitySource
(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) Creates a new identity source.default CreateIdentitySourceResponse
createIdentitySource
(CreateIdentitySourceRequest createIdentitySourceRequest) Creates a new identity source.default DeleteIdentitySourceResponse
deleteIdentitySource
(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) Deletes an identity source.default DeleteIdentitySourceResponse
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 GetApprovalTeamResponse
getApprovalTeam
(Consumer<GetApprovalTeamRequest.Builder> getApprovalTeamRequest) Returns details for an approval team.default GetApprovalTeamResponse
getApprovalTeam
(GetApprovalTeamRequest getApprovalTeamRequest) Returns details for an approval team.default GetIdentitySourceResponse
getIdentitySource
(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) Returns details for an identity source.default GetIdentitySourceResponse
getIdentitySource
(GetIdentitySourceRequest getIdentitySourceRequest) Returns details for an identity source.default GetPolicyVersionResponse
getPolicyVersion
(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Returns details for the version of a policy.default GetPolicyVersionResponse
getPolicyVersion
(GetPolicyVersionRequest getPolicyVersionRequest) Returns details for the version of a policy.default GetResourcePolicyResponse
getResourcePolicy
(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Returns details about a policy for a resource.default GetResourcePolicyResponse
getResourcePolicy
(GetResourcePolicyRequest getResourcePolicyRequest) Returns details about a policy for a resource.default GetSessionResponse
getSession
(Consumer<GetSessionRequest.Builder> getSessionRequest) Returns details for an approval session.default GetSessionResponse
getSession
(GetSessionRequest getSessionRequest) Returns details for an approval session.default ListApprovalTeamsResponse
listApprovalTeams
(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) Returns a list of approval teams.default ListApprovalTeamsResponse
listApprovalTeams
(ListApprovalTeamsRequest listApprovalTeamsRequest) Returns a list of approval teams.default ListApprovalTeamsIterable
listApprovalTeamsPaginator
(Consumer<ListApprovalTeamsRequest.Builder> listApprovalTeamsRequest) This is a variant oflistApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
operation.default ListApprovalTeamsIterable
listApprovalTeamsPaginator
(ListApprovalTeamsRequest listApprovalTeamsRequest) This is a variant oflistApprovalTeams(software.amazon.awssdk.services.mpa.model.ListApprovalTeamsRequest)
operation.default ListIdentitySourcesResponse
listIdentitySources
(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) Returns a list of identity sources.default ListIdentitySourcesResponse
listIdentitySources
(ListIdentitySourcesRequest listIdentitySourcesRequest) Returns a list of identity sources.default ListIdentitySourcesIterable
listIdentitySourcesPaginator
(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
operation.default ListIdentitySourcesIterable
listIdentitySourcesPaginator
(ListIdentitySourcesRequest listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.mpa.model.ListIdentitySourcesRequest)
operation.default ListPoliciesResponse
listPolicies
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns a list of policies.default ListPoliciesResponse
listPolicies
(ListPoliciesRequest listPoliciesRequest) Returns a list of policies.default ListPoliciesIterable
listPoliciesPaginator
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation.default ListPoliciesIterable
listPoliciesPaginator
(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.mpa.model.ListPoliciesRequest)
operation.default ListPolicyVersionsResponse
listPolicyVersions
(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) Returns a list of the versions for policies.default ListPolicyVersionsResponse
listPolicyVersions
(ListPolicyVersionsRequest listPolicyVersionsRequest) Returns a list of the versions for policies.default ListPolicyVersionsIterable
listPolicyVersionsPaginator
(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation.default ListPolicyVersionsIterable
listPolicyVersionsPaginator
(ListPolicyVersionsRequest listPolicyVersionsRequest) This is a variant oflistPolicyVersions(software.amazon.awssdk.services.mpa.model.ListPolicyVersionsRequest)
operation.default ListResourcePoliciesResponse
listResourcePolicies
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns a list of policies for a resource.default ListResourcePoliciesResponse
listResourcePolicies
(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns a list of policies for a resource.default ListResourcePoliciesIterable
listResourcePoliciesPaginator
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
operation.default ListResourcePoliciesIterable
listResourcePoliciesPaginator
(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.mpa.model.ListResourcePoliciesRequest)
operation.default ListSessionsResponse
listSessions
(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Returns a list of approval sessions.default ListSessionsResponse
listSessions
(ListSessionsRequest listSessionsRequest) Returns a list of approval sessions.default ListSessionsIterable
listSessionsPaginator
(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
operation.default ListSessionsIterable
listSessionsPaginator
(ListSessionsRequest listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.mpa.model.ListSessionsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of the tags for a resource.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
startActiveApprovalTeamDeletion
(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 TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates or updates a resource tag.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Creates or updates a resource tag.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a resource tag.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a resource tag.default UpdateApprovalTeamResponse
updateApprovalTeam
(Consumer<UpdateApprovalTeamRequest.Builder> updateApprovalTeamRequest) Updates an approval team.default UpdateApprovalTeamResponse
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 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.Builder
avoiding the need to create one manually viaCancelSessionRequest.builder()
- Parameters:
cancelSessionRequest
- AConsumer
that will call methods onCancelSessionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateApprovalTeamRequest.builder()
- Parameters:
createApprovalTeamRequest
- AConsumer
that will call methods onCreateApprovalTeamRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateIdentitySourceRequest.builder()
- Parameters:
createIdentitySourceRequest
- AConsumer
that will call methods onCreateIdentitySourceRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteIdentitySourceRequest.builder()
- Parameters:
deleteIdentitySourceRequest
- AConsumer
that will call methods onDeleteIdentitySourceRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteInactiveApprovalTeamVersionRequest.builder()
- Parameters:
deleteInactiveApprovalTeamVersionRequest
- AConsumer
that will call methods onDeleteInactiveApprovalTeamVersionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetApprovalTeamRequest.builder()
- Parameters:
getApprovalTeamRequest
- AConsumer
that will call methods onGetApprovalTeamRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetIdentitySourceRequest.builder()
- Parameters:
getIdentitySourceRequest
- AConsumer
that will call methods onGetIdentitySourceRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetPolicyVersionRequest.builder()
- Parameters:
getPolicyVersionRequest
- AConsumer
that will call methods onGetPolicyVersionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetSessionRequest.builder()
- Parameters:
getSessionRequest
- AConsumer
that will call methods onGetSessionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListApprovalTeamsRequest.builder()
- Parameters:
listApprovalTeamsRequest
- AConsumer
that will call methods onListApprovalTeamsRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.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 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.Builder
avoiding the need to create one manually viaListIdentitySourcesRequest.builder()
- Parameters:
listIdentitySourcesRequest
- AConsumer
that will call methods onListIdentitySourcesRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.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 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.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.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 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.Builder
avoiding the need to create one manually viaListPolicyVersionsRequest.builder()
- Parameters:
listPolicyVersionsRequest
- AConsumer
that will call methods onListPolicyVersionsRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.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 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.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.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 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.Builder
avoiding the need to create one manually viaListSessionsRequest.builder()
- Parameters:
listSessionsRequest
- AConsumer
that will call methods onListSessionsRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.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 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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.Builder
avoiding the need to create one manually viaStartActiveApprovalTeamDeletionRequest.builder()
- Parameters:
startActiveApprovalTeamDeletionRequest
- AConsumer
that will call methods onStartActiveApprovalTeamDeletionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws 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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateApprovalTeamRequest.builder()
- Parameters:
updateApprovalTeamRequest
- AConsumer
that will call methods onUpdateApprovalTeamRequest.Builder
to create a request.- Returns:
- Result of the UpdateApprovalTeam operation returned by the service.
- See Also:
-
create
Create aMpaClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMpaClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-