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: 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: RelayAuthenticationTypeDef,  # (1)
    RelayName: str,
    ServerName: str,
    ServerPort: int,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRelayResponseTypeDef:  # (3)
    ...

1. See RelayAuthenticationTypeDef
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[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: 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[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: CreateTrafficPolicyRequestRequestTypeDef = {  # (1)
    "DefaultAction": ...,
    "PolicyStatements": ...,
    "TrafficPolicyName": ...,
}

parent.create_traffic_policy(**kwargs)

1. See CreateTrafficPolicyRequestRequestTypeDef

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

parent.delete_addon_instance(**kwargs)

1. See DeleteAddonInstanceRequestRequestTypeDef

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

parent.delete_addon_subscription(**kwargs)

1. See DeleteAddonSubscriptionRequestRequestTypeDef

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

parent.delete_archive(**kwargs)

1. See DeleteArchiveRequestRequestTypeDef

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

parent.delete_ingress_point(**kwargs)

1. See DeleteIngressPointRequestRequestTypeDef

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

parent.delete_relay(**kwargs)

1. See DeleteRelayRequestRequestTypeDef

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

parent.delete_rule_set(**kwargs)

1. See DeleteRuleSetRequestRequestTypeDef

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

parent.delete_traffic_policy(**kwargs)

1. See DeleteTrafficPolicyRequestRequestTypeDef

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

parent.get_addon_instance(**kwargs)

1. See GetAddonInstanceRequestRequestTypeDef

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

parent.get_addon_subscription(**kwargs)

1. See GetAddonSubscriptionRequestRequestTypeDef

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

parent.get_archive(**kwargs)

1. See GetArchiveRequestRequestTypeDef

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

parent.get_archive_export(**kwargs)

1. See GetArchiveExportRequestRequestTypeDef

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

parent.get_archive_message(**kwargs)

1. See GetArchiveMessageRequestRequestTypeDef

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

parent.get_archive_message_content(**kwargs)

1. See GetArchiveMessageContentRequestRequestTypeDef

get_archive_search

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

parent.get_archive_search(**kwargs)

1. See GetArchiveSearchRequestRequestTypeDef

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

parent.get_archive_search_results(**kwargs)

1. See GetArchiveSearchResultsRequestRequestTypeDef

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

parent.get_ingress_point(**kwargs)

1. See GetIngressPointRequestRequestTypeDef

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

parent.get_relay(**kwargs)

1. See GetRelayRequestRequestTypeDef

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

parent.get_rule_set(**kwargs)

1. See GetRuleSetRequestRequestTypeDef

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

parent.get_traffic_policy(**kwargs)

1. See GetTrafficPolicyRequestRequestTypeDef

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

parent.list_addon_instances(**kwargs)

1. See ListAddonInstancesRequestRequestTypeDef

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

parent.list_addon_subscriptions(**kwargs)

1. See ListAddonSubscriptionsRequestRequestTypeDef

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

parent.list_archive_exports(**kwargs)

1. See ListArchiveExportsRequestRequestTypeDef

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

parent.list_archive_searches(**kwargs)

1. See ListArchiveSearchesRequestRequestTypeDef

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

parent.list_archives(**kwargs)

1. See ListArchivesRequestRequestTypeDef

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

parent.list_ingress_points(**kwargs)

1. See ListIngressPointsRequestRequestTypeDef

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

parent.list_relays(**kwargs)

1. See ListRelaysRequestRequestTypeDef

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

parent.list_rule_sets(**kwargs)

1. See ListRuleSetsRequestRequestTypeDef

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

parent.list_traffic_policies(**kwargs)

1. See ListTrafficPoliciesRequestRequestTypeDef

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: ArchiveFiltersTypeDef = ...,  # (2)
    IncludeMetadata: bool = ...,
    MaxResults: int = ...,
) -> StartArchiveExportResponseTypeDef:  # (3)
    ...

1. See ExportDestinationConfigurationTypeDef
2. See ArchiveFiltersTypeDef
3. See StartArchiveExportResponseTypeDef

# start_archive_export method usage example with argument unpacking

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

parent.start_archive_export(**kwargs)

1. See StartArchiveExportRequestRequestTypeDef

start_archive_search

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: ArchiveFiltersTypeDef = ...,  # (1)
) -> StartArchiveSearchResponseTypeDef:  # (2)
    ...

1. See ArchiveFiltersTypeDef
2. See StartArchiveSearchResponseTypeDef

# start_archive_search method usage example with argument unpacking

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

parent.start_archive_search(**kwargs)

1. See StartArchiveSearchRequestRequestTypeDef

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

parent.stop_archive_export(**kwargs)

1. See StopArchiveExportRequestRequestTypeDef

stop_archive_search

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

parent.stop_archive_search(**kwargs)

1. See StopArchiveSearchRequestRequestTypeDef

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: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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

parent.update_archive(**kwargs)

1. See UpdateArchiveRequestRequestTypeDef

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

parent.update_ingress_point(**kwargs)

1. See UpdateIngressPointRequestRequestTypeDef

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: RelayAuthenticationTypeDef = ...,  # (1)
    RelayName: str = ...,
    ServerName: str = ...,
    ServerPort: int = ...,
) -> dict[str, Any]:
    ...

1. See RelayAuthenticationTypeDef

# update_relay method usage example with argument unpacking

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

parent.update_relay(**kwargs)

1. See UpdateRelayRequestRequestTypeDef

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[RuleTypeDef] = ...,  # (1)
) -> dict[str, Any]:
    ...

1. See RuleTypeDef

# update_rule_set method usage example with argument unpacking

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

parent.update_rule_set(**kwargs)

1. See UpdateRuleSetRequestRequestTypeDef

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[PolicyStatementTypeDef] = ...,  # (2)
    TrafficPolicyName: str = ...,
) -> dict[str, Any]:
    ...

1. See AcceptActionType
2. See PolicyStatementTypeDef

# update_traffic_policy method usage example with argument unpacking

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

parent.update_traffic_policy(**kwargs)

1. See UpdateTrafficPolicyRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_addon_instances") -> ListAddonInstancesPaginator
• client.get_paginator("list_addon_subscriptions") -> ListAddonSubscriptionsPaginator
• client.get_paginator("list_archive_exports") -> ListArchiveExportsPaginator
• client.get_paginator("list_archive_searches") -> ListArchiveSearchesPaginator
• client.get_paginator("list_archives") -> ListArchivesPaginator
• client.get_paginator("list_ingress_points") -> ListIngressPointsPaginator
• client.get_paginator("list_relays") -> ListRelaysPaginator
• client.get_paginator("list_rule_sets") -> ListRuleSetsPaginator
• client.get_paginator("list_traffic_policies") -> ListTrafficPoliciesPaginator