mpa/aws.sdk.kotlin.services.mpa/MpaClient

MpaClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<MpaClient.Config, MpaClient.Config.Builder, MpaClient>

Companion

object Companion : AbstractAwsSdkClientFactory<MpaClient.Config, MpaClient.Config.Builder, MpaClient, MpaClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: MpaClient.Config

MpaClient's configuration

Functions

cancelSession

abstract suspend fun cancelSession(input: CancelSessionRequest): CancelSessionResponse

Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.

createApprovalTeam

abstract suspend fun createApprovalTeam(input: CreateApprovalTeamRequest): CreateApprovalTeamResponse

Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.

createIdentitySource

abstract suspend fun createIdentitySource(input: CreateIdentitySourceRequest): CreateIdentitySourceResponse

Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.

deleteIdentitySource

abstract suspend fun deleteIdentitySource(input: DeleteIdentitySourceRequest): DeleteIdentitySourceResponse

Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

deleteInactiveApprovalTeamVersion

abstract suspend fun deleteInactiveApprovalTeamVersion(input: DeleteInactiveApprovalTeamVersionRequest): DeleteInactiveApprovalTeamVersionResponse

Deletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide.

getApprovalTeam

abstract suspend fun getApprovalTeam(input: GetApprovalTeamRequest): GetApprovalTeamResponse

Returns details for an approval team.

getIdentitySource

abstract suspend fun getIdentitySource(input: GetIdentitySourceRequest): GetIdentitySourceResponse

Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

getPolicyVersion

abstract suspend fun getPolicyVersion(input: GetPolicyVersionRequest): GetPolicyVersionResponse

Returns details for the version of a policy. Policies define the permissions for team resources.

getResourcePolicy

abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

Returns details about a policy for a resource.

getSession

abstract suspend fun getSession(input: GetSessionRequest): GetSessionResponse

Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.

listApprovalTeams

abstract suspend fun listApprovalTeams(input: ListApprovalTeamsRequest = ListApprovalTeamsRequest { }): ListApprovalTeamsResponse

Returns a list of approval teams.

listIdentitySources

abstract suspend fun listIdentitySources(input: ListIdentitySourcesRequest = ListIdentitySourcesRequest { }): ListIdentitySourcesResponse

Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.

listPolicies

abstract suspend fun listPolicies(input: ListPoliciesRequest = ListPoliciesRequest { }): ListPoliciesResponse

Returns a list of policies. Policies define the permissions for team resources.

listPolicyVersions

abstract suspend fun listPolicyVersions(input: ListPolicyVersionsRequest): ListPolicyVersionsResponse

Returns a list of the versions for policies. Policies define the permissions for team resources.

listResourcePolicies

abstract suspend fun listResourcePolicies(input: ListResourcePoliciesRequest): ListResourcePoliciesResponse

Returns a list of policies for a resource.

listSessions

abstract suspend fun listSessions(input: ListSessionsRequest): ListSessionsResponse

Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns a list of the tags for a resource.

startActiveApprovalTeamDeletion

abstract suspend fun startActiveApprovalTeamDeletion(input: StartActiveApprovalTeamDeletionRequest): StartActiveApprovalTeamDeletionResponse

Starts the deletion process for an active approval team.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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.

updateApprovalTeam

abstract suspend fun updateApprovalTeam(input: UpdateApprovalTeamRequest): UpdateApprovalTeamResponse

Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.

Inherited functions

cancelSession

inline suspend fun MpaClient.cancelSession(crossinline block: CancelSessionRequest.Builder.() -> Unit): CancelSessionResponse

Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.

expect abstract fun close()

createApprovalTeam

inline suspend fun MpaClient.createApprovalTeam(crossinline block: CreateApprovalTeamRequest.Builder.() -> Unit): CreateApprovalTeamResponse

Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.

createIdentitySource

inline suspend fun MpaClient.createIdentitySource(crossinline block: CreateIdentitySourceRequest.Builder.() -> Unit): CreateIdentitySourceResponse

Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.

deleteIdentitySource

inline suspend fun MpaClient.deleteIdentitySource(crossinline block: DeleteIdentitySourceRequest.Builder.() -> Unit): DeleteIdentitySourceResponse

Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

deleteInactiveApprovalTeamVersion

inline suspend fun MpaClient.deleteInactiveApprovalTeamVersion(crossinline block: DeleteInactiveApprovalTeamVersionRequest.Builder.() -> Unit): DeleteInactiveApprovalTeamVersionResponse

Deletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide.

getApprovalTeam

inline suspend fun MpaClient.getApprovalTeam(crossinline block: GetApprovalTeamRequest.Builder.() -> Unit): GetApprovalTeamResponse

Returns details for an approval team.

getIdentitySource

inline suspend fun MpaClient.getIdentitySource(crossinline block: GetIdentitySourceRequest.Builder.() -> Unit): GetIdentitySourceResponse

Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

getPolicyVersion

inline suspend fun MpaClient.getPolicyVersion(crossinline block: GetPolicyVersionRequest.Builder.() -> Unit): GetPolicyVersionResponse

Returns details for the version of a policy. Policies define the permissions for team resources.

getResourcePolicy

inline suspend fun MpaClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Returns details about a policy for a resource.

getSession

inline suspend fun MpaClient.getSession(crossinline block: GetSessionRequest.Builder.() -> Unit): GetSessionResponse

Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.

listApprovalTeams

inline suspend fun MpaClient.listApprovalTeams(crossinline block: ListApprovalTeamsRequest.Builder.() -> Unit): ListApprovalTeamsResponse

Returns a list of approval teams.

listApprovalTeamsPaginated

fun MpaClient.listApprovalTeamsPaginated(initialRequest: ListApprovalTeamsRequest = ListApprovalTeamsRequest { }): Flow<ListApprovalTeamsResponse>

fun MpaClient.listApprovalTeamsPaginated(block: ListApprovalTeamsRequest.Builder.() -> Unit): Flow<ListApprovalTeamsResponse>

Paginate over ListApprovalTeamsResponse results.

listIdentitySources

inline suspend fun MpaClient.listIdentitySources(crossinline block: ListIdentitySourcesRequest.Builder.() -> Unit): ListIdentitySourcesResponse

Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.

listIdentitySourcesPaginated

fun MpaClient.listIdentitySourcesPaginated(initialRequest: ListIdentitySourcesRequest = ListIdentitySourcesRequest { }): Flow<ListIdentitySourcesResponse>

fun MpaClient.listIdentitySourcesPaginated(block: ListIdentitySourcesRequest.Builder.() -> Unit): Flow<ListIdentitySourcesResponse>

Paginate over ListIdentitySourcesResponse results.

listPolicies

inline suspend fun MpaClient.listPolicies(crossinline block: ListPoliciesRequest.Builder.() -> Unit): ListPoliciesResponse

Returns a list of policies. Policies define the permissions for team resources.

listPoliciesPaginated

fun MpaClient.listPoliciesPaginated(initialRequest: ListPoliciesRequest = ListPoliciesRequest { }): Flow<ListPoliciesResponse>

fun MpaClient.listPoliciesPaginated(block: ListPoliciesRequest.Builder.() -> Unit): Flow<ListPoliciesResponse>

Paginate over ListPoliciesResponse results.

listPolicyVersions

inline suspend fun MpaClient.listPolicyVersions(crossinline block: ListPolicyVersionsRequest.Builder.() -> Unit): ListPolicyVersionsResponse

Returns a list of the versions for policies. Policies define the permissions for team resources.

listPolicyVersionsPaginated

fun MpaClient.listPolicyVersionsPaginated(initialRequest: ListPolicyVersionsRequest): Flow<ListPolicyVersionsResponse>

fun MpaClient.listPolicyVersionsPaginated(block: ListPolicyVersionsRequest.Builder.() -> Unit): Flow<ListPolicyVersionsResponse>

Paginate over ListPolicyVersionsResponse results.

listResourcePolicies

inline suspend fun MpaClient.listResourcePolicies(crossinline block: ListResourcePoliciesRequest.Builder.() -> Unit): ListResourcePoliciesResponse

Returns a list of policies for a resource.

listResourcePoliciesPaginated

fun MpaClient.listResourcePoliciesPaginated(initialRequest: ListResourcePoliciesRequest): Flow<ListResourcePoliciesResponse>

fun MpaClient.listResourcePoliciesPaginated(block: ListResourcePoliciesRequest.Builder.() -> Unit): Flow<ListResourcePoliciesResponse>

Paginate over ListResourcePoliciesResponse results.

listSessions

inline suspend fun MpaClient.listSessions(crossinline block: ListSessionsRequest.Builder.() -> Unit): ListSessionsResponse

Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.

listSessionsPaginated

fun MpaClient.listSessionsPaginated(initialRequest: ListSessionsRequest): Flow<ListSessionsResponse>

fun MpaClient.listSessionsPaginated(block: ListSessionsRequest.Builder.() -> Unit): Flow<ListSessionsResponse>

Paginate over ListSessionsResponse results.

listTagsForResource

inline suspend fun MpaClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of the tags for a resource.

startActiveApprovalTeamDeletion

inline suspend fun MpaClient.startActiveApprovalTeamDeletion(crossinline block: StartActiveApprovalTeamDeletionRequest.Builder.() -> Unit): StartActiveApprovalTeamDeletionResponse

Starts the deletion process for an active approval team.

tagResource

inline suspend fun MpaClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun MpaClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

updateApprovalTeam

inline suspend fun MpaClient.updateApprovalTeam(crossinline block: UpdateApprovalTeamRequest.Builder.() -> Unit): UpdateApprovalTeamResponse

Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.

withConfig

fun MpaClient.withConfig(block: MpaClient.Config.Builder.() -> Unit): MpaClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.