Mailmanager

create_addon_instance(addon_subscription_id)
create_addon_instance(addon_subscription_id, params::Dict{String,<:Any})

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.

Arguments

• addon_subscription_id: The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token that Amazon SES uses to recognize subsequent retries of the same request.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

create_addon_subscription(addon_name)
create_addon_subscription(addon_name, params::Dict{String,<:Any})

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.

Arguments

• addon_name: The name of the Add On to subscribe to. You can only have one subscription for each Add On name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token that Amazon SES uses to recognize subsequent retries of the same request.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

create_archive(archive_name)
create_archive(archive_name, params::Dict{String,<:Any})

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

Arguments

• archive_name: A unique name for the new archive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token Amazon SES uses to recognize retries of this request.
• "KmsKeyArn": The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
• "Retention": The period for retaining emails in the archive before automatic deletion.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

create_ingress_point(ingress_point_name, rule_set_id, traffic_policy_id, type)
create_ingress_point(ingress_point_name, rule_set_id, traffic_policy_id, type, params::Dict{String,<:Any})

Provision a new ingress endpoint resource.

Arguments

• ingress_point_name: A user friendly name for an ingress endpoint resource.
• rule_set_id: The identifier of an existing rule set that you attach to an ingress endpoint resource.
• traffic_policy_id: The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
• type: The type of the ingress endpoint to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token that Amazon SES uses to recognize subsequent retries of the same request.
• "IngressPointConfiguration": If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

create_relay(authentication, relay_name, server_name, server_port)
create_relay(authentication, relay_name, server_name, server_port, params::Dict{String,<:Any})

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

Arguments

• authentication: Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
• relay_name: The unique name of the relay resource.
• server_name: The destination relay server address.
• server_port: The destination relay server port.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token that Amazon SES uses to recognize subsequent retries of the same request.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

create_rule_set(rule_set_name, rules)
create_rule_set(rule_set_name, rules, params::Dict{String,<:Any})

Provision a new rule set.

Arguments

• rule_set_name: A user-friendly name for the rule set.
• rules: Conditional rules that are evaluated for determining actions on email.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token that Amazon SES uses to recognize subsequent retries of the same request.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

create_traffic_policy(default_action, policy_statements, traffic_policy_name)
create_traffic_policy(default_action, policy_statements, traffic_policy_name, params::Dict{String,<:Any})

Provision a new traffic policy resource.

Arguments

• default_action: 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
• policy_statements: Conditional statements for filtering email traffic.
• traffic_policy_name: A user-friendly name for the traffic policy resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": A unique token that Amazon SES uses to recognize subsequent retries of the same request.
• "MaxMessageSizeBytes": The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
• "Tags": The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

delete_addon_instance(addon_instance_id)
delete_addon_instance(addon_instance_id, params::Dict{String,<:Any})

Deletes an Add On instance.

Arguments

• addon_instance_id: The Add On instance ID to delete.

delete_addon_subscription(addon_subscription_id)
delete_addon_subscription(addon_subscription_id, params::Dict{String,<:Any})

Deletes an Add On subscription.

Arguments

• addon_subscription_id: The Add On subscription ID to delete.

delete_archive(archive_id)
delete_archive(archive_id, params::Dict{String,<:Any})

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.

Arguments

• archive_id: The identifier of the archive to delete.

delete_ingress_point(ingress_point_id)
delete_ingress_point(ingress_point_id, params::Dict{String,<:Any})

Delete an ingress endpoint resource.

Arguments

• ingress_point_id: The identifier of the ingress endpoint resource that you want to delete.

delete_relay(relay_id)
delete_relay(relay_id, params::Dict{String,<:Any})

Deletes an existing relay resource.

Arguments

• relay_id: The unique relay identifier.

delete_rule_set(rule_set_id)
delete_rule_set(rule_set_id, params::Dict{String,<:Any})

Delete a rule set.

Arguments

• rule_set_id: The identifier of an existing rule set resource to delete.

delete_traffic_policy(traffic_policy_id)
delete_traffic_policy(traffic_policy_id, params::Dict{String,<:Any})

Delete a traffic policy resource.

Arguments

• traffic_policy_id: The identifier of the traffic policy that you want to delete.

get_addon_instance(addon_instance_id)
get_addon_instance(addon_instance_id, params::Dict{String,<:Any})

Gets detailed information about an Add On instance.

Arguments

• addon_instance_id: The Add On instance ID to retrieve information for.

get_addon_subscription(addon_subscription_id)
get_addon_subscription(addon_subscription_id, params::Dict{String,<:Any})

Gets detailed information about an Add On subscription.

Arguments

• addon_subscription_id: The Add On subscription ID to retrieve information for.

get_archive(archive_id)
get_archive(archive_id, params::Dict{String,<:Any})

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

Arguments

• archive_id: The identifier of the archive to retrieve.

get_archive_export(export_id)
get_archive_export(export_id, params::Dict{String,<:Any})

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

Arguments

• export_id: The identifier of the export job to get details for.

get_archive_message(archived_message_id)
get_archive_message(archived_message_id, params::Dict{String,<:Any})

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

Arguments

• archived_message_id: The unique identifier of the archived email message.

get_archive_message_content(archived_message_id)
get_archive_message_content(archived_message_id, params::Dict{String,<:Any})

Returns the textual content of a specific email message stored in the archive. Attachments are not included.

Arguments

• archived_message_id: The unique identifier of the archived email message.

get_archive_search(search_id)
get_archive_search(search_id, params::Dict{String,<:Any})

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

Arguments

• search_id: The identifier of the search job to get details for.

get_archive_search_results(search_id)
get_archive_search_results(search_id, params::Dict{String,<:Any})

Returns the results of a completed email archive search job.

Arguments

• search_id: The identifier of the completed search job.

get_ingress_point(ingress_point_id)
get_ingress_point(ingress_point_id, params::Dict{String,<:Any})

Fetch ingress endpoint resource attributes.

Arguments

• ingress_point_id: The identifier of an ingress endpoint.

get_relay(relay_id)
get_relay(relay_id, params::Dict{String,<:Any})

Fetch the relay resource and it's attributes.

Arguments

• relay_id: A unique relay identifier.

get_rule_set(rule_set_id)
get_rule_set(rule_set_id, params::Dict{String,<:Any})

Fetch attributes of a rule set.

Arguments

• rule_set_id: The identifier of an existing rule set to be retrieved.

get_traffic_policy(traffic_policy_id)
get_traffic_policy(traffic_policy_id, params::Dict{String,<:Any})

Fetch attributes of a traffic policy resource.

Arguments

• traffic_policy_id: The identifier of the traffic policy resource.

list_addon_instances()
list_addon_instances(params::Dict{String,<:Any})

Lists all Add On instances in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

list_addon_subscriptions()
list_addon_subscriptions(params::Dict{String,<:Any})

Lists all Add On subscriptions in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

list_archive_exports(archive_id)
list_archive_exports(archive_id, params::Dict{String,<:Any})

Returns a list of email archive export jobs.

Arguments

• archive_id: The identifier of the archive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.

list_archive_searches(archive_id)
list_archive_searches(archive_id, params::Dict{String,<:Any})

Returns a list of email archive search jobs.

Arguments

• archive_id: The identifier of the archive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.

list_archives()
list_archives(params::Dict{String,<:Any})

Returns a list of all email archives in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.

list_ingress_points()
list_ingress_points(params::Dict{String,<:Any})

List all ingress endpoint resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

list_relays()
list_relays(params::Dict{String,<:Any})

Lists all the existing relay resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The number of relays to be returned in one request.

list_rule_sets()
list_rule_sets(params::Dict{String,<:Any})

List rule sets for this account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to retrieve tags from.

list_traffic_policies()
list_traffic_policies(params::Dict{String,<:Any})

List traffic policy resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": 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": The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.

start_archive_export(archive_id, export_destination_configuration, from_timestamp, to_timestamp)
start_archive_export(archive_id, export_destination_configuration, from_timestamp, to_timestamp, params::Dict{String,<:Any})

Initiates an export of emails from the specified archive.

Arguments

• archive_id: The identifier of the archive to export emails from.
• export_destination_configuration: Details on where to deliver the exported email data.
• from_timestamp: The start of the timestamp range to include emails from.
• to_timestamp: The end of the timestamp range to include emails from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Criteria to filter which emails are included in the export.
• "MaxResults": The maximum number of email items to include in the export.

start_archive_search(archive_id, from_timestamp, max_results, to_timestamp)
start_archive_search(archive_id, from_timestamp, max_results, to_timestamp, params::Dict{String,<:Any})

Initiates a search across emails in the specified archive.

Arguments

• archive_id: The identifier of the archive to search emails in.
• from_timestamp: The start timestamp of the range to search emails from.
• max_results: The maximum number of search results to return.
• to_timestamp: The end timestamp of the range to search emails from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Criteria to filter which emails are included in the search results.

stop_archive_export(export_id)
stop_archive_export(export_id, params::Dict{String,<:Any})

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

Arguments

• export_id: The identifier of the export job to stop.

stop_archive_search(search_id)
stop_archive_search(search_id, params::Dict{String,<:Any})

Stops an in-progress archive search job.

Arguments

• search_id: The identifier of the search job to stop.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource that you want to tag.
• tags: The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource that you want to untag.
• tag_keys: The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

update_archive(archive_id)
update_archive(archive_id, params::Dict{String,<:Any})

Updates the attributes of an existing email archive.

Arguments

• archive_id: The identifier of the archive to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ArchiveName": A new, unique name for the archive.
• "Retention": A new retention period for emails in the archive.

update_ingress_point(ingress_point_id)
update_ingress_point(ingress_point_id, params::Dict{String,<:Any})

Update attributes of a provisioned ingress endpoint resource.

Arguments

• ingress_point_id: The identifier for the ingress endpoint you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "IngressPointConfiguration": If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
• "IngressPointName": A user friendly name for the ingress endpoint resource.
• "RuleSetId": The identifier of an existing rule set that you attach to an ingress endpoint resource.
• "StatusToUpdate": The update status of an ingress endpoint.
• "TrafficPolicyId": The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

update_relay(relay_id)
update_relay(relay_id, params::Dict{String,<:Any})

Updates the attributes of an existing relay resource.

Arguments

• relay_id: The unique relay identifier.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Authentication": Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
• "RelayName": The name of the relay resource.
• "ServerName": The destination relay server address.
• "ServerPort": The destination relay server port.

update_rule_set(rule_set_id)
update_rule_set(rule_set_id, params::Dict{String,<:Any})

>Update attributes of an already provisioned rule set.

Arguments

• rule_set_id: The identifier of a rule set you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RuleSetName": A user-friendly name for the rule set resource.
• "Rules": 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.

update_traffic_policy(traffic_policy_id)
update_traffic_policy(traffic_policy_id, params::Dict{String,<:Any})

Update attributes of an already provisioned traffic policy resource.

Arguments

• traffic_policy_id: The identifier of the traffic policy that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DefaultAction": 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": The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
• "PolicyStatements": The list of conditions to be updated for filtering email traffic.
• "TrafficPolicyName": A user-friendly name for the traffic policy resource.