Skip to content

MultipartyApprovalClient#

Index > MultipartyApproval > MultipartyApprovalClient

Auto-generated documentation for MultipartyApproval type annotations stubs module types-boto3-mpa.

MultipartyApprovalClient#

Type annotations and code completion for boto3.client("mpa"). boto3 documentation

# MultipartyApprovalClient usage example

from boto3.session import Session
from types_boto3_mpa.client import MultipartyApprovalClient

def get_mpa_client() -> MultipartyApprovalClient:
    return Session().client("mpa")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("mpa").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("mpa")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_mpa.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("mpa").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("mpa").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

cancel_session#

Cancels an approval session.

Type annotations and code completion for boto3.client("mpa").cancel_session method. boto3 documentation

# cancel_session method definition

def cancel_session(
    self,
    *,
    SessionArn: str,
) -> Dict[str, Any]:
    ...
# cancel_session method usage example with argument unpacking

kwargs: CancelSessionRequestTypeDef = {  # (1)
    "SessionArn": ...,
}

parent.cancel_session(**kwargs)
  1. See CancelSessionRequestTypeDef

create_approval_team#

Creates a new approval team.

Type annotations and code completion for boto3.client("mpa").create_approval_team method. boto3 documentation

# create_approval_team method definition

def create_approval_team(
    self,
    *,
    ApprovalStrategy: ApprovalStrategyTypeDef,  # (1)
    Approvers: Sequence[ApprovalTeamRequestApproverTypeDef],  # (2)
    Description: str,
    Policies: Sequence[PolicyReferenceTypeDef],  # (3)
    Name: str,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateApprovalTeamResponseTypeDef:  # (4)
    ...
  1. See ApprovalStrategyTypeDef
  2. See Sequence[ApprovalTeamRequestApproverTypeDef]
  3. See Sequence[PolicyReferenceTypeDef]
  4. See CreateApprovalTeamResponseTypeDef
# create_approval_team method usage example with argument unpacking

kwargs: CreateApprovalTeamRequestTypeDef = {  # (1)
    "ApprovalStrategy": ...,
    "Approvers": ...,
    "Description": ...,
    "Policies": ...,
    "Name": ...,
}

parent.create_approval_team(**kwargs)
  1. See CreateApprovalTeamRequestTypeDef

create_identity_source#

Creates a new identity source.

Type annotations and code completion for boto3.client("mpa").create_identity_source method. boto3 documentation

# create_identity_source method definition

def create_identity_source(
    self,
    *,
    IdentitySourceParameters: IdentitySourceParametersTypeDef,  # (1)
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateIdentitySourceResponseTypeDef:  # (2)
    ...
  1. See IdentitySourceParametersTypeDef
  2. See CreateIdentitySourceResponseTypeDef
# create_identity_source method usage example with argument unpacking

kwargs: CreateIdentitySourceRequestTypeDef = {  # (1)
    "IdentitySourceParameters": ...,
}

parent.create_identity_source(**kwargs)
  1. See CreateIdentitySourceRequestTypeDef

delete_identity_source#

Deletes an identity source.

Type annotations and code completion for boto3.client("mpa").delete_identity_source method. boto3 documentation

# delete_identity_source method definition

def delete_identity_source(
    self,
    *,
    IdentitySourceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_identity_source method usage example with argument unpacking

kwargs: DeleteIdentitySourceRequestTypeDef = {  # (1)
    "IdentitySourceArn": ...,
}

parent.delete_identity_source(**kwargs)
  1. See DeleteIdentitySourceRequestTypeDef

delete_inactive_approval_team_version#

Deletes an inactive approval team.

Type annotations and code completion for boto3.client("mpa").delete_inactive_approval_team_version method. boto3 documentation

# delete_inactive_approval_team_version method definition

def delete_inactive_approval_team_version(
    self,
    *,
    Arn: str,
    VersionId: str,
) -> Dict[str, Any]:
    ...
# delete_inactive_approval_team_version method usage example with argument unpacking

kwargs: DeleteInactiveApprovalTeamVersionRequestTypeDef = {  # (1)
    "Arn": ...,
    "VersionId": ...,
}

parent.delete_inactive_approval_team_version(**kwargs)
  1. See DeleteInactiveApprovalTeamVersionRequestTypeDef

get_approval_team#

Returns details for an approval team.

Type annotations and code completion for boto3.client("mpa").get_approval_team method. boto3 documentation

# get_approval_team method definition

def get_approval_team(
    self,
    *,
    Arn: str,
) -> GetApprovalTeamResponseTypeDef:  # (1)
    ...
  1. See GetApprovalTeamResponseTypeDef
# get_approval_team method usage example with argument unpacking

kwargs: GetApprovalTeamRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.get_approval_team(**kwargs)
  1. See GetApprovalTeamRequestTypeDef

get_identity_source#

Returns details for an identity source.

Type annotations and code completion for boto3.client("mpa").get_identity_source method. boto3 documentation

# get_identity_source method definition

def get_identity_source(
    self,
    *,
    IdentitySourceArn: str,
) -> GetIdentitySourceResponseTypeDef:  # (1)
    ...
  1. See GetIdentitySourceResponseTypeDef
# get_identity_source method usage example with argument unpacking

kwargs: GetIdentitySourceRequestTypeDef = {  # (1)
    "IdentitySourceArn": ...,
}

parent.get_identity_source(**kwargs)
  1. See GetIdentitySourceRequestTypeDef

get_policy_version#

Returns details for the version of a policy.

Type annotations and code completion for boto3.client("mpa").get_policy_version method. boto3 documentation

# get_policy_version method definition

def get_policy_version(
    self,
    *,
    PolicyVersionArn: str,
) -> GetPolicyVersionResponseTypeDef:  # (1)
    ...
  1. See GetPolicyVersionResponseTypeDef
# get_policy_version method usage example with argument unpacking

kwargs: GetPolicyVersionRequestTypeDef = {  # (1)
    "PolicyVersionArn": ...,
}

parent.get_policy_version(**kwargs)
  1. See GetPolicyVersionRequestTypeDef

get_resource_policy#

Returns details about a policy for a resource.

Type annotations and code completion for boto3.client("mpa").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
    PolicyName: str,
    PolicyType: PolicyTypeType,  # (1)
) -> GetResourcePolicyResponseTypeDef:  # (2)
    ...
  1. See PolicyTypeType
  2. See GetResourcePolicyResponseTypeDef
# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "PolicyName": ...,
    "PolicyType": ...,
}

parent.get_resource_policy(**kwargs)
  1. See GetResourcePolicyRequestTypeDef

get_session#

Returns details for an approval session.

Type annotations and code completion for boto3.client("mpa").get_session method. boto3 documentation

# get_session method definition

def get_session(
    self,
    *,
    SessionArn: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...
  1. See GetSessionResponseTypeDef
# get_session method usage example with argument unpacking

kwargs: GetSessionRequestTypeDef = {  # (1)
    "SessionArn": ...,
}

parent.get_session(**kwargs)
  1. See GetSessionRequestTypeDef

list_approval_teams#

Returns a list of approval teams.

Type annotations and code completion for boto3.client("mpa").list_approval_teams method. boto3 documentation

# list_approval_teams method definition

def list_approval_teams(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApprovalTeamsResponseTypeDef:  # (1)
    ...
  1. See ListApprovalTeamsResponseTypeDef
# list_approval_teams method usage example with argument unpacking

kwargs: ListApprovalTeamsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_approval_teams(**kwargs)
  1. See ListApprovalTeamsRequestTypeDef

list_identity_sources#

Returns a list of identity sources.

Type annotations and code completion for boto3.client("mpa").list_identity_sources method. boto3 documentation

# list_identity_sources method definition

def list_identity_sources(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIdentitySourcesResponseTypeDef:  # (1)
    ...
  1. See ListIdentitySourcesResponseTypeDef
# list_identity_sources method usage example with argument unpacking

kwargs: ListIdentitySourcesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_identity_sources(**kwargs)
  1. See ListIdentitySourcesRequestTypeDef

list_policies#

Returns a list of policies.

Type annotations and code completion for boto3.client("mpa").list_policies method. boto3 documentation

# list_policies method definition

def list_policies(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListPoliciesResponseTypeDef
# list_policies method usage example with argument unpacking

kwargs: ListPoliciesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_policies(**kwargs)
  1. See ListPoliciesRequestTypeDef

list_policy_versions#

Returns a list of the versions for policies.

Type annotations and code completion for boto3.client("mpa").list_policy_versions method. boto3 documentation

# list_policy_versions method definition

def list_policy_versions(
    self,
    *,
    PolicyArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPolicyVersionsResponseTypeDef:  # (1)
    ...
  1. See ListPolicyVersionsResponseTypeDef
# list_policy_versions method usage example with argument unpacking

kwargs: ListPolicyVersionsRequestTypeDef = {  # (1)
    "PolicyArn": ...,
}

parent.list_policy_versions(**kwargs)
  1. See ListPolicyVersionsRequestTypeDef

list_resource_policies#

Returns a list of policies for a resource.

Type annotations and code completion for boto3.client("mpa").list_resource_policies method. boto3 documentation

# list_resource_policies method definition

def list_resource_policies(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourcePoliciesResponseTypeDef:  # (1)
    ...
  1. See ListResourcePoliciesResponseTypeDef
# list_resource_policies method usage example with argument unpacking

kwargs: ListResourcePoliciesRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_resource_policies(**kwargs)
  1. See ListResourcePoliciesRequestTypeDef

list_sessions#

Returns a list of approval sessions.

Type annotations and code completion for boto3.client("mpa").list_sessions method. boto3 documentation

# list_sessions method definition

def list_sessions(
    self,
    *,
    ApprovalTeamArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListSessionsResponseTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See ListSessionsResponseTypeDef
# list_sessions method usage example with argument unpacking

kwargs: ListSessionsRequestTypeDef = {  # (1)
    "ApprovalTeamArn": ...,
}

parent.list_sessions(**kwargs)
  1. See ListSessionsRequestTypeDef

list_tags_for_resource#

Returns a list of the tags for a resource.

Type annotations and code completion for boto3.client("mpa").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

start_active_approval_team_deletion#

Starts the deletion process for an active approval team.

Type annotations and code completion for boto3.client("mpa").start_active_approval_team_deletion method. boto3 documentation

# start_active_approval_team_deletion method definition

def start_active_approval_team_deletion(
    self,
    *,
    Arn: str,
    PendingWindowDays: int = ...,
) -> StartActiveApprovalTeamDeletionResponseTypeDef:  # (1)
    ...
  1. See StartActiveApprovalTeamDeletionResponseTypeDef
# start_active_approval_team_deletion method usage example with argument unpacking

kwargs: StartActiveApprovalTeamDeletionRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.start_active_approval_team_deletion(**kwargs)
  1. See StartActiveApprovalTeamDeletionRequestTypeDef

tag_resource#

Creates or updates a resource tag.

Type annotations and code completion for boto3.client("mpa").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes a resource tag.

Type annotations and code completion for boto3.client("mpa").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_approval_team#

Updates an approval team.

Type annotations and code completion for boto3.client("mpa").update_approval_team method. boto3 documentation

# update_approval_team method definition

def update_approval_team(
    self,
    *,
    Arn: str,
    ApprovalStrategy: ApprovalStrategyTypeDef = ...,  # (1)
    Approvers: Sequence[ApprovalTeamRequestApproverTypeDef] = ...,  # (2)
    Description: str = ...,
) -> UpdateApprovalTeamResponseTypeDef:  # (3)
    ...
  1. See ApprovalStrategyTypeDef
  2. See Sequence[ApprovalTeamRequestApproverTypeDef]
  3. See UpdateApprovalTeamResponseTypeDef
# update_approval_team method usage example with argument unpacking

kwargs: UpdateApprovalTeamRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.update_approval_team(**kwargs)
  1. See UpdateApprovalTeamRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("mpa").get_paginator method with overloads.