MailManager *********** Client ====== class MailManager.Client A low-level client representing MailManager The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES). Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter in the *Amazon SES Developer Guide*. import boto3 client = boto3.client('mailmanager') These are the available methods: * can_paginate * close * create_addon_instance * create_addon_subscription * create_address_list * create_address_list_import_job * create_archive * create_ingress_point * create_relay * create_rule_set * create_traffic_policy * delete_addon_instance * delete_addon_subscription * delete_address_list * delete_archive * delete_ingress_point * delete_relay * delete_rule_set * delete_traffic_policy * deregister_member_from_address_list * get_addon_instance * get_addon_subscription * get_address_list * get_address_list_import_job * get_archive * get_archive_export * get_archive_message * get_archive_message_content * get_archive_search * get_archive_search_results * get_ingress_point * get_member_of_address_list * get_paginator * get_relay * get_rule_set * get_traffic_policy * get_waiter * list_addon_instances * list_addon_subscriptions * list_address_list_import_jobs * list_address_lists * list_archive_exports * list_archive_searches * list_archives * list_ingress_points * list_members_of_address_list * list_relays * list_rule_sets * list_tags_for_resource * list_traffic_policies * register_member_to_address_list * start_address_list_import_job * start_archive_export * start_archive_search * stop_address_list_import_job * stop_archive_export * stop_archive_search * tag_resource * untag_resource * update_archive * update_ingress_point * update_relay * update_rule_set * update_traffic_policy Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAddonInstances * ListAddonSubscriptions * ListAddressListImportJobs * ListAddressLists * ListArchiveExports * ListArchiveSearches * ListArchives * ListIngressPoints * ListMembersOfAddressList * ListRelays * ListRuleSets * ListTrafficPolicies MailManager / Paginator / ListArchives ListArchives ************ class MailManager.Paginator.ListArchives paginator = client.get_paginator('list_archives') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_archives()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Archives': [ { 'ArchiveId': 'string', 'ArchiveName': 'string', 'ArchiveState': 'ACTIVE'|'PENDING_DELETION', 'LastUpdatedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* The response containing a list of your email archives. * **Archives** *(list) --* The list of archive details. * *(dict) --* An archive resource for storing and retaining emails. * **ArchiveId** *(string) --* The unique identifier of the archive. * **ArchiveName** *(string) --* The unique name assigned to the archive. * **ArchiveState** *(string) --* The current state of the archive: * "ACTIVE" – The archive is ready and available for use. * "PENDING_DELETION" – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the archive was last updated. MailManager / Paginator / ListRuleSets ListRuleSets ************ class MailManager.Paginator.ListRuleSets paginator = client.get_paginator('list_rule_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_rule_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RuleSets': [ { 'RuleSetId': 'string', 'RuleSetName': 'string', 'LastModificationDate': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **RuleSets** *(list) --* The list of rule sets. * *(dict) --* A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email. * **RuleSetId** *(string) --* The identifier of the rule set. * **RuleSetName** *(string) --* A user-friendly name for the rule set. * **LastModificationDate** *(datetime) --* The last modification date of the rule set. MailManager / Paginator / ListRelays ListRelays ********** class MailManager.Paginator.ListRelays paginator = client.get_paginator('list_relays') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_relays()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Relays': [ { 'RelayId': 'string', 'RelayName': 'string', 'LastModifiedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Relays** *(list) --* The list of returned relays. * *(dict) --* The relay resource that can be used as a rule to relay receiving emails to the destination relay server. * **RelayId** *(string) --* The unique relay identifier. * **RelayName** *(string) --* The unique relay name. * **LastModifiedTimestamp** *(datetime) --* The timestamp of when the relay was last modified. MailManager / Paginator / ListAddonSubscriptions ListAddonSubscriptions ********************** class MailManager.Paginator.ListAddonSubscriptions paginator = client.get_paginator('list_addon_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_addon_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AddonSubscriptions': [ { 'AddonSubscriptionId': 'string', 'AddonName': 'string', 'AddonSubscriptionArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **AddonSubscriptions** *(list) --* The list of ingress endpoints. * *(dict) --* A subscription for an Add On representing the acceptance of its terms of use and additional pricing. * **AddonSubscriptionId** *(string) --* The unique ID of the Add On subscription. * **AddonName** *(string) --* The name of the Add On. * **AddonSubscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Add On subscription. * **CreatedTimestamp** *(datetime) --* The timestamp of when the Add On subscription was created. MailManager / Paginator / ListAddonInstances ListAddonInstances ****************** class MailManager.Paginator.ListAddonInstances paginator = client.get_paginator('list_addon_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_addon_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AddonInstances': [ { 'AddonInstanceId': 'string', 'AddonSubscriptionId': 'string', 'AddonName': 'string', 'AddonInstanceArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **AddonInstances** *(list) --* The list of ingress endpoints. * *(dict) --* An Add On instance represents a specific configuration of an Add On. * **AddonInstanceId** *(string) --* The unique ID of the Add On instance. * **AddonSubscriptionId** *(string) --* The subscription ID for the instance. * **AddonName** *(string) --* The name of the Add On for the instance. * **AddonInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the Add On instance. * **CreatedTimestamp** *(datetime) --* The timestamp of when the Add On instance was created. MailManager / Paginator / ListTrafficPolicies ListTrafficPolicies ******************* class MailManager.Paginator.ListTrafficPolicies paginator = client.get_paginator('list_traffic_policies') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_traffic_policies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TrafficPolicies': [ { 'TrafficPolicyName': 'string', 'TrafficPolicyId': 'string', 'DefaultAction': 'ALLOW'|'DENY' }, ], } **Response Structure** * *(dict) --* * **TrafficPolicies** *(list) --* The list of traffic policies. * *(dict) --* The structure of a traffic policy resource which is a container for policy statements. * **TrafficPolicyName** *(string) --* A user-friendly name of the traffic policy resource. * **TrafficPolicyId** *(string) --* The identifier of the traffic policy resource. * **DefaultAction** *(string) --* Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements MailManager / Paginator / ListIngressPoints ListIngressPoints ***************** class MailManager.Paginator.ListIngressPoints paginator = client.get_paginator('list_ingress_points') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_ingress_points()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IngressPoints': [ { 'IngressPointName': 'string', 'IngressPointId': 'string', 'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED', 'Type': 'OPEN'|'AUTH', 'ARecord': 'string' }, ], } **Response Structure** * *(dict) --* * **IngressPoints** *(list) --* The list of ingress endpoints. * *(dict) --* The structure of an ingress endpoint resource. * **IngressPointName** *(string) --* A user friendly name for the ingress endpoint resource. * **IngressPointId** *(string) --* The identifier of the ingress endpoint resource. * **Status** *(string) --* The status of the ingress endpoint resource. * **Type** *(string) --* The type of ingress endpoint resource. * **ARecord** *(string) --* The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager. MailManager / Paginator / ListAddressLists ListAddressLists **************** class MailManager.Paginator.ListAddressLists paginator = client.get_paginator('list_address_lists') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_address_lists()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AddressLists': [ { 'AddressListId': 'string', 'AddressListArn': 'string', 'AddressListName': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **AddressLists** *(list) --* The list of address lists. * *(dict) --* An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management. * **AddressListId** *(string) --* The identifier of the address list. * **AddressListArn** *(string) --* The Amazon Resource Name (ARN) of the address list. * **AddressListName** *(string) --* The user-friendly name of the address list. * **CreatedTimestamp** *(datetime) --* The timestamp of when the address list was created. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the address list was last updated. MailManager / Paginator / ListArchiveExports ListArchiveExports ****************** class MailManager.Paginator.ListArchiveExports paginator = client.get_paginator('list_archive_exports') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_archive_exports()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ArchiveId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Exports': [ { 'ExportId': 'string', 'Status': { 'SubmissionTimestamp': datetime(2015, 1, 1), 'CompletionTimestamp': datetime(2015, 1, 1), 'State': 'QUEUED'|'PREPROCESSING'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED', 'ErrorMessage': 'string' } }, ], } **Response Structure** * *(dict) --* The response containing a list of archive export jobs and their statuses. * **Exports** *(list) --* The list of export job identifiers and statuses. * *(dict) --* Summary statuses of an archive export job. * **ExportId** *(string) --* The unique identifier of the export job. * **Status** *(dict) --* The current status of the export job. * **SubmissionTimestamp** *(datetime) --* The timestamp of when the export job was submitted. * **CompletionTimestamp** *(datetime) --* The timestamp of when the export job completed (if finished). * **State** *(string) --* The current state of the export job. * **ErrorMessage** *(string) --* An error message if the export job failed. MailManager / Paginator / ListMembersOfAddressList ListMembersOfAddressList ************************ class MailManager.Paginator.ListMembersOfAddressList paginator = client.get_paginator('list_members_of_address_list') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_members_of_address_list()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AddressListId='string', Filter={ 'AddressPrefix': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list to list the addresses from. * **Filter** (*dict*) -- Filter to be used to limit the results. * **AddressPrefix** *(string) --* Filter to limit the results to addresses having the provided prefix. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Addresses': [ { 'Address': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Addresses** *(list) --* The list of addresses. * *(dict) --* An address that is a member of an address list. * **Address** *(string) --* The email or domain that constitutes the address. * **CreatedTimestamp** *(datetime) --* The timestamp of when the address was added to the address list. MailManager / Paginator / ListAddressListImportJobs ListAddressListImportJobs ************************* class MailManager.Paginator.ListAddressListImportJobs paginator = client.get_paginator('list_address_list_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_address_list_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AddressListId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list for listing import jobs. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ImportJobs': [ { 'JobId': 'string', 'Name': 'string', 'Status': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'STOPPED', 'PreSignedUrl': 'string', 'ImportedItemsCount': 123, 'FailedItemsCount': 123, 'ImportDataFormat': { 'ImportDataType': 'CSV'|'JSON' }, 'AddressListId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'StartTimestamp': datetime(2015, 1, 1), 'CompletedTimestamp': datetime(2015, 1, 1), 'Error': 'string' }, ], } **Response Structure** * *(dict) --* * **ImportJobs** *(list) --* The list of import jobs. * *(dict) --* Details about an import job. * **JobId** *(string) --* The identifier of the import job. * **Name** *(string) --* A user-friendly name for the import job. * **Status** *(string) --* The status of the import job. * **PreSignedUrl** *(string) --* The pre-signed URL target for uploading the input file. * **ImportedItemsCount** *(integer) --* The number of addresses in the input that were successfully imported into the address list. * **FailedItemsCount** *(integer) --* The number of addresses in the input that failed to get imported into address list. * **ImportDataFormat** *(dict) --* The format of the input for the import job. * **ImportDataType** *(string) --* The type of file that would be passed as an input for the address list import job. * **AddressListId** *(string) --* The unique identifier of the address list the import job was created for. * **CreatedTimestamp** *(datetime) --* The timestamp of when the import job was created. * **StartTimestamp** *(datetime) --* The timestamp of when the import job was started. * **CompletedTimestamp** *(datetime) --* The timestamp of when the import job was completed. * **Error** *(string) --* The reason for failure of an import job. MailManager / Paginator / ListArchiveSearches ListArchiveSearches ******************* class MailManager.Paginator.ListArchiveSearches paginator = client.get_paginator('list_archive_searches') paginate(**kwargs) Creates an iterator that will paginate through responses from "MailManager.Client.list_archive_searches()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ArchiveId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Searches': [ { 'SearchId': 'string', 'Status': { 'SubmissionTimestamp': datetime(2015, 1, 1), 'CompletionTimestamp': datetime(2015, 1, 1), 'State': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED', 'ErrorMessage': 'string' } }, ], } **Response Structure** * *(dict) --* The response containing a list of archive search jobs and their statuses. * **Searches** *(list) --* The list of search job identifiers and statuses. * *(dict) --* Summary details of an archive search job. * **SearchId** *(string) --* The unique identifier of the search job. * **Status** *(dict) --* The current status of the search job. * **SubmissionTimestamp** *(datetime) --* The timestamp of when the search was submitted. * **CompletionTimestamp** *(datetime) --* The timestamp of when the search completed (if finished). * **State** *(string) --* The current state of the search job. * **ErrorMessage** *(string) --* An error message if the search failed. MailManager / Client / stop_archive_export stop_archive_export ******************* MailManager.Client.stop_archive_export(**kwargs) Stops an in-progress export of emails from an archive. See also: AWS API Documentation **Request Syntax** response = client.stop_archive_export( ExportId='string' ) Parameters: **ExportId** (*string*) -- **[REQUIRED]** The identifier of the export job to stop. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response indicating if the request to stop the export job succeeded. On success, returns an HTTP 200 status code. On failure, returns an error message. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_address_list_import_job get_address_list_import_job *************************** MailManager.Client.get_address_list_import_job(**kwargs) Fetch attributes of an import job. See also: AWS API Documentation **Request Syntax** response = client.get_address_list_import_job( JobId='string' ) Parameters: **JobId** (*string*) -- **[REQUIRED]** The identifier of the import job that needs to be retrieved. Return type: dict Returns: **Response Syntax** { 'JobId': 'string', 'Name': 'string', 'Status': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'STOPPED', 'PreSignedUrl': 'string', 'ImportedItemsCount': 123, 'FailedItemsCount': 123, 'ImportDataFormat': { 'ImportDataType': 'CSV'|'JSON' }, 'AddressListId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'StartTimestamp': datetime(2015, 1, 1), 'CompletedTimestamp': datetime(2015, 1, 1), 'Error': 'string' } **Response Structure** * *(dict) --* * **JobId** *(string) --* The identifier of the import job. * **Name** *(string) --* A user-friendly name for the import job. * **Status** *(string) --* The status of the import job. * **PreSignedUrl** *(string) --* The pre-signed URL target for uploading the input file. * **ImportedItemsCount** *(integer) --* The number of input addresses successfully imported into the address list. * **FailedItemsCount** *(integer) --* The number of input addresses that failed to be imported into the address list. * **ImportDataFormat** *(dict) --* The format of the input for an import job. * **ImportDataType** *(string) --* The type of file that would be passed as an input for the address list import job. * **AddressListId** *(string) --* The unique identifier of the address list the import job was created for. * **CreatedTimestamp** *(datetime) --* The timestamp of when the import job was created. * **StartTimestamp** *(datetime) --* The timestamp of when the import job was started. * **CompletedTimestamp** *(datetime) --* The timestamp of when the import job was completed. * **Error** *(string) --* The reason for failure of an import job. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_paginator get_paginator ************* MailManager.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. MailManager / Client / create_address_list_import_job create_address_list_import_job ****************************** MailManager.Client.create_address_list_import_job(**kwargs) Creates an import job for an address list. See also: AWS API Documentation **Request Syntax** response = client.create_address_list_import_job( ClientToken='string', AddressListId='string', Name='string', ImportDataFormat={ 'ImportDataType': 'CSV'|'JSON' } ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list for importing addresses to. * **Name** (*string*) -- **[REQUIRED]** A user-friendly name for the import job. * **ImportDataFormat** (*dict*) -- **[REQUIRED]** The format of the input for an import job. * **ImportDataType** *(string) --* **[REQUIRED]** The type of file that would be passed as an input for the address list import job. Return type: dict Returns: **Response Syntax** { 'JobId': 'string', 'PreSignedUrl': 'string' } **Response Structure** * *(dict) --* * **JobId** *(string) --* The identifier of the created import job. * **PreSignedUrl** *(string) --* The pre-signed URL target for uploading the input file. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / update_rule_set update_rule_set *************** MailManager.Client.update_rule_set(**kwargs) Update attributes of an already provisioned rule set. See also: AWS API Documentation **Request Syntax** response = client.update_rule_set( RuleSetId='string', RuleSetName='string', Rules=[ { 'Name': 'string', 'Conditions': [ { 'BooleanExpression': { 'Evaluate': { 'Attribute': 'READ_RECEIPT_REQUESTED'|'TLS'|'TLS_WRAPPED', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT'|'MAIL_FROM'|'SENDER'|'FROM'|'TO'|'CC', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' }, 'StringExpression': { 'Evaluate': { 'Attribute': 'MAIL_FROM'|'HELO'|'RECIPIENT'|'SENDER'|'FROM'|'SUBJECT'|'TO'|'CC', 'MimeHeaderAttribute': 'string', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'NumberExpression': { 'Evaluate': { 'Attribute': 'MESSAGE_SIZE' }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'LESS_THAN'|'GREATER_THAN'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN_OR_EQUAL', 'Value': 123.0 }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SOURCE_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'VerdictExpression': { 'Evaluate': { 'Attribute': 'SPF'|'DKIM', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'PASS'|'FAIL'|'GRAY'|'PROCESSING_FAILED', ] }, 'DmarcExpression': { 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'NONE'|'QUARANTINE'|'REJECT', ] } }, ], 'Unless': [ { 'BooleanExpression': { 'Evaluate': { 'Attribute': 'READ_RECEIPT_REQUESTED'|'TLS'|'TLS_WRAPPED', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT'|'MAIL_FROM'|'SENDER'|'FROM'|'TO'|'CC', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' }, 'StringExpression': { 'Evaluate': { 'Attribute': 'MAIL_FROM'|'HELO'|'RECIPIENT'|'SENDER'|'FROM'|'SUBJECT'|'TO'|'CC', 'MimeHeaderAttribute': 'string', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'NumberExpression': { 'Evaluate': { 'Attribute': 'MESSAGE_SIZE' }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'LESS_THAN'|'GREATER_THAN'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN_OR_EQUAL', 'Value': 123.0 }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SOURCE_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'VerdictExpression': { 'Evaluate': { 'Attribute': 'SPF'|'DKIM', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'PASS'|'FAIL'|'GRAY'|'PROCESSING_FAILED', ] }, 'DmarcExpression': { 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'NONE'|'QUARANTINE'|'REJECT', ] } }, ], 'Actions': [ { 'Drop': {} , 'Relay': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'Relay': 'string', 'MailFrom': 'REPLACE'|'PRESERVE' }, 'Archive': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'TargetArchive': 'string' }, 'WriteToS3': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'RoleArn': 'string', 'S3Bucket': 'string', 'S3Prefix': 'string', 'S3SseKmsKeyId': 'string' }, 'Send': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'RoleArn': 'string' }, 'AddHeader': { 'HeaderName': 'string', 'HeaderValue': 'string' }, 'ReplaceRecipient': { 'ReplaceWith': [ 'string', ] }, 'DeliverToMailbox': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'MailboxArn': 'string', 'RoleArn': 'string' }, 'DeliverToQBusiness': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'ApplicationId': 'string', 'IndexId': 'string', 'RoleArn': 'string' }, 'PublishToSns': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'TopicArn': 'string', 'RoleArn': 'string', 'Encoding': 'UTF-8'|'BASE64', 'PayloadType': 'HEADERS'|'CONTENT' } }, ] }, ] ) Parameters: * **RuleSetId** (*string*) -- **[REQUIRED]** The identifier of a rule set you want to update. * **RuleSetName** (*string*) -- A user-friendly name for the rule set resource. * **Rules** (*list*) -- A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set. * *(dict) --* A rule contains conditions, "unless conditions" and actions. For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions". * **Name** *(string) --* The user-friendly name of the rule. * **Conditions** *(list) --* The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions" * *(dict) --* The conditional expression used to evaluate an email for determining if a rule action should be taken. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "BooleanExpression", "StringExpression", "NumberExpression", "IpExpression", "VerdictExpression", "DmarcExpression". * **BooleanExpression** *(dict) --* The condition applies to a boolean expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis", "IsInAddressList". * **Attribute** *(string) --* The boolean type representing the allowed attribute types for an email. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a boolean condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression. * **Attribute** *(string) --* **[REQUIRED]** The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* **[REQUIRED]** The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* **[REQUIRED]** The matching operator for a boolean condition expression. * **StringExpression** *(dict) --* The condition applies to a string expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The string to evaluate in a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "MimeHeaderAttribute", "Analysis". * **Attribute** *(string) --* The email attribute to evaluate in a string condition expression. * **MimeHeaderAttribute** *(string) --* The email MIME X-Header attribute to evaluate in a string condition expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a string condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a string condition expression. * **Values** *(list) --* **[REQUIRED]** The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string. * *(string) --* * **NumberExpression** *(dict) --* The condition applies to a number expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The number to evaluate in a numeric condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An email attribute that is used as the number to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator for a numeric condition expression. * **Value** *(float) --* **[REQUIRED]** The value to evaluate in a numeric condition expression. * **IpExpression** *(dict) --* The condition applies to an IP address expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The IP address to evaluate in this condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The attribute of the email to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to evaluate the IP address. * **Values** *(list) --* **[REQUIRED]** The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges. * *(string) --* * **VerdictExpression** *(dict) --* The condition applies to a verdict expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The verdict to evaluate in a verdict condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis". * **Attribute** *(string) --* The email verdict attribute to evaluate in a string verdict expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a verdict condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a verdict condition expression. * **Values** *(list) --* **[REQUIRED]** The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email. * *(string) --* * **DmarcExpression** *(dict) --* The condition applies to a DMARC policy expression passed in this field. * **Operator** *(string) --* **[REQUIRED]** The operator to apply to the DMARC policy of the incoming email. * **Values** *(list) --* **[REQUIRED]** The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match. * *(string) --* * **Unless** *(list) --* The "unless conditions" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed. * *(dict) --* The conditional expression used to evaluate an email for determining if a rule action should be taken. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "BooleanExpression", "StringExpression", "NumberExpression", "IpExpression", "VerdictExpression", "DmarcExpression". * **BooleanExpression** *(dict) --* The condition applies to a boolean expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis", "IsInAddressList". * **Attribute** *(string) --* The boolean type representing the allowed attribute types for an email. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a boolean condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression. * **Attribute** *(string) --* **[REQUIRED]** The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* **[REQUIRED]** The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* **[REQUIRED]** The matching operator for a boolean condition expression. * **StringExpression** *(dict) --* The condition applies to a string expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The string to evaluate in a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "MimeHeaderAttribute", "Analysis". * **Attribute** *(string) --* The email attribute to evaluate in a string condition expression. * **MimeHeaderAttribute** *(string) --* The email MIME X-Header attribute to evaluate in a string condition expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a string condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a string condition expression. * **Values** *(list) --* **[REQUIRED]** The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string. * *(string) --* * **NumberExpression** *(dict) --* The condition applies to a number expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The number to evaluate in a numeric condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An email attribute that is used as the number to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator for a numeric condition expression. * **Value** *(float) --* **[REQUIRED]** The value to evaluate in a numeric condition expression. * **IpExpression** *(dict) --* The condition applies to an IP address expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The IP address to evaluate in this condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The attribute of the email to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to evaluate the IP address. * **Values** *(list) --* **[REQUIRED]** The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges. * *(string) --* * **VerdictExpression** *(dict) --* The condition applies to a verdict expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The verdict to evaluate in a verdict condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis". * **Attribute** *(string) --* The email verdict attribute to evaluate in a string verdict expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a verdict condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a verdict condition expression. * **Values** *(list) --* **[REQUIRED]** The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email. * *(string) --* * **DmarcExpression** *(dict) --* The condition applies to a DMARC policy expression passed in this field. * **Operator** *(string) --* **[REQUIRED]** The operator to apply to the DMARC policy of the incoming email. * **Values** *(list) --* **[REQUIRED]** The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match. * *(dict) --* The action for a rule to take. Only one of the contained actions can be set. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Drop", "Relay", "Archive", "WriteToS3", "Send", "AddHeader", "ReplaceRecipient", "DeliverToMailbox", "DeliverToQBusiness", "PublishToSns". * **Drop** *(dict) --* This action terminates the evaluation of rules in the rule set. * **Relay** *(dict) --* This action relays the email to another SMTP server. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted. * **Relay** *(string) --* **[REQUIRED]** The identifier of the relay resource to be used when relaying an email. * **MailFrom** *(string) --* This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server. * **Archive** *(dict) --* This action archives the email. This can be used to deliver an email to an archive. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted. * **TargetArchive** *(string) --* **[REQUIRED]** The identifier of the archive to send the email to. * **WriteToS3** *(dict) --* This action writes the MIME content of the email to an S3 bucket. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket. * **S3Bucket** *(string) --* **[REQUIRED]** The bucket name of the S3 bucket to write to. * **S3Prefix** *(string) --* The S3 prefix to use for the write to the s3 bucket. * **S3SseKmsKeyId** *(string) --* The KMS Key ID to use to encrypt the message in S3. * **Send** *(dict) --* This action sends the email to the internet. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API. * **AddHeader** *(dict) --* This action adds a header. This can be used to add arbitrary email headers. * **HeaderName** *(string) --* **[REQUIRED]** The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email. * **HeaderValue** *(string) --* **[REQUIRED]** The value of the header to add to the email. * **ReplaceRecipient** *(dict) --* The action replaces certain or all recipients with a different set of recipients. * **ReplaceWith** *(list) --* This action specifies the replacement recipient email addresses to insert. * *(string) --* * **DeliverToMailbox** *(dict) --* This action delivers an email to a WorkMail mailbox. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid. * **MailboxArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API. * **DeliverToQBusiness** *(dict) --* This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the "qbusiness:BatchPutDocument" API. * **ApplicationId** *(string) --* **[REQUIRED]** The unique identifier of the Amazon Q Business application instance where the email content will be delivered. * **IndexId** *(string) --* **[REQUIRED]** The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the "qbusiness:BatchPutDocument" API for the given application and index. * **PublishToSns** *(dict) --* This action publishes the email content to an Amazon SNS topic. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the "sns:Publish" API. * **TopicArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the "sns:Publish" API for the given topic. * **Encoding** *(string) --* The encoding to use for the email within the Amazon SNS notification. The default value is "UTF-8". Use "BASE64" if you need to preserve all special characters, especially when the original message uses a different encoding format. * **PayloadType** *(string) --* The expected payload type within the Amazon SNS notification. "CONTENT" attempts to publish the full email content with 20KB of headers content. "HEADERS" extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is "CONTENT". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / update_traffic_policy update_traffic_policy ********************* MailManager.Client.update_traffic_policy(**kwargs) Update attributes of an already provisioned traffic policy resource. See also: AWS API Documentation **Request Syntax** response = client.update_traffic_policy( TrafficPolicyId='string', TrafficPolicyName='string', PolicyStatements=[ { 'Conditions': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'RECIPIENT', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SENDER_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'Ipv6Expression': { 'Evaluate': { 'Attribute': 'SENDER_IPV6' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'TlsExpression': { 'Evaluate': { 'Attribute': 'TLS_PROTOCOL' }, 'Operator': 'MINIMUM_TLS_VERSION'|'IS', 'Value': 'TLS1_2'|'TLS1_3' }, 'BooleanExpression': { 'Evaluate': { 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Action': 'ALLOW'|'DENY' }, ], DefaultAction='ALLOW'|'DENY', MaxMessageSizeBytes=123 ) Parameters: * **TrafficPolicyId** (*string*) -- **[REQUIRED]** The identifier of the traffic policy that you want to update. * **TrafficPolicyName** (*string*) -- A user-friendly name for the traffic policy resource. * **PolicyStatements** (*list*) -- The list of conditions to be updated for filtering email traffic. * *(dict) --* The structure containing traffic policy conditions and actions. * **Conditions** *(list) --* **[REQUIRED]** The list of conditions to apply to incoming messages for filtering email traffic. * *(dict) --* The email traffic filtering conditions which are contained in a traffic policy resource. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringExpression", "IpExpression", "Ipv6Expression", "TlsExpression", "BooleanExpression". * **StringExpression** *(dict) --* This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis". * **Attribute** *(string) --* The enum type representing the allowed attribute types for a string condition. * **Analysis** *(dict) --* The structure type for a string condition stating the Add On ARN and its returned value. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a string condition expression. * **Values** *(list) --* **[REQUIRED]** The right hand side argument of a string condition expression. * *(string) --* * **IpExpression** *(dict) --* This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of an IP condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An enum type representing the allowed attribute types for an IP condition. * **Operator** *(string) --* **[REQUIRED]** The matching operator for an IP condition expression. * **Values** *(list) --* **[REQUIRED]** The right hand side argument of an IP condition expression. * *(string) --* * **Ipv6Expression** *(dict) --* This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of an IPv6 condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An enum type representing the allowed attribute types for an IPv6 condition. * **Operator** *(string) --* **[REQUIRED]** The matching operator for an IPv6 condition expression. * **Values** *(list) --* **[REQUIRED]** The right hand side argument of an IPv6 condition expression. * *(string) --* * **TlsExpression** *(dict) --* This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of a TLS condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The enum type representing the allowed attribute types for the TLS condition. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a TLS condition expression. * **Value** *(string) --* **[REQUIRED]** The right hand side argument of a TLS condition expression. * **BooleanExpression** *(dict) --* This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Analysis", "IsInAddressList". * **Analysis** *(dict) --* The structure type for a boolean condition stating the Add On ARN and its returned value. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on. * **Attribute** *(string) --* **[REQUIRED]** The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* **[REQUIRED]** The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* **[REQUIRED]** The matching operator for a boolean condition expression. * **Action** *(string) --* **[REQUIRED]** The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement. * **DefaultAction** (*string*) -- Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements * **MaxMessageSizeBytes** (*integer*) -- The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / get_archive_export get_archive_export ****************** MailManager.Client.get_archive_export(**kwargs) Retrieves the details and current status of a specific email archive export job. See also: AWS API Documentation **Request Syntax** response = client.get_archive_export( ExportId='string' ) Parameters: **ExportId** (*string*) -- **[REQUIRED]** The identifier of the export job to get details for. Return type: dict Returns: **Response Syntax** { 'ArchiveId': 'string', 'Filters': { 'Include': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Unless': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ] }, 'FromTimestamp': datetime(2015, 1, 1), 'ToTimestamp': datetime(2015, 1, 1), 'MaxResults': 123, 'ExportDestinationConfiguration': { 'S3': { 'S3Location': 'string' } }, 'Status': { 'SubmissionTimestamp': datetime(2015, 1, 1), 'CompletionTimestamp': datetime(2015, 1, 1), 'State': 'QUEUED'|'PREPROCESSING'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED', 'ErrorMessage': 'string' } } **Response Structure** * *(dict) --* The response containing details of the specified archive export job. * **ArchiveId** *(string) --* The identifier of the archive the email export was performed from. * **Filters** *(dict) --* The criteria used to filter emails included in the export. * **Include** *(list) --* The filter conditions for emails to include. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringExpression", "BooleanExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The operator to use when evaluating the string values. * **Values** *(list) --* The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The boolean operator to use for evaluation. * **Unless** *(list) --* The filter conditions for emails to exclude. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringExpression", "BooleanExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The operator to use when evaluating the string values. * **Values** *(list) --* The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The boolean operator to use for evaluation. * **FromTimestamp** *(datetime) --* The start of the timestamp range the exported emails cover. * **ToTimestamp** *(datetime) --* The end of the date range the exported emails cover. * **MaxResults** *(integer) --* The maximum number of email items included in the export. * **ExportDestinationConfiguration** *(dict) --* Where the exported emails are being delivered. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "S3". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **S3** *(dict) --* Configuration for delivering to an Amazon S3 bucket. * **S3Location** *(string) --* The S3 location to deliver the exported email data. * **Status** *(dict) --* The current status of the export job. * **SubmissionTimestamp** *(datetime) --* The timestamp of when the export job was submitted. * **CompletionTimestamp** *(datetime) --* The timestamp of when the export job completed (if finished). * **State** *(string) --* The current state of the export job. * **ErrorMessage** *(string) --* An error message if the export job failed. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / update_ingress_point update_ingress_point ******************** MailManager.Client.update_ingress_point(**kwargs) Update attributes of a provisioned ingress endpoint resource. See also: AWS API Documentation **Request Syntax** response = client.update_ingress_point( IngressPointId='string', IngressPointName='string', StatusToUpdate='ACTIVE'|'CLOSED', RuleSetId='string', TrafficPolicyId='string', IngressPointConfiguration={ 'SmtpPassword': 'string', 'SecretArn': 'string' } ) Parameters: * **IngressPointId** (*string*) -- **[REQUIRED]** The identifier for the ingress endpoint you want to update. * **IngressPointName** (*string*) -- A user friendly name for the ingress endpoint resource. * **StatusToUpdate** (*string*) -- The update status of an ingress endpoint. * **RuleSetId** (*string*) -- The identifier of an existing rule set that you attach to an ingress endpoint resource. * **TrafficPolicyId** (*string*) -- The identifier of an existing traffic policy that you attach to an ingress endpoint resource. * **IngressPointConfiguration** (*dict*) -- If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SmtpPassword", "SecretArn". * **SmtpPassword** *(string) --* The password of the ingress endpoint resource. * **SecretArn** *(string) --* The SecretsManager::Secret ARN of the ingress endpoint resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / can_paginate can_paginate ************ MailManager.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. MailManager / Client / delete_archive delete_archive ************** MailManager.Client.delete_archive(**kwargs) Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period. See also: AWS API Documentation **Request Syntax** response = client.delete_archive( ArchiveId='string' ) Parameters: **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response indicating if the archive deletion was successfully initiated. On success, returns an HTTP 200 status code. On failure, returns an error message. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / delete_addon_subscription delete_addon_subscription ************************* MailManager.Client.delete_addon_subscription(**kwargs) Deletes an Add On subscription. See also: AWS API Documentation **Request Syntax** response = client.delete_addon_subscription( AddonSubscriptionId='string' ) Parameters: **AddonSubscriptionId** (*string*) -- **[REQUIRED]** The Add On subscription ID to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / stop_archive_search stop_archive_search ******************* MailManager.Client.stop_archive_search(**kwargs) Stops an in-progress archive search job. See also: AWS API Documentation **Request Syntax** response = client.stop_archive_search( SearchId='string' ) Parameters: **SearchId** (*string*) -- **[REQUIRED]** The identifier of the search job to stop. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response indicating if the request to stop the search job succeeded. On success, returns an HTTP 200 status code. On failure, returns an error message. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / delete_ingress_point delete_ingress_point ******************** MailManager.Client.delete_ingress_point(**kwargs) Delete an ingress endpoint resource. See also: AWS API Documentation **Request Syntax** response = client.delete_ingress_point( IngressPointId='string' ) Parameters: **IngressPointId** (*string*) -- **[REQUIRED]** The identifier of the ingress endpoint resource that you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / get_archive_search get_archive_search ****************** MailManager.Client.get_archive_search(**kwargs) Retrieves the details and current status of a specific email archive search job. See also: AWS API Documentation **Request Syntax** response = client.get_archive_search( SearchId='string' ) Parameters: **SearchId** (*string*) -- **[REQUIRED]** The identifier of the search job to get details for. Return type: dict Returns: **Response Syntax** { 'ArchiveId': 'string', 'Filters': { 'Include': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Unless': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ] }, 'FromTimestamp': datetime(2015, 1, 1), 'ToTimestamp': datetime(2015, 1, 1), 'MaxResults': 123, 'Status': { 'SubmissionTimestamp': datetime(2015, 1, 1), 'CompletionTimestamp': datetime(2015, 1, 1), 'State': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED', 'ErrorMessage': 'string' } } **Response Structure** * *(dict) --* The response containing details of the specified archive search job. * **ArchiveId** *(string) --* The identifier of the archive the email search was performed in. * **Filters** *(dict) --* The criteria used to filter emails included in the search. * **Include** *(list) --* The filter conditions for emails to include. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringExpression", "BooleanExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The operator to use when evaluating the string values. * **Values** *(list) --* The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The boolean operator to use for evaluation. * **Unless** *(list) --* The filter conditions for emails to exclude. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringExpression", "BooleanExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The operator to use when evaluating the string values. * **Values** *(list) --* The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* The boolean operator to use for evaluation. * **FromTimestamp** *(datetime) --* The start timestamp of the range the searched emails cover. * **ToTimestamp** *(datetime) --* The end timestamp of the range the searched emails cover. * **MaxResults** *(integer) --* The maximum number of search results to return. * **Status** *(dict) --* The current status of the search job. * **SubmissionTimestamp** *(datetime) --* The timestamp of when the search was submitted. * **CompletionTimestamp** *(datetime) --* The timestamp of when the search completed (if finished). * **State** *(string) --* The current state of the search job. * **ErrorMessage** *(string) --* An error message if the search failed. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / create_rule_set create_rule_set *************** MailManager.Client.create_rule_set(**kwargs) Provision a new rule set. See also: AWS API Documentation **Request Syntax** response = client.create_rule_set( ClientToken='string', RuleSetName='string', Rules=[ { 'Name': 'string', 'Conditions': [ { 'BooleanExpression': { 'Evaluate': { 'Attribute': 'READ_RECEIPT_REQUESTED'|'TLS'|'TLS_WRAPPED', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT'|'MAIL_FROM'|'SENDER'|'FROM'|'TO'|'CC', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' }, 'StringExpression': { 'Evaluate': { 'Attribute': 'MAIL_FROM'|'HELO'|'RECIPIENT'|'SENDER'|'FROM'|'SUBJECT'|'TO'|'CC', 'MimeHeaderAttribute': 'string', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'NumberExpression': { 'Evaluate': { 'Attribute': 'MESSAGE_SIZE' }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'LESS_THAN'|'GREATER_THAN'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN_OR_EQUAL', 'Value': 123.0 }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SOURCE_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'VerdictExpression': { 'Evaluate': { 'Attribute': 'SPF'|'DKIM', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'PASS'|'FAIL'|'GRAY'|'PROCESSING_FAILED', ] }, 'DmarcExpression': { 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'NONE'|'QUARANTINE'|'REJECT', ] } }, ], 'Unless': [ { 'BooleanExpression': { 'Evaluate': { 'Attribute': 'READ_RECEIPT_REQUESTED'|'TLS'|'TLS_WRAPPED', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT'|'MAIL_FROM'|'SENDER'|'FROM'|'TO'|'CC', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' }, 'StringExpression': { 'Evaluate': { 'Attribute': 'MAIL_FROM'|'HELO'|'RECIPIENT'|'SENDER'|'FROM'|'SUBJECT'|'TO'|'CC', 'MimeHeaderAttribute': 'string', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'NumberExpression': { 'Evaluate': { 'Attribute': 'MESSAGE_SIZE' }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'LESS_THAN'|'GREATER_THAN'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN_OR_EQUAL', 'Value': 123.0 }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SOURCE_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'VerdictExpression': { 'Evaluate': { 'Attribute': 'SPF'|'DKIM', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'PASS'|'FAIL'|'GRAY'|'PROCESSING_FAILED', ] }, 'DmarcExpression': { 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'NONE'|'QUARANTINE'|'REJECT', ] } }, ], 'Actions': [ { 'Drop': {} , 'Relay': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'Relay': 'string', 'MailFrom': 'REPLACE'|'PRESERVE' }, 'Archive': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'TargetArchive': 'string' }, 'WriteToS3': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'RoleArn': 'string', 'S3Bucket': 'string', 'S3Prefix': 'string', 'S3SseKmsKeyId': 'string' }, 'Send': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'RoleArn': 'string' }, 'AddHeader': { 'HeaderName': 'string', 'HeaderValue': 'string' }, 'ReplaceRecipient': { 'ReplaceWith': [ 'string', ] }, 'DeliverToMailbox': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'MailboxArn': 'string', 'RoleArn': 'string' }, 'DeliverToQBusiness': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'ApplicationId': 'string', 'IndexId': 'string', 'RoleArn': 'string' }, 'PublishToSns': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'TopicArn': 'string', 'RoleArn': 'string', 'Encoding': 'UTF-8'|'BASE64', 'PayloadType': 'HEADERS'|'CONTENT' } }, ] }, ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **RuleSetName** (*string*) -- **[REQUIRED]** A user-friendly name for the rule set. * **Rules** (*list*) -- **[REQUIRED]** Conditional rules that are evaluated for determining actions on email. * *(dict) --* A rule contains conditions, "unless conditions" and actions. For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions". * **Name** *(string) --* The user-friendly name of the rule. * **Conditions** *(list) --* The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions" * *(dict) --* The conditional expression used to evaluate an email for determining if a rule action should be taken. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "BooleanExpression", "StringExpression", "NumberExpression", "IpExpression", "VerdictExpression", "DmarcExpression". * **BooleanExpression** *(dict) --* The condition applies to a boolean expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis", "IsInAddressList". * **Attribute** *(string) --* The boolean type representing the allowed attribute types for an email. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a boolean condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression. * **Attribute** *(string) --* **[REQUIRED]** The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* **[REQUIRED]** The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* **[REQUIRED]** The matching operator for a boolean condition expression. * **StringExpression** *(dict) --* The condition applies to a string expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The string to evaluate in a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "MimeHeaderAttribute", "Analysis". * **Attribute** *(string) --* The email attribute to evaluate in a string condition expression. * **MimeHeaderAttribute** *(string) --* The email MIME X-Header attribute to evaluate in a string condition expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a string condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a string condition expression. * **Values** *(list) --* **[REQUIRED]** The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string. * *(string) --* * **NumberExpression** *(dict) --* The condition applies to a number expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The number to evaluate in a numeric condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An email attribute that is used as the number to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator for a numeric condition expression. * **Value** *(float) --* **[REQUIRED]** The value to evaluate in a numeric condition expression. * **IpExpression** *(dict) --* The condition applies to an IP address expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The IP address to evaluate in this condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The attribute of the email to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to evaluate the IP address. * **Values** *(list) --* **[REQUIRED]** The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges. * *(string) --* * **VerdictExpression** *(dict) --* The condition applies to a verdict expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The verdict to evaluate in a verdict condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis". * **Attribute** *(string) --* The email verdict attribute to evaluate in a string verdict expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a verdict condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a verdict condition expression. * **Values** *(list) --* **[REQUIRED]** The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email. * *(string) --* * **DmarcExpression** *(dict) --* The condition applies to a DMARC policy expression passed in this field. * **Operator** *(string) --* **[REQUIRED]** The operator to apply to the DMARC policy of the incoming email. * **Values** *(list) --* **[REQUIRED]** The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match. * *(string) --* * **Unless** *(list) --* The "unless conditions" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed. * *(dict) --* The conditional expression used to evaluate an email for determining if a rule action should be taken. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "BooleanExpression", "StringExpression", "NumberExpression", "IpExpression", "VerdictExpression", "DmarcExpression". * **BooleanExpression** *(dict) --* The condition applies to a boolean expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis", "IsInAddressList". * **Attribute** *(string) --* The boolean type representing the allowed attribute types for an email. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a boolean condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression. * **Attribute** *(string) --* **[REQUIRED]** The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* **[REQUIRED]** The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* **[REQUIRED]** The matching operator for a boolean condition expression. * **StringExpression** *(dict) --* The condition applies to a string expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The string to evaluate in a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "MimeHeaderAttribute", "Analysis". * **Attribute** *(string) --* The email attribute to evaluate in a string condition expression. * **MimeHeaderAttribute** *(string) --* The email MIME X-Header attribute to evaluate in a string condition expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a string condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a string condition expression. * **Values** *(list) --* **[REQUIRED]** The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string. * *(string) --* * **NumberExpression** *(dict) --* The condition applies to a number expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The number to evaluate in a numeric condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An email attribute that is used as the number to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator for a numeric condition expression. * **Value** *(float) --* **[REQUIRED]** The value to evaluate in a numeric condition expression. * **IpExpression** *(dict) --* The condition applies to an IP address expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The IP address to evaluate in this condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The attribute of the email to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to evaluate the IP address. * **Values** *(list) --* **[REQUIRED]** The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges. * *(string) --* * **VerdictExpression** *(dict) --* The condition applies to a verdict expression passed in this field. * **Evaluate** *(dict) --* **[REQUIRED]** The verdict to evaluate in a verdict condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis". * **Attribute** *(string) --* The email verdict attribute to evaluate in a string verdict expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a verdict condition expression. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a verdict condition expression. * **Values** *(list) --* **[REQUIRED]** The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email. * *(string) --* * **DmarcExpression** *(dict) --* The condition applies to a DMARC policy expression passed in this field. * **Operator** *(string) --* **[REQUIRED]** The operator to apply to the DMARC policy of the incoming email. * **Values** *(list) --* **[REQUIRED]** The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match. * *(dict) --* The action for a rule to take. Only one of the contained actions can be set. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Drop", "Relay", "Archive", "WriteToS3", "Send", "AddHeader", "ReplaceRecipient", "DeliverToMailbox", "DeliverToQBusiness", "PublishToSns". * **Drop** *(dict) --* This action terminates the evaluation of rules in the rule set. * **Relay** *(dict) --* This action relays the email to another SMTP server. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted. * **Relay** *(string) --* **[REQUIRED]** The identifier of the relay resource to be used when relaying an email. * **MailFrom** *(string) --* This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server. * **Archive** *(dict) --* This action archives the email. This can be used to deliver an email to an archive. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted. * **TargetArchive** *(string) --* **[REQUIRED]** The identifier of the archive to send the email to. * **WriteToS3** *(dict) --* This action writes the MIME content of the email to an S3 bucket. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket. * **S3Bucket** *(string) --* **[REQUIRED]** The bucket name of the S3 bucket to write to. * **S3Prefix** *(string) --* The S3 prefix to use for the write to the s3 bucket. * **S3SseKmsKeyId** *(string) --* The KMS Key ID to use to encrypt the message in S3. * **Send** *(dict) --* This action sends the email to the internet. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API. * **AddHeader** *(dict) --* This action adds a header. This can be used to add arbitrary email headers. * **HeaderName** *(string) --* **[REQUIRED]** The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email. * **HeaderValue** *(string) --* **[REQUIRED]** The value of the header to add to the email. * **ReplaceRecipient** *(dict) --* The action replaces certain or all recipients with a different set of recipients. * **ReplaceWith** *(list) --* This action specifies the replacement recipient email addresses to insert. * *(string) --* * **DeliverToMailbox** *(dict) --* This action delivers an email to a WorkMail mailbox. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid. * **MailboxArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API. * **DeliverToQBusiness** *(dict) --* This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the "qbusiness:BatchPutDocument" API. * **ApplicationId** *(string) --* **[REQUIRED]** The unique identifier of the Amazon Q Business application instance where the email content will be delivered. * **IndexId** *(string) --* **[REQUIRED]** The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the "qbusiness:BatchPutDocument" API for the given application and index. * **PublishToSns** *(dict) --* This action publishes the email content to an Amazon SNS topic. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the "sns:Publish" API. * **TopicArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the "sns:Publish" API for the given topic. * **Encoding** *(string) --* The encoding to use for the email within the Amazon SNS notification. The default value is "UTF-8". Use "BASE64" if you need to preserve all special characters, especially when the original message uses a different encoding format. * **PayloadType** *(string) --* The expected payload type within the Amazon SNS notification. "CONTENT" attempts to publish the full email content with 20KB of headers content. "HEADERS" extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is "CONTENT". * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'RuleSetId': 'string' } **Response Structure** * *(dict) --* * **RuleSetId** *(string) --* The identifier of the created rule set. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / create_archive create_archive ************** MailManager.Client.create_archive(**kwargs) Creates a new email archive resource for storing and retaining emails. See also: AWS API Documentation **Request Syntax** response = client.create_archive( ClientToken='string', ArchiveName='string', Retention={ 'RetentionPeriod': 'THREE_MONTHS'|'SIX_MONTHS'|'NINE_MONTHS'|'ONE_YEAR'|'EIGHTEEN_MONTHS'|'TWO_YEARS'|'THIRTY_MONTHS'|'THREE_YEARS'|'FOUR_YEARS'|'FIVE_YEARS'|'SIX_YEARS'|'SEVEN_YEARS'|'EIGHT_YEARS'|'NINE_YEARS'|'TEN_YEARS'|'PERMANENT' }, KmsKeyArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token Amazon SES uses to recognize retries of this request. This field is autopopulated if not provided. * **ArchiveName** (*string*) -- **[REQUIRED]** A unique name for the new archive. * **Retention** (*dict*) -- The period for retaining emails in the archive before automatic deletion. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "RetentionPeriod". * **RetentionPeriod** *(string) --* The enum value sets the period for retaining emails in an archive. * **KmsKeyArn** (*string*) -- The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'ArchiveId': 'string' } **Response Structure** * *(dict) --* The response from creating a new email archive. * **ArchiveId** *(string) --* The unique identifier for the newly created archive. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / list_addon_instances list_addon_instances ******************** MailManager.Client.list_addon_instances(**kwargs) Lists all Add On instances in your account. See also: AWS API Documentation **Request Syntax** response = client.list_addon_instances( NextToken='string', PageSize=123 ) Parameters: * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. * **PageSize** (*integer*) -- The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. Return type: dict Returns: **Response Syntax** { 'AddonInstances': [ { 'AddonInstanceId': 'string', 'AddonSubscriptionId': 'string', 'AddonName': 'string', 'AddonInstanceArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AddonInstances** *(list) --* The list of ingress endpoints. * *(dict) --* An Add On instance represents a specific configuration of an Add On. * **AddonInstanceId** *(string) --* The unique ID of the Add On instance. * **AddonSubscriptionId** *(string) --* The subscription ID for the instance. * **AddonName** *(string) --* The name of the Add On for the instance. * **AddonInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the Add On instance. * **CreatedTimestamp** *(datetime) --* The timestamp of when the Add On instance was created. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" MailManager / Client / delete_address_list delete_address_list ******************* MailManager.Client.delete_address_list(**kwargs) Deletes an address list. See also: AWS API Documentation **Request Syntax** response = client.delete_address_list( AddressListId='string' ) Parameters: **AddressListId** (*string*) -- **[REQUIRED]** The identifier of an existing address list resource to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / delete_relay delete_relay ************ MailManager.Client.delete_relay(**kwargs) Deletes an existing relay resource. See also: AWS API Documentation **Request Syntax** response = client.delete_relay( RelayId='string' ) Parameters: **RelayId** (*string*) -- **[REQUIRED]** The unique relay identifier. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / list_tags_for_resource list_tags_for_resource ********************** MailManager.Client.list_tags_for_resource(**kwargs) Retrieves the list of tags (keys and values) assigned to the resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to retrieve tags from. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* The key of the key-value tag. * **Value** *(string) --* The value of the key-value tag. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / start_archive_search start_archive_search ******************** MailManager.Client.start_archive_search(**kwargs) Initiates a search across emails in the specified archive. See also: AWS API Documentation **Request Syntax** response = client.start_archive_search( ArchiveId='string', Filters={ 'Include': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Unless': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ] }, FromTimestamp=datetime(2015, 1, 1), ToTimestamp=datetime(2015, 1, 1), MaxResults=123 ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive to search emails in. * **Filters** (*dict*) -- Criteria to filter which emails are included in the search results. * **Include** *(list) --* The filter conditions for emails to include. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringExpression", "BooleanExpression". * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to use when evaluating the string values. * **Values** *(list) --* **[REQUIRED]** The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The boolean operator to use for evaluation. * **Unless** *(list) --* The filter conditions for emails to exclude. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringExpression", "BooleanExpression". * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to use when evaluating the string values. * **Values** *(list) --* **[REQUIRED]** The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The boolean operator to use for evaluation. * **FromTimestamp** (*datetime*) -- **[REQUIRED]** The start timestamp of the range to search emails from. * **ToTimestamp** (*datetime*) -- **[REQUIRED]** The end timestamp of the range to search emails from. * **MaxResults** (*integer*) -- **[REQUIRED]** The maximum number of search results to return. Return type: dict Returns: **Response Syntax** { 'SearchId': 'string' } **Response Structure** * *(dict) --* The response from initiating an archive search. * **SearchId** *(string) --* The unique identifier for the initiated search job. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / stop_address_list_import_job stop_address_list_import_job **************************** MailManager.Client.stop_address_list_import_job(**kwargs) Stops an ongoing import job for an address list. See also: AWS API Documentation **Request Syntax** response = client.stop_address_list_import_job( JobId='string' ) Parameters: **JobId** (*string*) -- **[REQUIRED]** The identifier of the import job that needs to be stopped. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / list_members_of_address_list list_members_of_address_list **************************** MailManager.Client.list_members_of_address_list(**kwargs) Lists members of an address list. See also: AWS API Documentation **Request Syntax** response = client.list_members_of_address_list( AddressListId='string', Filter={ 'AddressPrefix': 'string' }, NextToken='string', PageSize=123 ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list to list the addresses from. * **Filter** (*dict*) -- Filter to be used to limit the results. * **AddressPrefix** *(string) --* Filter to limit the results to addresses having the provided prefix. * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. * **PageSize** (*integer*) -- The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members. Return type: dict Returns: **Response Syntax** { 'Addresses': [ { 'Address': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Addresses** *(list) --* The list of addresses. * *(dict) --* An address that is a member of an address list. * **Address** *(string) --* The email or domain that constitutes the address. * **CreatedTimestamp** *(datetime) --* The timestamp of when the address was added to the address list. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / list_relays list_relays *********** MailManager.Client.list_relays(**kwargs) Lists all the existing relay resources. See also: AWS API Documentation **Request Syntax** response = client.list_relays( PageSize=123, NextToken='string' ) Parameters: * **PageSize** (*integer*) -- The number of relays to be returned in one request. * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. Return type: dict Returns: **Response Syntax** { 'Relays': [ { 'RelayId': 'string', 'RelayName': 'string', 'LastModifiedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Relays** *(list) --* The list of returned relays. * *(dict) --* The relay resource that can be used as a rule to relay receiving emails to the destination relay server. * **RelayId** *(string) --* The unique relay identifier. * **RelayName** *(string) --* The unique relay name. * **LastModifiedTimestamp** *(datetime) --* The timestamp of when the relay was last modified. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" MailManager / Client / update_archive update_archive ************** MailManager.Client.update_archive(**kwargs) Updates the attributes of an existing email archive. See also: AWS API Documentation **Request Syntax** response = client.update_archive( ArchiveId='string', ArchiveName='string', Retention={ 'RetentionPeriod': 'THREE_MONTHS'|'SIX_MONTHS'|'NINE_MONTHS'|'ONE_YEAR'|'EIGHTEEN_MONTHS'|'TWO_YEARS'|'THIRTY_MONTHS'|'THREE_YEARS'|'FOUR_YEARS'|'FIVE_YEARS'|'SIX_YEARS'|'SEVEN_YEARS'|'EIGHT_YEARS'|'NINE_YEARS'|'TEN_YEARS'|'PERMANENT' } ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive to update. * **ArchiveName** (*string*) -- A new, unique name for the archive. * **Retention** (*dict*) -- A new retention period for emails in the archive. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "RetentionPeriod". * **RetentionPeriod** *(string) --* The enum value sets the period for retaining emails in an archive. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response indicating if the archive update succeeded or failed. On success, returns an HTTP 200 status code. On failure, returns an error message. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / list_archive_exports list_archive_exports ******************** MailManager.Client.list_archive_exports(**kwargs) Returns a list of email archive export jobs. See also: AWS API Documentation **Request Syntax** response = client.list_archive_exports( ArchiveId='string', NextToken='string', PageSize=123 ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive. * **NextToken** (*string*) -- If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. * **PageSize** (*integer*) -- The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives. Return type: dict Returns: **Response Syntax** { 'Exports': [ { 'ExportId': 'string', 'Status': { 'SubmissionTimestamp': datetime(2015, 1, 1), 'CompletionTimestamp': datetime(2015, 1, 1), 'State': 'QUEUED'|'PREPROCESSING'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED', 'ErrorMessage': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response containing a list of archive export jobs and their statuses. * **Exports** *(list) --* The list of export job identifiers and statuses. * *(dict) --* Summary statuses of an archive export job. * **ExportId** *(string) --* The unique identifier of the export job. * **Status** *(dict) --* The current status of the export job. * **SubmissionTimestamp** *(datetime) --* The timestamp of when the export job was submitted. * **CompletionTimestamp** *(datetime) --* The timestamp of when the export job completed (if finished). * **State** *(string) --* The current state of the export job. * **ErrorMessage** *(string) --* An error message if the export job failed. * **NextToken** *(string) --* If present, use to retrieve the next page of results. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / untag_resource untag_resource ************** MailManager.Client.untag_resource(**kwargs) Remove one or more tags (keys and values) from a specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to untag. * **TagKeys** (*list*) -- **[REQUIRED]** The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / list_archives list_archives ************* MailManager.Client.list_archives(**kwargs) Returns a list of all email archives in your account. See also: AWS API Documentation **Request Syntax** response = client.list_archives( NextToken='string', PageSize=123 ) Parameters: * **NextToken** (*string*) -- If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. * **PageSize** (*integer*) -- The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives. Return type: dict Returns: **Response Syntax** { 'Archives': [ { 'ArchiveId': 'string', 'ArchiveName': 'string', 'ArchiveState': 'ACTIVE'|'PENDING_DELETION', 'LastUpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response containing a list of your email archives. * **Archives** *(list) --* The list of archive details. * *(dict) --* An archive resource for storing and retaining emails. * **ArchiveId** *(string) --* The unique identifier of the archive. * **ArchiveName** *(string) --* The unique name assigned to the archive. * **ArchiveState** *(string) --* The current state of the archive: * "ACTIVE" – The archive is ready and available for use. * "PENDING_DELETION" – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the archive was last updated. * **NextToken** *(string) --* If present, use to retrieve the next page of results. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_waiter get_waiter ********** MailManager.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" MailManager / Client / list_rule_sets list_rule_sets ************** MailManager.Client.list_rule_sets(**kwargs) List rule sets for this account. See also: AWS API Documentation **Request Syntax** response = client.list_rule_sets( NextToken='string', PageSize=123 ) Parameters: * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. * **PageSize** (*integer*) -- The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets. Return type: dict Returns: **Response Syntax** { 'RuleSets': [ { 'RuleSetId': 'string', 'RuleSetName': 'string', 'LastModificationDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RuleSets** *(list) --* The list of rule sets. * *(dict) --* A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email. * **RuleSetId** *(string) --* The identifier of the rule set. * **RuleSetName** *(string) --* A user-friendly name for the rule set. * **LastModificationDate** *(datetime) --* The last modification date of the rule set. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" MailManager / Client / list_address_list_import_jobs list_address_list_import_jobs ***************************** MailManager.Client.list_address_list_import_jobs(**kwargs) Lists jobs for an address list. See also: AWS API Documentation **Request Syntax** response = client.list_address_list_import_jobs( AddressListId='string', NextToken='string', PageSize=123 ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list for listing import jobs. * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. * **PageSize** (*integer*) -- The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs. Return type: dict Returns: **Response Syntax** { 'ImportJobs': [ { 'JobId': 'string', 'Name': 'string', 'Status': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'STOPPED', 'PreSignedUrl': 'string', 'ImportedItemsCount': 123, 'FailedItemsCount': 123, 'ImportDataFormat': { 'ImportDataType': 'CSV'|'JSON' }, 'AddressListId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'StartTimestamp': datetime(2015, 1, 1), 'CompletedTimestamp': datetime(2015, 1, 1), 'Error': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ImportJobs** *(list) --* The list of import jobs. * *(dict) --* Details about an import job. * **JobId** *(string) --* The identifier of the import job. * **Name** *(string) --* A user-friendly name for the import job. * **Status** *(string) --* The status of the import job. * **PreSignedUrl** *(string) --* The pre-signed URL target for uploading the input file. * **ImportedItemsCount** *(integer) --* The number of addresses in the input that were successfully imported into the address list. * **FailedItemsCount** *(integer) --* The number of addresses in the input that failed to get imported into address list. * **ImportDataFormat** *(dict) --* The format of the input for the import job. * **ImportDataType** *(string) --* The type of file that would be passed as an input for the address list import job. * **AddressListId** *(string) --* The unique identifier of the address list the import job was created for. * **CreatedTimestamp** *(datetime) --* The timestamp of when the import job was created. * **StartTimestamp** *(datetime) --* The timestamp of when the import job was started. * **CompletedTimestamp** *(datetime) --* The timestamp of when the import job was completed. * **Error** *(string) --* The reason for failure of an import job. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / create_addon_instance create_addon_instance ********************* MailManager.Client.create_addon_instance(**kwargs) Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy. See also: AWS API Documentation **Request Syntax** response = client.create_addon_instance( ClientToken='string', AddonSubscriptionId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **AddonSubscriptionId** (*string*) -- **[REQUIRED]** The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'AddonInstanceId': 'string' } **Response Structure** * *(dict) --* * **AddonInstanceId** *(string) --* The unique ID of the Add On instance created by this API. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / delete_addon_instance delete_addon_instance ********************* MailManager.Client.delete_addon_instance(**kwargs) Deletes an Add On instance. See also: AWS API Documentation **Request Syntax** response = client.delete_addon_instance( AddonInstanceId='string' ) Parameters: **AddonInstanceId** (*string*) -- **[REQUIRED]** The Add On instance ID to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / get_ingress_point get_ingress_point ***************** MailManager.Client.get_ingress_point(**kwargs) Fetch ingress endpoint resource attributes. See also: AWS API Documentation **Request Syntax** response = client.get_ingress_point( IngressPointId='string' ) Parameters: **IngressPointId** (*string*) -- **[REQUIRED]** The identifier of an ingress endpoint. Return type: dict Returns: **Response Syntax** { 'IngressPointId': 'string', 'IngressPointName': 'string', 'IngressPointArn': 'string', 'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED', 'Type': 'OPEN'|'AUTH', 'ARecord': 'string', 'RuleSetId': 'string', 'TrafficPolicyId': 'string', 'IngressPointAuthConfiguration': { 'IngressPointPasswordConfiguration': { 'SmtpPasswordVersion': 'string', 'PreviousSmtpPasswordVersion': 'string', 'PreviousSmtpPasswordExpiryTimestamp': datetime(2015, 1, 1) }, 'SecretArn': 'string' }, 'NetworkConfiguration': { 'PublicNetworkConfiguration': { 'IpType': 'IPV4'|'DUAL_STACK' }, 'PrivateNetworkConfiguration': { 'VpcEndpointId': 'string' } }, 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **IngressPointId** *(string) --* The identifier of an ingress endpoint resource. * **IngressPointName** *(string) --* A user friendly name for the ingress endpoint. * **IngressPointArn** *(string) --* The Amazon Resource Name (ARN) of the ingress endpoint resource. * **Status** *(string) --* The status of the ingress endpoint resource. * **Type** *(string) --* The type of ingress endpoint. * **ARecord** *(string) --* The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager. * **RuleSetId** *(string) --* The identifier of a rule set resource associated with the ingress endpoint. * **TrafficPolicyId** *(string) --* The identifier of the traffic policy resource associated with the ingress endpoint. * **IngressPointAuthConfiguration** *(dict) --* The authentication configuration of the ingress endpoint resource. * **IngressPointPasswordConfiguration** *(dict) --* The ingress endpoint password configuration for the ingress endpoint resource. * **SmtpPasswordVersion** *(string) --* The current password expiry timestamp of the ingress endpoint resource. * **PreviousSmtpPasswordVersion** *(string) --* The previous password version of the ingress endpoint resource. * **PreviousSmtpPasswordExpiryTimestamp** *(datetime) --* The previous password expiry timestamp of the ingress endpoint resource. * **SecretArn** *(string) --* The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource. * **NetworkConfiguration** *(dict) --* The network configuration for the ingress point. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicNetworkConfiguration", "PrivateNetworkConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicNetworkConfiguration** *(dict) --* Specifies the network configuration for the public ingress point. * **IpType** *(string) --* The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK. * **PrivateNetworkConfiguration** *(dict) --* Specifies the network configuration for the private ingress point. * **VpcEndpointId** *(string) --* The identifier of the VPC endpoint to associate with this private ingress point. * **CreatedTimestamp** *(datetime) --* The timestamp of when the ingress endpoint was created. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the ingress endpoint was last updated. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / deregister_member_from_address_list deregister_member_from_address_list *********************************** MailManager.Client.deregister_member_from_address_list(**kwargs) Removes a member from an address list. See also: AWS API Documentation **Request Syntax** response = client.deregister_member_from_address_list( AddressListId='string', Address='string' ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list to remove the address from. * **Address** (*string*) -- **[REQUIRED]** The address to be removed from the address list. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_traffic_policy get_traffic_policy ****************** MailManager.Client.get_traffic_policy(**kwargs) Fetch attributes of a traffic policy resource. See also: AWS API Documentation **Request Syntax** response = client.get_traffic_policy( TrafficPolicyId='string' ) Parameters: **TrafficPolicyId** (*string*) -- **[REQUIRED]** The identifier of the traffic policy resource. Return type: dict Returns: **Response Syntax** { 'TrafficPolicyName': 'string', 'TrafficPolicyId': 'string', 'TrafficPolicyArn': 'string', 'PolicyStatements': [ { 'Conditions': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'RECIPIENT', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SENDER_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'Ipv6Expression': { 'Evaluate': { 'Attribute': 'SENDER_IPV6' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'TlsExpression': { 'Evaluate': { 'Attribute': 'TLS_PROTOCOL' }, 'Operator': 'MINIMUM_TLS_VERSION'|'IS', 'Value': 'TLS1_2'|'TLS1_3' }, 'BooleanExpression': { 'Evaluate': { 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Action': 'ALLOW'|'DENY' }, ], 'MaxMessageSizeBytes': 123, 'DefaultAction': 'ALLOW'|'DENY', 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **TrafficPolicyName** *(string) --* A user-friendly name for the traffic policy resource. * **TrafficPolicyId** *(string) --* The identifier of the traffic policy resource. * **TrafficPolicyArn** *(string) --* The Amazon Resource Name (ARN) of the traffic policy resource. * **PolicyStatements** *(list) --* The list of conditions which are in the traffic policy resource. * *(dict) --* The structure containing traffic policy conditions and actions. * **Conditions** *(list) --* The list of conditions to apply to incoming messages for filtering email traffic. * *(dict) --* The email traffic filtering conditions which are contained in a traffic policy resource. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringExpression", "IpExpression", "Ipv6Expression", "TlsExpression", "BooleanExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **StringExpression** *(dict) --* This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* The left hand side argument of a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "Analysis". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The enum type representing the allowed attribute types for a string condition. * **Analysis** *(dict) --* The structure type for a string condition stating the Add On ARN and its returned value. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **Operator** *(string) --* The matching operator for a string condition expression. * **Values** *(list) --* The right hand side argument of a string condition expression. * *(string) --* * **IpExpression** *(dict) --* This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* The left hand side argument of an IP condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* An enum type representing the allowed attribute types for an IP condition. * **Operator** *(string) --* The matching operator for an IP condition expression. * **Values** *(list) --* The right hand side argument of an IP condition expression. * *(string) --* * **Ipv6Expression** *(dict) --* This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* The left hand side argument of an IPv6 condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* An enum type representing the allowed attribute types for an IPv6 condition. * **Operator** *(string) --* The matching operator for an IPv6 condition expression. * **Values** *(list) --* The right hand side argument of an IPv6 condition expression. * *(string) --* * **TlsExpression** *(dict) --* This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* The left hand side argument of a TLS condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The enum type representing the allowed attribute types for the TLS condition. * **Operator** *(string) --* The matching operator for a TLS condition expression. * **Value** *(string) --* The right hand side argument of a TLS condition expression. * **BooleanExpression** *(dict) --* This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Analysis", "IsInAddressList". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Analysis** *(dict) --* The structure type for a boolean condition stating the Add On ARN and its returned value. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on. * **Attribute** *(string) --* The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* The matching operator for a boolean condition expression. * **Action** *(string) --* The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement. * **MaxMessageSizeBytes** *(integer) --* The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked. * **DefaultAction** *(string) --* The default action of the traffic policy. * **CreatedTimestamp** *(datetime) --* The timestamp of when the traffic policy was created. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the traffic policy was last updated. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / start_archive_export start_archive_export ******************** MailManager.Client.start_archive_export(**kwargs) Initiates an export of emails from the specified archive. See also: AWS API Documentation **Request Syntax** response = client.start_archive_export( ArchiveId='string', Filters={ 'Include': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Unless': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM' }, 'Operator': 'CONTAINS', 'Values': [ 'string', ] }, 'BooleanExpression': { 'Evaluate': { 'Attribute': 'HAS_ATTACHMENTS' }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ] }, FromTimestamp=datetime(2015, 1, 1), ToTimestamp=datetime(2015, 1, 1), MaxResults=123, ExportDestinationConfiguration={ 'S3': { 'S3Location': 'string' } }, IncludeMetadata=True|False ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive to export emails from. * **Filters** (*dict*) -- Criteria to filter which emails are included in the export. * **Include** *(list) --* The filter conditions for emails to include. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringExpression", "BooleanExpression". * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to use when evaluating the string values. * **Values** *(list) --* **[REQUIRED]** The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The boolean operator to use for evaluation. * **Unless** *(list) --* The filter conditions for emails to exclude. * *(dict) --* A filter condition used to include or exclude emails when exporting from or searching an archive. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringExpression", "BooleanExpression". * **StringExpression** *(dict) --* A string expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The attribute of the email to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The operator to use when evaluating the string values. * **Values** *(list) --* **[REQUIRED]** The list of string values to evaluate the email attribute against. * *(string) --* * **BooleanExpression** *(dict) --* A boolean expression to evaluate against email attributes. * **Evaluate** *(dict) --* **[REQUIRED]** The email attribute value to evaluate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The name of the email attribute to evaluate. * **Operator** *(string) --* **[REQUIRED]** The boolean operator to use for evaluation. * **FromTimestamp** (*datetime*) -- **[REQUIRED]** The start of the timestamp range to include emails from. * **ToTimestamp** (*datetime*) -- **[REQUIRED]** The end of the timestamp range to include emails from. * **MaxResults** (*integer*) -- The maximum number of email items to include in the export. * **ExportDestinationConfiguration** (*dict*) -- **[REQUIRED]** Details on where to deliver the exported email data. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "S3". * **S3** *(dict) --* Configuration for delivering to an Amazon S3 bucket. * **S3Location** *(string) --* The S3 location to deliver the exported email data. * **IncludeMetadata** (*boolean*) -- Whether to include message metadata as JSON files in the export. Return type: dict Returns: **Response Syntax** { 'ExportId': 'string' } **Response Structure** * *(dict) --* The response from initiating an archive export. * **ExportId** *(string) --* The unique identifier for the initiated export job. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / create_addon_subscription create_addon_subscription ************************* MailManager.Client.create_addon_subscription(**kwargs) Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies. See also: AWS API Documentation **Request Syntax** response = client.create_addon_subscription( ClientToken='string', AddonName='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **AddonName** (*string*) -- **[REQUIRED]** The name of the Add On to subscribe to. You can only have one subscription for each Add On name. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'AddonSubscriptionId': 'string' } **Response Structure** * *(dict) --* * **AddonSubscriptionId** *(string) --* The unique ID of the Add On subscription created by this API. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / create_traffic_policy create_traffic_policy ********************* MailManager.Client.create_traffic_policy(**kwargs) Provision a new traffic policy resource. See also: AWS API Documentation **Request Syntax** response = client.create_traffic_policy( ClientToken='string', TrafficPolicyName='string', PolicyStatements=[ { 'Conditions': [ { 'StringExpression': { 'Evaluate': { 'Attribute': 'RECIPIENT', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SENDER_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'Ipv6Expression': { 'Evaluate': { 'Attribute': 'SENDER_IPV6' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'TlsExpression': { 'Evaluate': { 'Attribute': 'TLS_PROTOCOL' }, 'Operator': 'MINIMUM_TLS_VERSION'|'IS', 'Value': 'TLS1_2'|'TLS1_3' }, 'BooleanExpression': { 'Evaluate': { 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' } }, ], 'Action': 'ALLOW'|'DENY' }, ], DefaultAction='ALLOW'|'DENY', MaxMessageSizeBytes=123, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **TrafficPolicyName** (*string*) -- **[REQUIRED]** A user-friendly name for the traffic policy resource. * **PolicyStatements** (*list*) -- **[REQUIRED]** Conditional statements for filtering email traffic. * *(dict) --* The structure containing traffic policy conditions and actions. * **Conditions** *(list) --* **[REQUIRED]** The list of conditions to apply to incoming messages for filtering email traffic. * *(dict) --* The email traffic filtering conditions which are contained in a traffic policy resource. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringExpression", "IpExpression", "Ipv6Expression", "TlsExpression", "BooleanExpression". * **StringExpression** *(dict) --* This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute", "Analysis". * **Attribute** *(string) --* The enum type representing the allowed attribute types for a string condition. * **Analysis** *(dict) --* The structure type for a string condition stating the Add On ARN and its returned value. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a string condition expression. * **Values** *(list) --* **[REQUIRED]** The right hand side argument of a string condition expression. * *(string) --* * **IpExpression** *(dict) --* This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of an IP condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An enum type representing the allowed attribute types for an IP condition. * **Operator** *(string) --* **[REQUIRED]** The matching operator for an IP condition expression. * **Values** *(list) --* **[REQUIRED]** The right hand side argument of an IP condition expression. * *(string) --* * **Ipv6Expression** *(dict) --* This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of an IPv6 condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* An enum type representing the allowed attribute types for an IPv6 condition. * **Operator** *(string) --* **[REQUIRED]** The matching operator for an IPv6 condition expression. * **Values** *(list) --* **[REQUIRED]** The right hand side argument of an IPv6 condition expression. * *(string) --* * **TlsExpression** *(dict) --* This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The left hand side argument of a TLS condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Attribute". * **Attribute** *(string) --* The enum type representing the allowed attribute types for the TLS condition. * **Operator** *(string) --* **[REQUIRED]** The matching operator for a TLS condition expression. * **Value** *(string) --* **[REQUIRED]** The right hand side argument of a TLS condition expression. * **BooleanExpression** *(dict) --* This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'. * **Evaluate** *(dict) --* **[REQUIRED]** The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Analysis", "IsInAddressList". * **Analysis** *(dict) --* The structure type for a boolean condition stating the Add On ARN and its returned value. * **Analyzer** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* **[REQUIRED]** The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on. * **Attribute** *(string) --* **[REQUIRED]** The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* **[REQUIRED]** The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* **[REQUIRED]** The matching operator for a boolean condition expression. * **Action** *(string) --* **[REQUIRED]** The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement. * **DefaultAction** (*string*) -- **[REQUIRED]** Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements * **MaxMessageSizeBytes** (*integer*) -- The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'TrafficPolicyId': 'string' } **Response Structure** * *(dict) --* * **TrafficPolicyId** *(string) --* The identifier of the traffic policy resource. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / get_address_list get_address_list **************** MailManager.Client.get_address_list(**kwargs) Fetch attributes of an address list. See also: AWS API Documentation **Request Syntax** response = client.get_address_list( AddressListId='string' ) Parameters: **AddressListId** (*string*) -- **[REQUIRED]** The identifier of an existing address list resource to be retrieved. Return type: dict Returns: **Response Syntax** { 'AddressListId': 'string', 'AddressListArn': 'string', 'AddressListName': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **AddressListId** *(string) --* The identifier of the address list resource. * **AddressListArn** *(string) --* The Amazon Resource Name (ARN) of the address list resource. * **AddressListName** *(string) --* A user-friendly name for the address list resource. * **CreatedTimestamp** *(datetime) --* The date of when then address list was created. * **LastUpdatedTimestamp** *(datetime) --* The date of when the address list was last updated. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_relay get_relay ********* MailManager.Client.get_relay(**kwargs) Fetch the relay resource and it's attributes. See also: AWS API Documentation **Request Syntax** response = client.get_relay( RelayId='string' ) Parameters: **RelayId** (*string*) -- **[REQUIRED]** A unique relay identifier. Return type: dict Returns: **Response Syntax** { 'RelayId': 'string', 'RelayArn': 'string', 'RelayName': 'string', 'ServerName': 'string', 'ServerPort': 123, 'Authentication': { 'SecretArn': 'string', 'NoAuthentication': {} }, 'CreatedTimestamp': datetime(2015, 1, 1), 'LastModifiedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **RelayId** *(string) --* The unique relay identifier. * **RelayArn** *(string) --* The Amazon Resource Name (ARN) of the relay. * **RelayName** *(string) --* The unique name of the relay. * **ServerName** *(string) --* The destination relay server address. * **ServerPort** *(integer) --* The destination relay server port. * **Authentication** *(dict) --* The authentication attribute—contains the secret ARN where the customer relay server credentials are stored. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "SecretArn", "NoAuthentication". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **SecretArn** *(string) --* The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored. * **NoAuthentication** *(dict) --* Keep an empty structure if the relay destination server does not require SMTP credential authentication. * **CreatedTimestamp** *(datetime) --* The timestamp of when the relay was created. * **LastModifiedTimestamp** *(datetime) --* The timestamp of when relay was last updated. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / create_address_list create_address_list ******************* MailManager.Client.create_address_list(**kwargs) Creates a new address list. See also: AWS API Documentation **Request Syntax** response = client.create_address_list( ClientToken='string', AddressListName='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **AddressListName** (*string*) -- **[REQUIRED]** A user-friendly name for the address list. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'AddressListId': 'string' } **Response Structure** * *(dict) --* * **AddressListId** *(string) --* The identifier of the created address list. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / list_traffic_policies list_traffic_policies ********************* MailManager.Client.list_traffic_policies(**kwargs) List traffic policy resources. See also: AWS API Documentation **Request Syntax** response = client.list_traffic_policies( PageSize=123, NextToken='string' ) Parameters: * **PageSize** (*integer*) -- The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies. * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. Return type: dict Returns: **Response Syntax** { 'TrafficPolicies': [ { 'TrafficPolicyName': 'string', 'TrafficPolicyId': 'string', 'DefaultAction': 'ALLOW'|'DENY' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TrafficPolicies** *(list) --* The list of traffic policies. * *(dict) --* The structure of a traffic policy resource which is a container for policy statements. * **TrafficPolicyName** *(string) --* A user-friendly name of the traffic policy resource. * **TrafficPolicyId** *(string) --* The identifier of the traffic policy resource. * **DefaultAction** *(string) --* Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" MailManager / Client / get_addon_instance get_addon_instance ****************** MailManager.Client.get_addon_instance(**kwargs) Gets detailed information about an Add On instance. See also: AWS API Documentation **Request Syntax** response = client.get_addon_instance( AddonInstanceId='string' ) Parameters: **AddonInstanceId** (*string*) -- **[REQUIRED]** The Add On instance ID to retrieve information for. Return type: dict Returns: **Response Syntax** { 'AddonSubscriptionId': 'string', 'AddonName': 'string', 'AddonInstanceArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **AddonSubscriptionId** *(string) --* The subscription ID associated to the instance. * **AddonName** *(string) --* The name of the Add On provider associated to the subscription of the instance. * **AddonInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the Add On instance. * **CreatedTimestamp** *(datetime) --* The timestamp of when the Add On instance was created. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / delete_traffic_policy delete_traffic_policy ********************* MailManager.Client.delete_traffic_policy(**kwargs) Delete a traffic policy resource. See also: AWS API Documentation **Request Syntax** response = client.delete_traffic_policy( TrafficPolicyId='string' ) Parameters: **TrafficPolicyId** (*string*) -- **[REQUIRED]** The identifier of the traffic policy that you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / create_ingress_point create_ingress_point ******************** MailManager.Client.create_ingress_point(**kwargs) Provision a new ingress endpoint resource. See also: AWS API Documentation **Request Syntax** response = client.create_ingress_point( ClientToken='string', IngressPointName='string', Type='OPEN'|'AUTH', RuleSetId='string', TrafficPolicyId='string', IngressPointConfiguration={ 'SmtpPassword': 'string', 'SecretArn': 'string' }, NetworkConfiguration={ 'PublicNetworkConfiguration': { 'IpType': 'IPV4'|'DUAL_STACK' }, 'PrivateNetworkConfiguration': { 'VpcEndpointId': 'string' } }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **IngressPointName** (*string*) -- **[REQUIRED]** A user friendly name for an ingress endpoint resource. * **Type** (*string*) -- **[REQUIRED]** The type of the ingress endpoint to create. * **RuleSetId** (*string*) -- **[REQUIRED]** The identifier of an existing rule set that you attach to an ingress endpoint resource. * **TrafficPolicyId** (*string*) -- **[REQUIRED]** The identifier of an existing traffic policy that you attach to an ingress endpoint resource. * **IngressPointConfiguration** (*dict*) -- If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SmtpPassword", "SecretArn". * **SmtpPassword** *(string) --* The password of the ingress endpoint resource. * **SecretArn** *(string) --* The SecretsManager::Secret ARN of the ingress endpoint resource. * **NetworkConfiguration** (*dict*) -- Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PublicNetworkConfiguration", "PrivateNetworkConfiguration". * **PublicNetworkConfiguration** *(dict) --* Specifies the network configuration for the public ingress point. * **IpType** *(string) --* **[REQUIRED]** The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK. * **PrivateNetworkConfiguration** *(dict) --* Specifies the network configuration for the private ingress point. * **VpcEndpointId** *(string) --* **[REQUIRED]** The identifier of the VPC endpoint to associate with this private ingress point. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'IngressPointId': 'string' } **Response Structure** * *(dict) --* * **IngressPointId** *(string) --* The unique identifier for a previously created ingress endpoint. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / list_ingress_points list_ingress_points ******************* MailManager.Client.list_ingress_points(**kwargs) List all ingress endpoint resources. See also: AWS API Documentation **Request Syntax** response = client.list_ingress_points( PageSize=123, NextToken='string' ) Parameters: * **PageSize** (*integer*) -- The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. Return type: dict Returns: **Response Syntax** { 'IngressPoints': [ { 'IngressPointName': 'string', 'IngressPointId': 'string', 'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED', 'Type': 'OPEN'|'AUTH', 'ARecord': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IngressPoints** *(list) --* The list of ingress endpoints. * *(dict) --* The structure of an ingress endpoint resource. * **IngressPointName** *(string) --* A user friendly name for the ingress endpoint resource. * **IngressPointId** *(string) --* The identifier of the ingress endpoint resource. * **Status** *(string) --* The status of the ingress endpoint resource. * **Type** *(string) --* The type of ingress endpoint resource. * **ARecord** *(string) --* The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" MailManager / Client / get_archive_message get_archive_message ******************* MailManager.Client.get_archive_message(**kwargs) Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive. See also: AWS API Documentation **Request Syntax** response = client.get_archive_message( ArchivedMessageId='string' ) Parameters: **ArchivedMessageId** (*string*) -- **[REQUIRED]** The unique identifier of the archived email message. Return type: dict Returns: **Response Syntax** { 'MessageDownloadLink': 'string', 'Metadata': { 'Timestamp': datetime(2015, 1, 1), 'IngressPointId': 'string', 'TrafficPolicyId': 'string', 'RuleSetId': 'string', 'SenderHostname': 'string', 'SenderIpAddress': 'string', 'TlsCipherSuite': 'string', 'TlsProtocol': 'string', 'SendingMethod': 'string', 'SourceIdentity': 'string', 'SendingPool': 'string', 'ConfigurationSet': 'string', 'SourceArn': 'string' }, 'Envelope': { 'Helo': 'string', 'From': 'string', 'To': [ 'string', ] } } **Response Structure** * *(dict) --* The response containing details about the requested archived email message. * **MessageDownloadLink** *(string) --* A pre-signed URL to temporarily download the full message content. * **Metadata** *(dict) --* The metadata about the email. * **Timestamp** *(datetime) --* The timestamp of when the email was received. * **IngressPointId** *(string) --* The ID of the ingress endpoint through which the email was received. * **TrafficPolicyId** *(string) --* The ID of the traffic policy that was in effect when the email was received. * **RuleSetId** *(string) --* The ID of the rule set that processed the email. * **SenderHostname** *(string) --* The name of the host from which the email was received. * **SenderIpAddress** *(string) --* The IP address of the host from which the email was received. * **TlsCipherSuite** *(string) --* The TLS cipher suite used to communicate with the host from which the email was received. * **TlsProtocol** *(string) --* The TLS protocol used to communicate with the host from which the email was received. * **SendingMethod** *(string) --* The name of the API call used when sent through a configuration set with archiving enabled. * **SourceIdentity** *(string) --* The identity name used to authorize the sending action when sent through a configuration set with archiving enabled. * **SendingPool** *(string) --* The name of the dedicated IP pool used when sent through a configuration set with archiving enabled. * **ConfigurationSet** *(string) --* The name of the configuration set used when sent through a configuration set with archiving enabled. * **SourceArn** *(string) --* Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN. * **Envelope** *(dict) --* The SMTP envelope information of the email. * **Helo** *(string) --* The HELO used by the host from which the email was received. * **From** *(string) --* The RCPT FROM given by the host from which the email was received. * **To** *(list) --* All SMTP TO entries given by the host from which the email was received. * *(string) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_addon_subscription get_addon_subscription ********************** MailManager.Client.get_addon_subscription(**kwargs) Gets detailed information about an Add On subscription. See also: AWS API Documentation **Request Syntax** response = client.get_addon_subscription( AddonSubscriptionId='string' ) Parameters: **AddonSubscriptionId** (*string*) -- **[REQUIRED]** The Add On subscription ID to retrieve information for. Return type: dict Returns: **Response Syntax** { 'AddonName': 'string', 'AddonSubscriptionArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **AddonName** *(string) --* The name of the Add On for the subscription. * **AddonSubscriptionArn** *(string) --* Amazon Resource Name (ARN) for the subscription. * **CreatedTimestamp** *(datetime) --* The timestamp of when the Add On subscription was created. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / delete_rule_set delete_rule_set *************** MailManager.Client.delete_rule_set(**kwargs) Delete a rule set. See also: AWS API Documentation **Request Syntax** response = client.delete_rule_set( RuleSetId='string' ) Parameters: **RuleSetId** (*string*) -- **[REQUIRED]** The identifier of an existing rule set resource to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / get_archive_message_content get_archive_message_content *************************** MailManager.Client.get_archive_message_content(**kwargs) Returns the textual content of a specific email message stored in the archive. Attachments are not included. See also: AWS API Documentation **Request Syntax** response = client.get_archive_message_content( ArchivedMessageId='string' ) Parameters: **ArchivedMessageId** (*string*) -- **[REQUIRED]** The unique identifier of the archived email message. Return type: dict Returns: **Response Syntax** { 'Body': { 'Text': 'string', 'Html': 'string', 'MessageMalformed': True|False } } **Response Structure** * *(dict) --* The response containing the textual content of the requested archived email message. * **Body** *(dict) --* The textual body content of the email message. * **Text** *(string) --* The plain text body content of the message. * **Html** *(string) --* The HTML body content of the message. * **MessageMalformed** *(boolean) --* A flag indicating if the email was malformed. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / close close ***** MailManager.Client.close() Closes underlying endpoint connections. MailManager / Client / get_archive_search_results get_archive_search_results ************************** MailManager.Client.get_archive_search_results(**kwargs) Returns the results of a completed email archive search job. See also: AWS API Documentation **Request Syntax** response = client.get_archive_search_results( SearchId='string' ) Parameters: **SearchId** (*string*) -- **[REQUIRED]** The identifier of the completed search job. Return type: dict Returns: **Response Syntax** { 'Rows': [ { 'ArchivedMessageId': 'string', 'ReceivedTimestamp': datetime(2015, 1, 1), 'Date': 'string', 'To': 'string', 'From': 'string', 'Cc': 'string', 'Subject': 'string', 'MessageId': 'string', 'HasAttachments': True|False, 'ReceivedHeaders': [ 'string', ], 'InReplyTo': 'string', 'XMailer': 'string', 'XOriginalMailer': 'string', 'XPriority': 'string', 'IngressPointId': 'string', 'SenderHostname': 'string', 'SenderIpAddress': 'string', 'Envelope': { 'Helo': 'string', 'From': 'string', 'To': [ 'string', ] }, 'SourceArn': 'string' }, ] } **Response Structure** * *(dict) --* The response containing search results from a completed archive search. * **Rows** *(list) --* The list of email result objects matching the search criteria. * *(dict) --* A result row containing metadata for an archived email message. * **ArchivedMessageId** *(string) --* The unique identifier of the archived message. * **ReceivedTimestamp** *(datetime) --* The timestamp of when the email was received. * **Date** *(string) --* The date the email was sent. * **To** *(string) --* The email addresses in the To header. * **From** *(string) --* The email address of the sender. * **Cc** *(string) --* The email addresses in the CC header. * **Subject** *(string) --* The subject header value of the email. * **MessageId** *(string) --* The unique message ID of the email. * **HasAttachments** *(boolean) --* A flag indicating if the email has attachments. * **ReceivedHeaders** *(list) --* The received headers from the email delivery path. * *(string) --* * **InReplyTo** *(string) --* The email message ID this is a reply to. * **XMailer** *(string) --* The user agent that sent the email. * **XOriginalMailer** *(string) --* The original user agent that sent the email. * **XPriority** *(string) --* The priority level of the email. * **IngressPointId** *(string) --* The ID of the ingress endpoint through which the email was received. * **SenderHostname** *(string) --* The name of the host from which the email was received. * **SenderIpAddress** *(string) --* * Mail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint. * Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call. * **Envelope** *(dict) --* The SMTP envelope information of the email. * **Helo** *(string) --* The HELO used by the host from which the email was received. * **From** *(string) --* The RCPT FROM given by the host from which the email was received. * **To** *(list) --* All SMTP TO entries given by the host from which the email was received. * *(string) --* * **SourceArn** *(string) --* Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / create_relay create_relay ************ MailManager.Client.create_relay(**kwargs) Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations. See also: AWS API Documentation **Request Syntax** response = client.create_relay( ClientToken='string', RelayName='string', ServerName='string', ServerPort=123, Authentication={ 'SecretArn': 'string', 'NoAuthentication': {} }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- A unique token that Amazon SES uses to recognize subsequent retries of the same request. This field is autopopulated if not provided. * **RelayName** (*string*) -- **[REQUIRED]** The unique name of the relay resource. * **ServerName** (*string*) -- **[REQUIRED]** The destination relay server address. * **ServerPort** (*integer*) -- **[REQUIRED]** The destination relay server port. * **Authentication** (*dict*) -- **[REQUIRED]** Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretArn", "NoAuthentication". * **SecretArn** *(string) --* The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored. * **NoAuthentication** *(dict) --* Keep an empty structure if the relay destination server does not require SMTP credential authentication. * **Tags** (*list*) -- The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** { 'RelayId': 'string' } **Response Structure** * *(dict) --* * **RelayId** *(string) --* A unique identifier of the created relay resource. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" MailManager / Client / list_address_lists list_address_lists ****************** MailManager.Client.list_address_lists(**kwargs) Lists address lists for this account. See also: AWS API Documentation **Request Syntax** response = client.list_address_lists( NextToken='string', PageSize=123 ) Parameters: * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. * **PageSize** (*integer*) -- The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists. Return type: dict Returns: **Response Syntax** { 'AddressLists': [ { 'AddressListId': 'string', 'AddressListArn': 'string', 'AddressListName': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AddressLists** *(list) --* The list of address lists. * *(dict) --* An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management. * **AddressListId** *(string) --* The identifier of the address list. * **AddressListArn** *(string) --* The Amazon Resource Name (ARN) of the address list. * **AddressListName** *(string) --* The user-friendly name of the address list. * **CreatedTimestamp** *(datetime) --* The timestamp of when the address list was created. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the address list was last updated. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / start_address_list_import_job start_address_list_import_job ***************************** MailManager.Client.start_address_list_import_job(**kwargs) Starts an import job for an address list. See also: AWS API Documentation **Request Syntax** response = client.start_address_list_import_job( JobId='string' ) Parameters: **JobId** (*string*) -- **[REQUIRED]** The identifier of the import job that needs to be started. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / update_relay update_relay ************ MailManager.Client.update_relay(**kwargs) Updates the attributes of an existing relay resource. See also: AWS API Documentation **Request Syntax** response = client.update_relay( RelayId='string', RelayName='string', ServerName='string', ServerPort=123, Authentication={ 'SecretArn': 'string', 'NoAuthentication': {} } ) Parameters: * **RelayId** (*string*) -- **[REQUIRED]** The unique relay identifier. * **RelayName** (*string*) -- The name of the relay resource. * **ServerName** (*string*) -- The destination relay server address. * **ServerPort** (*integer*) -- The destination relay server port. * **Authentication** (*dict*) -- Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "SecretArn", "NoAuthentication". * **SecretArn** *(string) --* The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored. * **NoAuthentication** *(dict) --* Keep an empty structure if the relay destination server does not require SMTP credential authentication. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / list_archive_searches list_archive_searches ********************* MailManager.Client.list_archive_searches(**kwargs) Returns a list of email archive search jobs. See also: AWS API Documentation **Request Syntax** response = client.list_archive_searches( ArchiveId='string', NextToken='string', PageSize=123 ) Parameters: * **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive. * **NextToken** (*string*) -- If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. * **PageSize** (*integer*) -- The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives. Return type: dict Returns: **Response Syntax** { 'Searches': [ { 'SearchId': 'string', 'Status': { 'SubmissionTimestamp': datetime(2015, 1, 1), 'CompletionTimestamp': datetime(2015, 1, 1), 'State': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED', 'ErrorMessage': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response containing a list of archive search jobs and their statuses. * **Searches** *(list) --* The list of search job identifiers and statuses. * *(dict) --* Summary details of an archive search job. * **SearchId** *(string) --* The unique identifier of the search job. * **Status** *(dict) --* The current status of the search job. * **SubmissionTimestamp** *(datetime) --* The timestamp of when the search was submitted. * **CompletionTimestamp** *(datetime) --* The timestamp of when the search completed (if finished). * **State** *(string) --* The current state of the search job. * **ErrorMessage** *(string) --* An error message if the search failed. * **NextToken** *(string) --* If present, use to retrieve the next page of results. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_rule_set get_rule_set ************ MailManager.Client.get_rule_set(**kwargs) Fetch attributes of a rule set. See also: AWS API Documentation **Request Syntax** response = client.get_rule_set( RuleSetId='string' ) Parameters: **RuleSetId** (*string*) -- **[REQUIRED]** The identifier of an existing rule set to be retrieved. Return type: dict Returns: **Response Syntax** { 'RuleSetId': 'string', 'RuleSetArn': 'string', 'RuleSetName': 'string', 'CreatedDate': datetime(2015, 1, 1), 'LastModificationDate': datetime(2015, 1, 1), 'Rules': [ { 'Name': 'string', 'Conditions': [ { 'BooleanExpression': { 'Evaluate': { 'Attribute': 'READ_RECEIPT_REQUESTED'|'TLS'|'TLS_WRAPPED', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT'|'MAIL_FROM'|'SENDER'|'FROM'|'TO'|'CC', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' }, 'StringExpression': { 'Evaluate': { 'Attribute': 'MAIL_FROM'|'HELO'|'RECIPIENT'|'SENDER'|'FROM'|'SUBJECT'|'TO'|'CC', 'MimeHeaderAttribute': 'string', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'NumberExpression': { 'Evaluate': { 'Attribute': 'MESSAGE_SIZE' }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'LESS_THAN'|'GREATER_THAN'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN_OR_EQUAL', 'Value': 123.0 }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SOURCE_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'VerdictExpression': { 'Evaluate': { 'Attribute': 'SPF'|'DKIM', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'PASS'|'FAIL'|'GRAY'|'PROCESSING_FAILED', ] }, 'DmarcExpression': { 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'NONE'|'QUARANTINE'|'REJECT', ] } }, ], 'Unless': [ { 'BooleanExpression': { 'Evaluate': { 'Attribute': 'READ_RECEIPT_REQUESTED'|'TLS'|'TLS_WRAPPED', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' }, 'IsInAddressList': { 'Attribute': 'RECIPIENT'|'MAIL_FROM'|'SENDER'|'FROM'|'TO'|'CC', 'AddressLists': [ 'string', ] } }, 'Operator': 'IS_TRUE'|'IS_FALSE' }, 'StringExpression': { 'Evaluate': { 'Attribute': 'MAIL_FROM'|'HELO'|'RECIPIENT'|'SENDER'|'FROM'|'SUBJECT'|'TO'|'CC', 'MimeHeaderAttribute': 'string', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS', 'Values': [ 'string', ] }, 'NumberExpression': { 'Evaluate': { 'Attribute': 'MESSAGE_SIZE' }, 'Operator': 'EQUALS'|'NOT_EQUALS'|'LESS_THAN'|'GREATER_THAN'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN_OR_EQUAL', 'Value': 123.0 }, 'IpExpression': { 'Evaluate': { 'Attribute': 'SOURCE_IP' }, 'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES', 'Values': [ 'string', ] }, 'VerdictExpression': { 'Evaluate': { 'Attribute': 'SPF'|'DKIM', 'Analysis': { 'Analyzer': 'string', 'ResultField': 'string' } }, 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'PASS'|'FAIL'|'GRAY'|'PROCESSING_FAILED', ] }, 'DmarcExpression': { 'Operator': 'EQUALS'|'NOT_EQUALS', 'Values': [ 'NONE'|'QUARANTINE'|'REJECT', ] } }, ], 'Actions': [ { 'Drop': {}, 'Relay': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'Relay': 'string', 'MailFrom': 'REPLACE'|'PRESERVE' }, 'Archive': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'TargetArchive': 'string' }, 'WriteToS3': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'RoleArn': 'string', 'S3Bucket': 'string', 'S3Prefix': 'string', 'S3SseKmsKeyId': 'string' }, 'Send': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'RoleArn': 'string' }, 'AddHeader': { 'HeaderName': 'string', 'HeaderValue': 'string' }, 'ReplaceRecipient': { 'ReplaceWith': [ 'string', ] }, 'DeliverToMailbox': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'MailboxArn': 'string', 'RoleArn': 'string' }, 'DeliverToQBusiness': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'ApplicationId': 'string', 'IndexId': 'string', 'RoleArn': 'string' }, 'PublishToSns': { 'ActionFailurePolicy': 'CONTINUE'|'DROP', 'TopicArn': 'string', 'RoleArn': 'string', 'Encoding': 'UTF-8'|'BASE64', 'PayloadType': 'HEADERS'|'CONTENT' } }, ] }, ] } **Response Structure** * *(dict) --* * **RuleSetId** *(string) --* The identifier of the rule set resource. * **RuleSetArn** *(string) --* The Amazon Resource Name (ARN) of the rule set resource. * **RuleSetName** *(string) --* A user-friendly name for the rule set resource. * **CreatedDate** *(datetime) --* The date of when then rule set was created. * **LastModificationDate** *(datetime) --* The date of when the rule set was last modified. * **Rules** *(list) --* The rules contained in the rule set. * *(dict) --* A rule contains conditions, "unless conditions" and actions. For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions". * **Name** *(string) --* The user-friendly name of the rule. * **Conditions** *(list) --* The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions" * *(dict) --* The conditional expression used to evaluate an email for determining if a rule action should be taken. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "BooleanExpression", "StringExpression", "NumberExpression", "IpExpression", "VerdictExpression", "DmarcExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **BooleanExpression** *(dict) --* The condition applies to a boolean expression passed in this field. * **Evaluate** *(dict) --* The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "Analysis", "IsInAddressList". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The boolean type representing the allowed attribute types for an email. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a boolean condition expression. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression. * **Attribute** *(string) --* The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* The matching operator for a boolean condition expression. * **StringExpression** *(dict) --* The condition applies to a string expression passed in this field. * **Evaluate** *(dict) --* The string to evaluate in a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "MimeHeaderAttribute", "Analysis". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The email attribute to evaluate in a string condition expression. * **MimeHeaderAttribute** *(string) --* The email MIME X-Header attribute to evaluate in a string condition expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a string condition expression. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **Operator** *(string) --* The matching operator for a string condition expression. * **Values** *(list) --* The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string. * *(string) --* * **NumberExpression** *(dict) --* The condition applies to a number expression passed in this field. * **Evaluate** *(dict) --* The number to evaluate in a numeric condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* An email attribute that is used as the number to evaluate. * **Operator** *(string) --* The operator for a numeric condition expression. * **Value** *(float) --* The value to evaluate in a numeric condition expression. * **IpExpression** *(dict) --* The condition applies to an IP address expression passed in this field. * **Evaluate** *(dict) --* The IP address to evaluate in this condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The attribute of the email to evaluate. * **Operator** *(string) --* The operator to evaluate the IP address. * **Values** *(list) --* The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges. * *(string) --* * **VerdictExpression** *(dict) --* The condition applies to a verdict expression passed in this field. * **Evaluate** *(dict) --* The verdict to evaluate in a verdict condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "Analysis". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The email verdict attribute to evaluate in a string verdict expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a verdict condition expression. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **Operator** *(string) --* The matching operator for a verdict condition expression. * **Values** *(list) --* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email. * *(string) --* * **DmarcExpression** *(dict) --* The condition applies to a DMARC policy expression passed in this field. * **Operator** *(string) --* The operator to apply to the DMARC policy of the incoming email. * **Values** *(list) --* The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match. * *(string) --* * **Unless** *(list) --* The "unless conditions" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed. * *(dict) --* The conditional expression used to evaluate an email for determining if a rule action should be taken. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "BooleanExpression", "StringExpression", "NumberExpression", "IpExpression", "VerdictExpression", "DmarcExpression". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **BooleanExpression** *(dict) --* The condition applies to a boolean expression passed in this field. * **Evaluate** *(dict) --* The operand on which to perform a boolean condition operation. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "Analysis", "IsInAddressList". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The boolean type representing the allowed attribute types for an email. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a boolean condition expression. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **IsInAddressList** *(dict) --* The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression. * **Attribute** *(string) --* The email attribute that needs to be evaluated against the address list. * **AddressLists** *(list) --* The address lists that will be used for evaluation. * *(string) --* * **Operator** *(string) --* The matching operator for a boolean condition expression. * **StringExpression** *(dict) --* The condition applies to a string expression passed in this field. * **Evaluate** *(dict) --* The string to evaluate in a string condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "MimeHeaderAttribute", "Analysis". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The email attribute to evaluate in a string condition expression. * **MimeHeaderAttribute** *(string) --* The email MIME X-Header attribute to evaluate in a string condition expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a string condition expression. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **Operator** *(string) --* The matching operator for a string condition expression. * **Values** *(list) --* The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string. * *(string) --* * **NumberExpression** *(dict) --* The condition applies to a number expression passed in this field. * **Evaluate** *(dict) --* The number to evaluate in a numeric condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* An email attribute that is used as the number to evaluate. * **Operator** *(string) --* The operator for a numeric condition expression. * **Value** *(float) --* The value to evaluate in a numeric condition expression. * **IpExpression** *(dict) --* The condition applies to an IP address expression passed in this field. * **Evaluate** *(dict) --* The IP address to evaluate in this condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The attribute of the email to evaluate. * **Operator** *(string) --* The operator to evaluate the IP address. * **Values** *(list) --* The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges. * *(string) --* * **VerdictExpression** *(dict) --* The condition applies to a verdict expression passed in this field. * **Evaluate** *(dict) --* The verdict to evaluate in a verdict condition expression. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Attribute", "Analysis". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Attribute** *(string) --* The email verdict attribute to evaluate in a string verdict expression. * **Analysis** *(dict) --* The Add On ARN and its returned value to evaluate in a verdict condition expression. * **Analyzer** *(string) --* The Amazon Resource Name (ARN) of an Add On. * **ResultField** *(string) --* The returned value from an Add On. * **Operator** *(string) --* The matching operator for a verdict condition expression. * **Values** *(list) --* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email. * *(string) --* * **DmarcExpression** *(dict) --* The condition applies to a DMARC policy expression passed in this field. * **Operator** *(string) --* The operator to apply to the DMARC policy of the incoming email. * **Values** *(list) --* The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match. * *(string) --* * **Actions** *(list) --* The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match. * *(dict) --* The action for a rule to take. Only one of the contained actions can be set. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Drop", "Relay", "Archive", "WriteToS3", "Send", "AddHeader", "ReplaceRecipient", "DeliverToMailbox", "DeliverToQBusiness", "PublishToSns". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Drop** *(dict) --* This action terminates the evaluation of rules in the rule set. * **Relay** *(dict) --* This action relays the email to another SMTP server. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted. * **Relay** *(string) --* The identifier of the relay resource to be used when relaying an email. * **MailFrom** *(string) --* This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server. * **Archive** *(dict) --* This action archives the email. This can be used to deliver an email to an archive. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted. * **TargetArchive** *(string) --* The identifier of the archive to send the email to. * **WriteToS3** *(dict) --* This action writes the MIME content of the email to an S3 bucket. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket. * **S3Bucket** *(string) --* The bucket name of the S3 bucket to write to. * **S3Prefix** *(string) --* The S3 prefix to use for the write to the s3 bucket. * **S3SseKmsKeyId** *(string) --* The KMS Key ID to use to encrypt the message in S3. * **Send** *(dict) --* This action sends the email to the internet. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API. * **AddHeader** *(dict) --* This action adds a header. This can be used to add arbitrary email headers. * **HeaderName** *(string) --* The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre- existed in the email. * **HeaderValue** *(string) --* The value of the header to add to the email. * **ReplaceRecipient** *(dict) --* The action replaces certain or all recipients with a different set of recipients. * **ReplaceWith** *(list) --* This action specifies the replacement recipient email addresses to insert. * *(string) --* * **DeliverToMailbox** *(dict) --* This action delivers an email to a WorkMail mailbox. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid. * **MailboxArn** *(string) --* The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API. * **DeliverToQBusiness** *(dict) --* This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the "qbusiness:BatchPutDocument" API. * **ApplicationId** *(string) --* The unique identifier of the Amazon Q Business application instance where the email content will be delivered. * **IndexId** *(string) --* The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the "qbusiness:BatchPutDocument" API for the given application and index. * **PublishToSns** *(dict) --* This action publishes the email content to an Amazon SNS topic. * **ActionFailurePolicy** *(string) --* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the "sns:Publish" API. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the "sns:Publish" API for the given topic. * **Encoding** *(string) --* The encoding to use for the email within the Amazon SNS notification. The default value is "UTF-8". Use "BASE64" if you need to preserve all special characters, especially when the original message uses a different encoding format. * **PayloadType** *(string) --* The expected payload type within the Amazon SNS notification. "CONTENT" attempts to publish the full email content with 20KB of headers content. "HEADERS" extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is "CONTENT". **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / tag_resource tag_resource ************ MailManager.Client.tag_resource(**kwargs) Adds one or more tags (keys and values) to a specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to tag. * **Tags** (*list*) -- **[REQUIRED]** The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(dict) --* A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources. * **Key** *(string) --* **[REQUIRED]** The key of the key-value tag. * **Value** *(string) --* **[REQUIRED]** The value of the key-value tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ConflictException" * "MailManager.Client.exceptions.ResourceNotFoundException" MailManager / Client / get_member_of_address_list get_member_of_address_list ************************** MailManager.Client.get_member_of_address_list(**kwargs) Fetch attributes of a member in an address list. See also: AWS API Documentation **Request Syntax** response = client.get_member_of_address_list( AddressListId='string', Address='string' ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list to retrieve the address from. * **Address** (*string*) -- **[REQUIRED]** The address to be retrieved from the address list. Return type: dict Returns: **Response Syntax** { 'Address': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **Address** *(string) --* The address retrieved from the address list. * **CreatedTimestamp** *(datetime) --* The timestamp of when the address was created. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / list_addon_subscriptions list_addon_subscriptions ************************ MailManager.Client.list_addon_subscriptions(**kwargs) Lists all Add On subscriptions in your account. See also: AWS API Documentation **Request Syntax** response = client.list_addon_subscriptions( NextToken='string', PageSize=123 ) Parameters: * **NextToken** (*string*) -- If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results. * **PageSize** (*integer*) -- The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. Return type: dict Returns: **Response Syntax** { 'AddonSubscriptions': [ { 'AddonSubscriptionId': 'string', 'AddonName': 'string', 'AddonSubscriptionArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AddonSubscriptions** *(list) --* The list of ingress endpoints. * *(dict) --* A subscription for an Add On representing the acceptance of its terms of use and additional pricing. * **AddonSubscriptionId** *(string) --* The unique ID of the Add On subscription. * **AddonName** *(string) --* The name of the Add On. * **AddonSubscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Add On subscription. * **CreatedTimestamp** *(datetime) --* The timestamp of when the Add On subscription was created. * **NextToken** *(string) --* If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "MailManager.Client.exceptions.ValidationException" MailManager / Client / register_member_to_address_list register_member_to_address_list ******************************* MailManager.Client.register_member_to_address_list(**kwargs) Adds a member to an address list. See also: AWS API Documentation **Request Syntax** response = client.register_member_to_address_list( AddressListId='string', Address='string' ) Parameters: * **AddressListId** (*string*) -- **[REQUIRED]** The unique identifier of the address list where the address should be added. * **Address** (*string*) -- **[REQUIRED]** The address to be added to the address list. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ServiceQuotaExceededException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException" MailManager / Client / get_archive get_archive *********** MailManager.Client.get_archive(**kwargs) Retrieves the full details and current state of a specified email archive. See also: AWS API Documentation **Request Syntax** response = client.get_archive( ArchiveId='string' ) Parameters: **ArchiveId** (*string*) -- **[REQUIRED]** The identifier of the archive to retrieve. Return type: dict Returns: **Response Syntax** { 'ArchiveId': 'string', 'ArchiveName': 'string', 'ArchiveArn': 'string', 'ArchiveState': 'ACTIVE'|'PENDING_DELETION', 'Retention': { 'RetentionPeriod': 'THREE_MONTHS'|'SIX_MONTHS'|'NINE_MONTHS'|'ONE_YEAR'|'EIGHTEEN_MONTHS'|'TWO_YEARS'|'THIRTY_MONTHS'|'THREE_YEARS'|'FOUR_YEARS'|'FIVE_YEARS'|'SIX_YEARS'|'SEVEN_YEARS'|'EIGHT_YEARS'|'NINE_YEARS'|'TEN_YEARS'|'PERMANENT' }, 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1), 'KmsKeyArn': 'string' } **Response Structure** * *(dict) --* The response containing details of the requested archive. * **ArchiveId** *(string) --* The unique identifier of the archive. * **ArchiveName** *(string) --* The unique name assigned to the archive. * **ArchiveArn** *(string) --* The Amazon Resource Name (ARN) of the archive. * **ArchiveState** *(string) --* The current state of the archive: * "ACTIVE" – The archive is ready and available for use. * "PENDING_DELETION" – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. * **Retention** *(dict) --* The retention period for emails in this archive. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "RetentionPeriod". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **RetentionPeriod** *(string) --* The enum value sets the period for retaining emails in an archive. * **CreatedTimestamp** *(datetime) --* The timestamp of when the archive was created. * **LastUpdatedTimestamp** *(datetime) --* The timestamp of when the archive was modified. * **KmsKeyArn** *(string) --* The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive. **Exceptions** * "MailManager.Client.exceptions.ValidationException" * "MailManager.Client.exceptions.AccessDeniedException" * "MailManager.Client.exceptions.ResourceNotFoundException" * "MailManager.Client.exceptions.ThrottlingException"