mpa/aws.sdk.kotlin.services.mpa

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

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.

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.

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.

listPolicies

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

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

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.

listResourcePolicies

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

Returns a list of policies for a resource.

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.

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.