Skip to content

MailManagerClient#

Index > MailManager > MailManagerClient

Auto-generated documentation for MailManager type annotations stubs module mypy-boto3-mailmanager.

MailManagerClient#

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

# MailManagerClient usage example

from boto3.session import Session
from mypy_boto3_mailmanager.client import MailManagerClient

def get_mailmanager_client() -> MailManagerClient:
    return Session().client("mailmanager")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mailmanager")

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

from mypy_boto3_mailmanager.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("mailmanager").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_addon_instance#

Creates an Add On instance for the subscription indicated in the request.

Type annotations and code completion for boto3.client("mailmanager").create_addon_instance method. boto3 documentation

# create_addon_instance method definition

def create_addon_instance(
    self,
    *,
    AddonSubscriptionId: str,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAddonInstanceResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAddonInstanceResponseTypeDef
# create_addon_instance method usage example with argument unpacking

kwargs: CreateAddonInstanceRequestRequestTypeDef = {  # (1)
    "AddonSubscriptionId": ...,
}

parent.create_addon_instance(**kwargs)
  1. See CreateAddonInstanceRequestRequestTypeDef

create_addon_subscription#

Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing.

Type annotations and code completion for boto3.client("mailmanager").create_addon_subscription method. boto3 documentation

# create_addon_subscription method definition

def create_addon_subscription(
    self,
    *,
    AddonName: str,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAddonSubscriptionResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAddonSubscriptionResponseTypeDef
# create_addon_subscription method usage example with argument unpacking

kwargs: CreateAddonSubscriptionRequestRequestTypeDef = {  # (1)
    "AddonName": ...,
}

parent.create_addon_subscription(**kwargs)
  1. See CreateAddonSubscriptionRequestRequestTypeDef

create_archive#

Creates a new email archive resource for storing and retaining emails.

Type annotations and code completion for boto3.client("mailmanager").create_archive method. boto3 documentation

# create_archive method definition

def create_archive(
    self,
    *,
    ArchiveName: str,
    ClientToken: str = ...,
    KmsKeyArn: str = ...,
    Retention: ArchiveRetentionTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateArchiveResponseTypeDef:  # (3)
    ...
  1. See ArchiveRetentionTypeDef
  2. See TagTypeDef
  3. See CreateArchiveResponseTypeDef
# create_archive method usage example with argument unpacking

kwargs: CreateArchiveRequestRequestTypeDef = {  # (1)
    "ArchiveName": ...,
}

parent.create_archive(**kwargs)
  1. See CreateArchiveRequestRequestTypeDef

create_ingress_point#

Provision a new ingress endpoint resource.

Type annotations and code completion for boto3.client("mailmanager").create_ingress_point method. boto3 documentation

# create_ingress_point method definition

def create_ingress_point(
    self,
    *,
    IngressPointName: str,
    RuleSetId: str,
    TrafficPolicyId: str,
    Type: IngressPointTypeType,  # (1)
    ClientToken: str = ...,
    IngressPointConfiguration: IngressPointConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateIngressPointResponseTypeDef:  # (4)
    ...
  1. See IngressPointTypeType
  2. See IngressPointConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateIngressPointResponseTypeDef
# create_ingress_point method usage example with argument unpacking

kwargs: CreateIngressPointRequestRequestTypeDef = {  # (1)
    "IngressPointName": ...,
    "RuleSetId": ...,
    "TrafficPolicyId": ...,
    "Type": ...,
}

parent.create_ingress_point(**kwargs)
  1. See CreateIngressPointRequestRequestTypeDef

create_relay#

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

Type annotations and code completion for boto3.client("mailmanager").create_relay method. boto3 documentation

# create_relay method definition

def create_relay(
    self,
    *,
    Authentication: Union[RelayAuthenticationTypeDef, RelayAuthenticationOutputTypeDef],  # (1)
    RelayName: str,
    ServerName: str,
    ServerPort: int,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRelayResponseTypeDef:  # (3)
    ...
  1. See RelayAuthenticationTypeDef RelayAuthenticationOutputTypeDef
  2. See TagTypeDef
  3. See CreateRelayResponseTypeDef
# create_relay method usage example with argument unpacking

kwargs: CreateRelayRequestRequestTypeDef = {  # (1)
    "Authentication": ...,
    "RelayName": ...,
    "ServerName": ...,
    "ServerPort": ...,
}

parent.create_relay(**kwargs)
  1. See CreateRelayRequestRequestTypeDef

create_rule_set#

Provision a new rule set.

Type annotations and code completion for boto3.client("mailmanager").create_rule_set method. boto3 documentation

# create_rule_set method definition

def create_rule_set(
    self,
    *,
    RuleSetName: str,
    Rules: Sequence[Union[RuleTypeDef, RuleOutputTypeDef]],  # (1)
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRuleSetResponseTypeDef:  # (3)
    ...
  1. See RuleTypeDef RuleOutputTypeDef
  2. See TagTypeDef
  3. See CreateRuleSetResponseTypeDef
# create_rule_set method usage example with argument unpacking

kwargs: CreateRuleSetRequestRequestTypeDef = {  # (1)
    "RuleSetName": ...,
    "Rules": ...,
}

parent.create_rule_set(**kwargs)
  1. See CreateRuleSetRequestRequestTypeDef

create_traffic_policy#

Provision a new traffic policy resource.

Type annotations and code completion for boto3.client("mailmanager").create_traffic_policy method. boto3 documentation

# create_traffic_policy method definition

def create_traffic_policy(
    self,
    *,
    DefaultAction: AcceptActionType,  # (1)
    PolicyStatements: Sequence[Union[PolicyStatementTypeDef, PolicyStatementOutputTypeDef]],  # (2)
    TrafficPolicyName: str,
    ClientToken: str = ...,
    MaxMessageSizeBytes: int = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateTrafficPolicyResponseTypeDef:  # (4)
    ...
  1. See AcceptActionType
  2. See PolicyStatementTypeDef PolicyStatementOutputTypeDef
  3. See TagTypeDef
  4. See CreateTrafficPolicyResponseTy