Skip to content

MailManagerClient#

Index > MailManager > MailManagerClient

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

MailManagerClient#

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

# MailManagerClient usage example

from boto3.session import Session
from types_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 types_boto3_mailmanager.client import Exceptions

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

Methods#

can_paginate#

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:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("mailmanager").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:
    ...

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: CreateAddonInstanceRequestTypeDef = {  # (1)
    "AddonSubscriptionId": ...,
}

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

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: CreateAddonSubscriptionRequestTypeDef = {  # (1)
    "AddonName": ...,
}

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

create_address_list#

Creates a new address list.

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

# create_address_list method definition

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

kwargs: CreateAddressListRequestTypeDef = {  # (1)
    "AddressListName": ...,
}

parent.create_address_list(**kwargs)
  1. See CreateAddressListRequestTypeDef

create_address_list_import_job#

Creates an import job for an address list.

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

# create_address_list_import_job method definition

def create_address_list_import_job(
    self,
    *,
    AddressListId: str,
    ImportDataFormat: ImportDataFormatTypeDef,  # (1)
    Name: str,
    ClientToken: str = ...,
) -> CreateAddressListImportJobResponseTypeDef:  # (2)
    ...
  1. See ImportDataFormatTypeDef
  2. See CreateAddressListImportJobResponseTypeDef 
# create_address_list_import_job method usage example with argument unpacking

kwargs: CreateAddressListImportJobRequestTypeDef = {  # (1)
    "AddressListId": ...,
    "ImportDataFormat": ...,
    "Name": ...,
}

parent.create_address_list_import_job(**kwargs)
  1. See CreateAddressListImportJobRequestTypeDef

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: CreateArchiveRequestTypeDef = {  # (1)
    "ArchiveName": ...,
}

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

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: CreateIngressPointRequestTypeDef = {  # (1)
    "IngressPointName": ...,
    "RuleSetId": ...,
    "TrafficPolicyId": ...,
    "Type": ...,
}

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

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: RelayAuthenticationUnionTypeDef,  # (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: CreateRelayRequestTypeDef = {  # (1)
    "Authentication": ...,
    "RelayName": ...,
    "ServerName": ...,
    "ServerPort": ...,
}

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

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[RuleUnionTypeDef],  # (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: CreateRuleSetRequestTypeDef = {  # (1)
    "RuleSetName": ...,
    "Rules": ...,
}

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

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[PolicyStatementUnionTypeDef],  # (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 CreateTrafficPolicyResponseTypeDef 
# create_traffic_policy method usage example with argument unpacking

kwargs: CreateTrafficPolicyRequestTypeDef = {  # (1)
    "DefaultAction": ...,
    "PolicyStatements": ...,
    "TrafficPolicyName": ...,
}

parent.create_traffic_policy(**kwargs)
  1. See CreateTrafficPolicyRequestTypeDef

delete_addon_instance#

Deletes an Add On instance.

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

# delete_addon_instance method definition

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

kwargs: DeleteAddonInstanceRequestTypeDef = {  # (1)
    "AddonInstanceId": ...,
}

parent.delete_addon_instance(**kwargs)
  1. See DeleteAddonInstanceRequestTypeDef

delete_addon_subscription#

Deletes an Add On subscription.

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

# delete_addon_subscription method definition

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

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

parent.delete_addon_subscription(**kwargs)
  1. See DeleteAddonSubscriptionRequestTypeDef

delete_address_list#

Deletes an address list.

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

# delete_address_list method definition

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

kwargs: DeleteAddressListRequestTypeDef = {  # (1)
    "AddressListId": ...,
}

parent.delete_address_list(**kwargs)
  1. See DeleteAddressListRequestTypeDef

delete_archive#

Initiates deletion of an email archive.

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

# delete_archive method definition

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

kwargs: DeleteArchiveRequestTypeDef = {  # (1)
    "ArchiveId": ...,
}

parent.delete_archive(**kwargs)
  1. See DeleteArchiveRequestTypeDef

delete_ingress_point#

Delete an ingress endpoint resource.

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

# delete_ingress_point method definition

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

kwargs: DeleteIngressPointRequestTypeDef = {  # (1)
    "IngressPointId": ...,
}

parent.delete_ingress_point(**kwargs)
  1. See DeleteIngressPointRequestTypeDef

delete_relay#

Deletes an existing relay resource.

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

# delete_relay method definition

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

kwargs: DeleteRelayRequestTypeDef = {  # (1)
    "RelayId": ...,
}

parent.delete_relay(**kwargs)
  1. See DeleteRelayRequestTypeDef

delete_rule_set#

Delete a rule set.

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

# delete_rule_set method definition

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

kwargs: DeleteRuleSetRequestTypeDef = {  # (1)
    "RuleSetId": ...,
}

parent.delete_rule_set(**kwargs)
  1. See DeleteRuleSetRequestTypeDef

delete_traffic_policy#

Delete a traffic policy resource.

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

# delete_traffic_policy method definition

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

kwargs: DeleteTrafficPolicyRequestTypeDef = {  # (1)
    "TrafficPolicyId": ...,
}

parent.delete_traffic_policy(**kwargs)
  1. See DeleteTrafficPolicyRequestTypeDef

deregister_member_from_address_list#

Removes a member from an address list.

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

# deregister_member_from_address_list method definition

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

kwargs: DeregisterMemberFromAddressListRequestTypeDef = {  # (1)
    "Address": ...,
    "AddressListId": ...,
}

parent.deregister_member_from_address_list(**kwargs)
  1. See DeregisterMemberFromAddressListRequestTypeDef

get_addon_instance#

Gets detailed information about an Add On instance.

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

# get_addon_instance method definition

def get_addon_instance(
    self,
    *,
    AddonInstanceId: str,
) -> GetAddonInstanceResponseTypeDef:  # (1)
    ...
  1. See GetAddonInstanceResponseTypeDef 
# get_addon_instance method usage example with argument unpacking

kwargs: GetAddonInstanceRequestTypeDef = {  # (1)
    "AddonInstanceId": ...,
}

parent.get_addon_instance(**kwargs)
  1. See GetAddonInstanceRequestTypeDef

get_addon_subscription#

Gets detailed information about an Add On subscription.

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

# get_addon_subscription method definition

def get_addon_subscription(
    self,
    *,
    AddonSubscriptionId: str,
) -> GetAddonSubscriptionResponseTypeDef:  # (1)
    ...
  1. See GetAddonSubscriptionResponseTypeDef 
# get_addon_subscription method usage example with argument unpacking

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

parent.get_addon_subscription(**kwargs)
  1. See GetAddonSubscriptionRequestTypeDef

get_address_list#

Fetch attributes of an address list.

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

# get_address_list method definition

def get_address_list(
    self,
    *,
    AddressListId: str,
) -> GetAddressListResponseTypeDef:  # (1)
    ...
  1. See GetAddressListResponseTypeDef 
# get_address_list method usage example with argument unpacking

kwargs: GetAddressListRequestTypeDef = {  # (1)
    "AddressListId": ...,
}

parent.get_address_list(**kwargs)
  1. See GetAddressListRequestTypeDef

get_address_list_import_job#

Fetch attributes of an import job.

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

# get_address_list_import_job method definition

def get_address_list_import_job(
    self,
    *,
    JobId: str,
) -> GetAddressListImportJobResponseTypeDef:  # (1)
    ...
  1. See GetAddressListImportJobResponseTypeDef 
# get_address_list_import_job method usage example with argument unpacking

kwargs: GetAddressListImportJobRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_address_list_import_job(**kwargs)
  1. See GetAddressListImportJobRequestTypeDef

get_archive#

Retrieves the full details and current state of a specified email archive.

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

# get_archive method definition

def get_archive(
    self,
    *,
    ArchiveId: str,
) -> GetArchiveResponseTypeDef:  # (1)
    ...
  1. See GetArchiveResponseTypeDef 
# get_archive method usage example with argument unpacking

kwargs: GetArchiveRequestTypeDef = {  # (1)
    "ArchiveId": ...,
}

parent.get_archive(**kwargs)
  1. See GetArchiveRequestTypeDef

get_archive_export#

Retrieves the details and current status of a specific email archive export job.

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

# get_archive_export method definition

def get_archive_export(
    self,
    *,
    ExportId: str,
) -> GetArchiveExportResponseTypeDef:  # (1)
    ...
  1. See GetArchiveExportResponseTypeDef 
# get_archive_export method usage example with argument unpacking

kwargs: GetArchiveExportRequestTypeDef = {  # (1)
    "ExportId": ...,
}

parent.get_archive_export(**kwargs)
  1. See GetArchiveExportRequestTypeDef

get_archive_message#

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

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

# get_archive_message method definition

def get_archive_message(
    self,
    *,
    ArchivedMessageId: str,
) -> GetArchiveMessageResponseTypeDef:  # (1)
    ...
  1. See GetArchiveMessageResponseTypeDef 
# get_archive_message method usage example with argument unpacking

kwargs: GetArchiveMessageRequestTypeDef = {  # (1)
    "ArchivedMessageId": ...,
}

parent.get_archive_message(**kwargs)
  1. See GetArchiveMessageRequestTypeDef

get_archive_message_content#

Returns the textual content of a specific email message stored in the archive.

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

# get_archive_message_content method definition

def get_archive_message_content(
    self,
    *,
    ArchivedMessageId: str,
) -> GetArchiveMessageContentResponseTypeDef:  # (1)
    ...
  1. See GetArchiveMessageContentResponseTypeDef 
# get_archive_message_content method usage example with argument unpacking

kwargs: GetArchiveMessageContentRequestTypeDef = {  # (1)
    "ArchivedMessageId": ...,
}

parent.get_archive_message_content(**kwargs)
  1. See GetArchiveMessageContentRequestTypeDef

Retrieves the details and current status of a specific email archive search job.

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

# get_archive_search method definition

def get_archive_search(
    self,
    *,
    SearchId: str,
) -> GetArchiveSearchResponseTypeDef:  # (1)
    ...
  1. See GetArchiveSearchResponseTypeDef 
# get_archive_search method usage example with argument unpacking

kwargs: GetArchiveSearchRequestTypeDef = {  # (1)
    "SearchId": ...,
}

parent.get_archive_search(**kwargs)
  1. See GetArchiveSearchRequestTypeDef

get_archive_search_results#

Returns the results of a completed email archive search job.

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

# get_archive_search_results method definition

def get_archive_search_results(
    self,
    *,
    SearchId: str,
) -> GetArchiveSearchResultsResponseTypeDef:  # (1)
    ...
  1. See GetArchiveSearchResultsResponseTypeDef 
# get_archive_search_results method usage example with argument unpacking

kwargs: GetArchiveSearchResultsRequestTypeDef = {  # (1)
    "SearchId": ...,
}

parent.get_archive_search_results(**kwargs)
  1. See GetArchiveSearchResultsRequestTypeDef

get_ingress_point#

Fetch ingress endpoint resource attributes.

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

# get_ingress_point method definition

def get_ingress_point(
    self,
    *,
    IngressPointId: str,
) -> GetIngressPointResponseTypeDef:  # (1)
    ...
  1. See GetIngressPointResponseTypeDef 
# get_ingress_point method usage example with argument unpacking

kwargs: GetIngressPointRequestTypeDef = {  # (1)
    "IngressPointId": ...,
}

parent.get_ingress_point(**kwargs)
  1. See GetIngressPointRequestTypeDef

get_member_of_address_list#

Fetch attributes of a member in an address list.

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

# get_member_of_address_list method definition

def get_member_of_address_list(
    self,
    *,
    Address: str,
    AddressListId: str,
) -> GetMemberOfAddressListResponseTypeDef:  # (1)
    ...
  1. See GetMemberOfAddressListResponseTypeDef 
# get_member_of_address_list method usage example with argument unpacking

kwargs: GetMemberOfAddressListRequestTypeDef = {  # (1)
    "Address": ...,
    "AddressListId": ...,
}

parent.get_member_of_address_list(**kwargs)
  1. See GetMemberOfAddressListRequestTypeDef

get_relay#

Fetch the relay resource and it's attributes.

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

# get_relay method definition

def get_relay(
    self,
    *,
    RelayId: str,
) -> GetRelayResponseTypeDef:  # (1)
    ...
  1. See GetRelayResponseTypeDef 
# get_relay method usage example with argument unpacking

kwargs: GetRelayRequestTypeDef = {  # (1)
    "RelayId": ...,
}

parent.get_relay(**kwargs)
  1. See GetRelayRequestTypeDef

get_rule_set#

Fetch attributes of a rule set.

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

# get_rule_set method definition

def get_rule_set(
    self,
    *,
    RuleSetId: str,
) -> GetRuleSetResponseTypeDef:  # (1)
    ...
  1. See GetRuleSetResponseTypeDef 
# get_rule_set method usage example with argument unpacking

kwargs: GetRuleSetRequestTypeDef = {  # (1)
    "RuleSetId": ...,
}

parent.get_rule_set(**kwargs)
  1. See GetRuleSetRequestTypeDef

get_traffic_policy#

Fetch attributes of a traffic policy resource.

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

# get_traffic_policy method definition

def get_traffic_policy(
    self,
    *,
    TrafficPolicyId: str,
) -> GetTrafficPolicyResponseTypeDef:  # (1)
    ...
  1. See GetTrafficPolicyResponseTypeDef 
# get_traffic_policy method usage example with argument unpacking

kwargs: GetTrafficPolicyRequestTypeDef = {  # (1)
    "TrafficPolicyId": ...,
}

parent.get_traffic_policy(**kwargs)
  1. See GetTrafficPolicyRequestTypeDef

list_addon_instances#

Lists all Add On instances in your account.

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

# list_addon_instances method definition

def list_addon_instances(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListAddonInstancesResponseTypeDef:  # (1)
    ...
  1. See ListAddonInstancesResponseTypeDef 
# list_addon_instances method usage example with argument unpacking

kwargs: ListAddonInstancesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_addon_instances(**kwargs)
  1. See ListAddonInstancesRequestTypeDef

list_addon_subscriptions#

Lists all Add On subscriptions in your account.

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

# list_addon_subscriptions method definition

def list_addon_subscriptions(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListAddonSubscriptionsResponseTypeDef:  # (1)
    ...
  1. See ListAddonSubscriptionsResponseTypeDef 
# list_addon_subscriptions method usage example with argument unpacking

kwargs: ListAddonSubscriptionsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_addon_subscriptions(**kwargs)
  1. See ListAddonSubscriptionsRequestTypeDef

list_address_list_import_jobs#

Lists jobs for an address list.

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

# list_address_list_import_jobs method definition

def list_address_list_import_jobs(
    self,
    *,
    AddressListId: str,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListAddressListImportJobsResponseTypeDef:  # (1)
    ...
  1. See ListAddressListImportJobsResponseTypeDef 
# list_address_list_import_jobs method usage example with argument unpacking

kwargs: ListAddressListImportJobsRequestTypeDef = {  # (1)
    "AddressListId": ...,
}

parent.list_address_list_import_jobs(**kwargs)
  1. See ListAddressListImportJobsRequestTypeDef

list_address_lists#

Lists address lists for this account.

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

# list_address_lists method definition

def list_address_lists(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListAddressListsResponseTypeDef:  # (1)
    ...
  1. See ListAddressListsResponseTypeDef 
# list_address_lists method usage example with argument unpacking

kwargs: ListAddressListsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_address_lists(**kwargs)
  1. See ListAddressListsRequestTypeDef

list_archive_exports#

Returns a list of email archive export jobs.

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

# list_archive_exports method definition

def list_archive_exports(
    self,
    *,
    ArchiveId: str,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListArchiveExportsResponseTypeDef:  # (1)
    ...
  1. See ListArchiveExportsResponseTypeDef 
# list_archive_exports method usage example with argument unpacking

kwargs: ListArchiveExportsRequestTypeDef = {  # (1)
    "ArchiveId": ...,
}

parent.list_archive_exports(**kwargs)
  1. See ListArchiveExportsRequestTypeDef

list_archive_searches#

Returns a list of email archive search jobs.

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

# list_archive_searches method definition

def list_archive_searches(
    self,
    *,
    ArchiveId: str,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListArchiveSearchesResponseTypeDef:  # (1)
    ...
  1. See ListArchiveSearchesResponseTypeDef 
# list_archive_searches method usage example with argument unpacking

kwargs: ListArchiveSearchesRequestTypeDef = {  # (1)
    "ArchiveId": ...,
}

parent.list_archive_searches(**kwargs)
  1. See ListArchiveSearchesRequestTypeDef

list_archives#

Returns a list of all email archives in your account.

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

# list_archives method definition

def list_archives(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListArchivesResponseTypeDef:  # (1)
    ...
  1. See ListArchivesResponseTypeDef 
# list_archives method usage example with argument unpacking

kwargs: ListArchivesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_archives(**kwargs)
  1. See ListArchivesRequestTypeDef

list_ingress_points#

List all ingress endpoint resources.

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

# list_ingress_points method definition

def list_ingress_points(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListIngressPointsResponseTypeDef:  # (1)
    ...
  1. See ListIngressPointsResponseTypeDef 
# list_ingress_points method usage example with argument unpacking

kwargs: ListIngressPointsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_ingress_points(**kwargs)
  1. See ListIngressPointsRequestTypeDef

list_members_of_address_list#

Lists members of an address list.

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

# list_members_of_address_list method definition

def list_members_of_address_list(
    self,
    *,
    AddressListId: str,
    Filter: AddressFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListMembersOfAddressListResponseTypeDef:  # (2)
    ...
  1. See AddressFilterTypeDef
  2. See ListMembersOfAddressListResponseTypeDef 
# list_members_of_address_list method usage example with argument unpacking

kwargs: ListMembersOfAddressListRequestTypeDef = {  # (1)
    "AddressListId": ...,
}

parent.list_members_of_address_list(**kwargs)
  1. See ListMembersOfAddressListRequestTypeDef

list_relays#

Lists all the existing relay resources.

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

# list_relays method definition

def list_relays(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListRelaysResponseTypeDef:  # (1)
    ...
  1. See ListRelaysResponseTypeDef 
# list_relays method usage example with argument unpacking

kwargs: ListRelaysRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_relays(**kwargs)
  1. See ListRelaysRequestTypeDef

list_rule_sets#

List rule sets for this account.

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

# list_rule_sets method definition

def list_rule_sets(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListRuleSetsResponseTypeDef:  # (1)
    ...
  1. See ListRuleSetsResponseTypeDef 
# list_rule_sets method usage example with argument unpacking

kwargs: ListRuleSetsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_rule_sets(**kwargs)
  1. See ListRuleSetsRequestTypeDef

list_tags_for_resource#

Retrieves the list of tags (keys and values) assigned to the resource.

Type annotations and code completion for boto3.client("mailmanager").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

list_traffic_policies#

List traffic policy resources.

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

# list_traffic_policies method definition

def list_traffic_policies(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListTrafficPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListTrafficPoliciesResponseTypeDef 
# list_traffic_policies method usage example with argument unpacking

kwargs: ListTrafficPoliciesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_traffic_policies(**kwargs)
  1. See ListTrafficPoliciesRequestTypeDef

register_member_to_address_list#

Adds a member to an address list.

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

# register_member_to_address_list method definition

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

kwargs: RegisterMemberToAddressListRequestTypeDef = {  # (1)
    "Address": ...,
    "AddressListId": ...,
}

parent.register_member_to_address_list(**kwargs)
  1. See RegisterMemberToAddressListRequestTypeDef

start_address_list_import_job#

Starts an import job for an address list.

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

# start_address_list_import_job method definition

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

kwargs: StartAddressListImportJobRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.start_address_list_import_job(**kwargs)
  1. See StartAddressListImportJobRequestTypeDef

start_archive_export#

Initiates an export of emails from the specified archive.

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

# start_archive_export method definition

def start_archive_export(
    self,
    *,
    ArchiveId: str,
    ExportDestinationConfiguration: ExportDestinationConfigurationTypeDef,  # (1)
    FromTimestamp: TimestampTypeDef,
    ToTimestamp: TimestampTypeDef,
    Filters: ArchiveFiltersUnionTypeDef = ...,  # (2)
    IncludeMetadata: bool = ...,
    MaxResults: int = ...,
) -> StartArchiveExportResponseTypeDef:  # (3)
    ...
  1. See ExportDestinationConfigurationTypeDef
  2. See ArchiveFiltersTypeDef ArchiveFiltersOutputTypeDef
  3. See StartArchiveExportResponseTypeDef 
# start_archive_export method usage example with argument unpacking

kwargs: StartArchiveExportRequestTypeDef = {  # (1)
    "ArchiveId": ...,
    "ExportDestinationConfiguration": ...,
    "FromTimestamp": ...,
    "ToTimestamp": ...,
}

parent.start_archive_export(**kwargs)
  1. See StartArchiveExportRequestTypeDef

Initiates a search across emails in the specified archive.

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

# start_archive_search method definition

def start_archive_search(
    self,
    *,
    ArchiveId: str,
    FromTimestamp: TimestampTypeDef,
    MaxResults: int,
    ToTimestamp: TimestampTypeDef,
    Filters: ArchiveFiltersUnionTypeDef = ...,  # (1)
) -> StartArchiveSearchResponseTypeDef:  # (2)
    ...
  1. See ArchiveFiltersTypeDef ArchiveFiltersOutputTypeDef
  2. See StartArchiveSearchResponseTypeDef 
# start_archive_search method usage example with argument unpacking

kwargs: StartArchiveSearchRequestTypeDef = {  # (1)
    "ArchiveId": ...,
    "FromTimestamp": ...,
    "MaxResults": ...,
    "ToTimestamp": ...,
}

parent.start_archive_search(**kwargs)
  1. See StartArchiveSearchRequestTypeDef

stop_address_list_import_job#

Stops an ongoing import job for an address list.

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

# stop_address_list_import_job method definition

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

kwargs: StopAddressListImportJobRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_address_list_import_job(**kwargs)
  1. See StopAddressListImportJobRequestTypeDef

stop_archive_export#

Stops an in-progress export of emails from an archive.

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

# stop_archive_export method definition

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

kwargs: StopArchiveExportRequestTypeDef = {  # (1)
    "ExportId": ...,
}

parent.stop_archive_export(**kwargs)
  1. See StopArchiveExportRequestTypeDef

Stops an in-progress archive search job.

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

# stop_archive_search method definition

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

kwargs: StopArchiveSearchRequestTypeDef = {  # (1)
    "SearchId": ...,
}

parent.stop_archive_search(**kwargs)
  1. See StopArchiveSearchRequestTypeDef

tag_resource#

Adds one or more tags (keys and values) to a specified resource.

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

# tag_resource method definition

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

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

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

untag_resource#

Remove one or more tags (keys and values) from a specified resource.

Type annotations and code completion for boto3.client("mailmanager").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_archive#

Updates the attributes of an existing email archive.

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

# update_archive method definition

def update_archive(
    self,
    *,
    ArchiveId: str,
    ArchiveName: str = ...,
    Retention: ArchiveRetentionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ArchiveRetentionTypeDef 
# update_archive method usage example with argument unpacking

kwargs: UpdateArchiveRequestTypeDef = {  # (1)
    "ArchiveId": ...,
}

parent.update_archive(**kwargs)
  1. See UpdateArchiveRequestTypeDef

update_ingress_point#

Update attributes of a provisioned ingress endpoint resource.

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

# update_ingress_point method definition

def update_ingress_point(
    self,
    *,
    IngressPointId: str,
    IngressPointConfiguration: IngressPointConfigurationTypeDef = ...,  # (1)
    IngressPointName: str = ...,
    RuleSetId: str = ...,
    StatusToUpdate: IngressPointStatusToUpdateType = ...,  # (2)
    TrafficPolicyId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See IngressPointConfigurationTypeDef
  2. See IngressPointStatusToUpdateType 
# update_ingress_point method usage example with argument unpacking

kwargs: UpdateIngressPointRequestTypeDef = {  # (1)
    "IngressPointId": ...,
}

parent.update_ingress_point(**kwargs)
  1. See UpdateIngressPointRequestTypeDef

update_relay#

Updates the attributes of an existing relay resource.

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

# update_relay method definition

def update_relay(
    self,
    *,
    RelayId: str,
    Authentication: RelayAuthenticationUnionTypeDef = ...,  # (1)
    RelayName: str = ...,
    ServerName: str = ...,
    ServerPort: int = ...,
) -> Dict[str, Any]:
    ...
  1. See RelayAuthenticationTypeDef RelayAuthenticationOutputTypeDef 
# update_relay method usage example with argument unpacking

kwargs: UpdateRelayRequestTypeDef = {  # (1)
    "RelayId": ...,
}

parent.update_relay(**kwargs)
  1. See UpdateRelayRequestTypeDef

update_rule_set#

Update attributes of an already provisioned rule set.

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

# update_rule_set method definition

def update_rule_set(
    self,
    *,
    RuleSetId: str,
    RuleSetName: str = ...,
    Rules: Sequence[RuleUnionTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See RuleTypeDef RuleOutputTypeDef 
# update_rule_set method usage example with argument unpacking

kwargs: UpdateRuleSetRequestTypeDef = {  # (1)
    "RuleSetId": ...,
}

parent.update_rule_set(**kwargs)
  1. See UpdateRuleSetRequestTypeDef

update_traffic_policy#

Update attributes of an already provisioned traffic policy resource.

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

# update_traffic_policy method definition

def update_traffic_policy(
    self,
    *,
    TrafficPolicyId: str,
    DefaultAction: AcceptActionType = ...,  # (1)
    MaxMessageSizeBytes: int = ...,
    PolicyStatements: Sequence[PolicyStatementUnionTypeDef] = ...,  # (2)
    TrafficPolicyName: str = ...,
) -> Dict[str, Any]:
    ...
  1. See AcceptActionType
  2. See PolicyStatementTypeDef PolicyStatementOutputTypeDef 
# update_traffic_policy method usage example with argument unpacking

kwargs: UpdateTrafficPolicyRequestTypeDef = {  # (1)
    "TrafficPolicyId": ...,
}

parent.update_traffic_policy(**kwargs)
  1. See UpdateTrafficPolicyRequestTypeDef

get_paginator#

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