Smaws_Client_MailManager.TypesThe request validation has failed. For details, see the accompanying error message.
type nonrec ingress_analysis = {result_field : result_field;The returned value from an Add On.
*)analyzer : analyzer_arn;The Amazon Resource Name (ARN) of an Add On.
*)}The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
type nonrec ingress_string_to_evaluate = | Analysis of ingress_analysisThe structure type for a string condition stating the Add On ARN and its returned value.
*)| Attribute of ingress_string_email_attributeThe enum type representing the allowed attribute types for a string condition.
*)The union type representing the allowed types for the left hand side of a string condition.
type nonrec string_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec ingress_string_expression = {values : string_list;The right hand side argument of a string condition expression.
*)operator : ingress_string_operator;The matching operator for a string condition expression.
*)evaluate : ingress_string_to_evaluate;The left hand side argument of a string condition expression.
*)}The structure for a string based condition matching on the incoming mail.
type nonrec ingress_ip_to_evaluate = | Attribute of ingress_ipv4_attributeAn enum type representing the allowed attribute types for an IP condition.
*)The structure for an IP based condition matching on the incoming mail.
type nonrec ipv4_cidrs = ipv4_cidr listtype nonrec ingress_ipv4_expression = {values : ipv4_cidrs;The right hand side argument of an IP condition expression.
*)operator : ingress_ip_operator;The matching operator for an IP condition expression.
*)evaluate : ingress_ip_to_evaluate;The left hand side argument of an IP condition expression.
*)}The union type representing the allowed types for the left hand side of an IP condition.
type nonrec ingress_ipv6_to_evaluate = | Attribute of ingress_ipv6_attributeAn enum type representing the allowed attribute types for an IPv6 condition.
*)The structure for an IPv6 based condition matching on the incoming mail.
type nonrec ipv6_cidrs = ipv6_cidr listtype nonrec ingress_ipv6_expression = {values : ipv6_cidrs;The right hand side argument of an IPv6 condition expression.
*)operator : ingress_ip_operator;The matching operator for an IPv6 condition expression.
*)evaluate : ingress_ipv6_to_evaluate;The left hand side argument of an IPv6 condition expression.
*)}The union type representing the allowed types for the left hand side of an IPv6 condition.
type nonrec ingress_tls_protocol_to_evaluate = | Attribute of ingress_tls_attributeThe enum type representing the allowed attribute types for the TLS condition.
*)The union type representing the allowed types for the left hand side of a TLS condition.
type nonrec ingress_tls_protocol_expression = {value : ingress_tls_protocol_attribute;The right hand side argument of a TLS condition expression.
*)operator : ingress_tls_protocol_operator;The matching operator for a TLS condition expression.
*)evaluate : ingress_tls_protocol_to_evaluate;The left hand side argument of a TLS condition expression.
*)}The structure for a TLS related condition matching on the incoming mail.
type nonrec ingress_address_list_arn_list = address_list_arn listtype nonrec ingress_is_in_address_list = {address_lists : ingress_address_list_arn_list;The address lists that will be used for evaluation.
*)attribute : ingress_address_list_email_attribute;The email attribute that needs to be evaluated against the address list.
*)}The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
type nonrec ingress_boolean_to_evaluate = | IsInAddressList of ingress_is_in_address_listThe structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.
*)| Analysis of ingress_analysisThe structure type for a boolean condition stating the Add On ARN and its returned value.
*)The union type representing the allowed types of operands for a boolean condition.
type nonrec ingress_boolean_expression = {operator : ingress_boolean_operator;The matching operator for a boolean condition expression.
*)evaluate : ingress_boolean_to_evaluate;The operand on which to perform a boolean condition operation.
*)}The structure for a boolean condition matching on the incoming mail.
type nonrec policy_condition = | BooleanExpression of ingress_boolean_expressionThis 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'.
*)| TlsExpression of ingress_tls_protocol_expressionThis 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'.
*)| Ipv6Expression of ingress_ipv6_expressionThis 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'.
*)| IpExpression of ingress_ipv4_expressionThis 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'.
*)| StringExpression of ingress_string_expressionThis 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'.
*)The email traffic filtering conditions which are contained in a traffic policy resource.
type nonrec policy_conditions = policy_condition listtype nonrec policy_statement = {action : accept_action;The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
*)conditions : policy_conditions;The list of conditions to apply to incoming messages for filtering email traffic.
*)}The structure containing traffic policy conditions and actions.
type nonrec policy_statement_list = policy_statement listtype nonrec update_traffic_policy_request = {max_message_size_bytes : max_message_size_bytes option;The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
*)default_action : accept_action option;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 : policy_statement_list option;The list of conditions to be updated for filtering email traffic.
*)traffic_policy_name : traffic_policy_name option;A user-friendly name for the traffic policy resource.
*)traffic_policy_id : traffic_policy_id;The identifier of the traffic policy that you want to update.
*)}Occurs when a requested resource is not found.
The request configuration has conflicts. For details, see the accompanying error message.
type nonrec analysis = {result_field : result_field;The returned value from an Add On.
*)analyzer : analyzer_arn;The Amazon Resource Name (ARN) of an Add On.
*)}The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.
type nonrec rule_address_list_arn_list = address_list_arn listtype nonrec rule_is_in_address_list = {address_lists : rule_address_list_arn_list;The address lists that will be used for evaluation.
*)attribute : rule_address_list_email_attribute;The email attribute that needs to be evaluated against the address list.
*)}The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.
type nonrec rule_boolean_to_evaluate = | IsInAddressList of rule_is_in_address_listThe structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.
*)| Analysis of analysisThe Add On ARN and its returned value to evaluate in a boolean condition expression.
*)| Attribute of rule_boolean_email_attributeThe boolean type representing the allowed attribute types for an email.
*)The union type representing the allowed types of operands for a boolean condition.
type nonrec rule_boolean_expression = {operator : rule_boolean_operator;The matching operator for a boolean condition expression.
*)evaluate : rule_boolean_to_evaluate;The operand on which to perform a boolean condition operation.
*)}A boolean expression to be used in a rule condition.
The client certificate attribute to evaluate in a rule condition. These attributes are extracted from the client certificate presented during mutual TLS authentication.
type nonrec rule_string_to_evaluate = | ClientCertificateAttribute of rule_client_certificate_attributeThe client certificate attribute to evaluate in a string condition expression.
*)| Analysis of analysisThe Add On ARN and its returned value to evaluate in a string condition expression.
*)| MimeHeaderAttribute of mime_header_attributeThe email MIME X-Header attribute to evaluate in a string condition expression.
*)| Attribute of rule_string_email_attributeThe email attribute to evaluate in a string condition expression.
*)The string to evaluate in a string condition expression.
type nonrec rule_string_list = rule_string_value listtype nonrec rule_string_expression = {values : rule_string_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.
*)operator : rule_string_operator;The matching operator for a string condition expression.
*)evaluate : rule_string_to_evaluate;The string to evaluate in a string condition expression.
*)}A string expression is evaluated against strings or substrings of the email.
type nonrec rule_number_to_evaluate = | Attribute of rule_number_email_attributeAn email attribute that is used as the number to evaluate.
*)The number to evaluate in a numeric condition expression.
type nonrec rule_number_expression = {value : Smaws_Lib.Smithy_api.Types.double;The value to evaluate in a numeric condition expression.
*)operator : rule_number_operator;The operator for a numeric condition expression.
*)evaluate : rule_number_to_evaluate;The number to evaluate in a numeric condition expression.
*)}A number expression to match numeric conditions with integers from the incoming email.
type nonrec rule_ip_to_evaluate = | Attribute of rule_ip_email_attributeThe attribute of the email to evaluate.
*)The IP address to evaluate for this condition.
type nonrec rule_ip_value_list = rule_ip_string_value listtype nonrec rule_ip_expression = {values : rule_ip_value_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.
*)operator : rule_ip_operator;The operator to evaluate the IP address.
*)evaluate : rule_ip_to_evaluate;The IP address to evaluate in this condition.
*)}An IP address expression matching certain IP addresses within a given range of IP addresses.
type nonrec rule_verdict_to_evaluate = | Analysis of analysisThe Add On ARN and its returned value to evaluate in a verdict condition expression.
*)| Attribute of rule_verdict_attributeThe email verdict attribute to evaluate in a string verdict expression.
*)The verdict to evaluate in a verdict condition expression.
type nonrec rule_verdict_value_list = rule_verdict listtype nonrec rule_verdict_expression = {values : rule_verdict_value_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.
*)operator : rule_verdict_operator;The matching operator for a verdict condition expression.
*)evaluate : rule_verdict_to_evaluate;The verdict to evaluate in a verdict condition expression.
*)}A verdict expression is evaluated against verdicts of the email.
type nonrec rule_dmarc_value_list = rule_dmarc_policy listtype nonrec rule_dmarc_expression = {values : rule_dmarc_value_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.
*)operator : rule_dmarc_operator;The operator to apply to the DMARC policy of the incoming email.
*)}A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.
type nonrec rule_condition = | DmarcExpression of rule_dmarc_expressionThe condition applies to a DMARC policy expression passed in this field.
*)| VerdictExpression of rule_verdict_expressionThe condition applies to a verdict expression passed in this field.
*)| IpExpression of rule_ip_expressionThe condition applies to an IP address expression passed in this field.
*)| NumberExpression of rule_number_expressionThe condition applies to a number expression passed in this field.
*)| StringExpression of rule_string_expressionThe condition applies to a string expression passed in this field.
*)| BooleanExpression of rule_boolean_expressionThe condition applies to a boolean expression passed in this field.
*)The conditional expression used to evaluate an email for determining if a rule action should be taken.
type nonrec rule_conditions = rule_condition listtype nonrec relay_action = {mail_from : mail_from option;This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
*)relay : id_or_arn;The identifier of the relay resource to be used when relaying an email.
*)action_failure_policy : action_failure_policy option;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.
*)}The action relays the email via SMTP to another specific SMTP server.
type nonrec archive_action = {target_archive : name_or_arn;The identifier of the archive to send the email to.
*)action_failure_policy : action_failure_policy option;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.
*)}The action to archive the email by delivering the email to an Amazon SES archive.
type nonrec s3_action = {s3_sse_kms_key_id : kms_key_id option;The KMS Key ID to use to encrypt the message in S3.
*)s3_prefix : s3_prefix option;The S3 prefix to use for the write to the s3 bucket.
*)s3_bucket : s3_bucket;The bucket name of the S3 bucket to write to.
*)role_arn : iam_role_arn;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.
*)action_failure_policy : action_failure_policy option;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.
*)}Writes the MIME content of the email to an S3 bucket.
type nonrec send_action = {role_arn : iam_role_arn;The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
*)action_failure_policy : action_failure_policy option;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.
*)}Sends the email to the internet using the ses:SendRawEmail API.
type nonrec add_header_action = {header_value : header_value;The value of the header to add to the email.
*)header_name : header_name;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.
*)}The action to add a header to a message. When executed, this action will add the given header to the message.
type nonrec recipients = email_address listtype nonrec replace_recipient_action = {replace_with : recipients option;This action specifies the replacement recipient email addresses to insert.
*)}This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.
type nonrec deliver_to_mailbox_action = {role_arn : iam_role_arn;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.
*)mailbox_arn : name_or_arn;The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.
*)action_failure_policy : action_failure_policy option;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.
*)}This action to delivers an email to a mailbox.
type nonrec deliver_to_q_business_action = {role_arn : iam_role_arn;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.
index_id : q_business_index_id;The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
*)application_id : q_business_application_id;The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
*)action_failure_policy : action_failure_policy option;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.
}The action to deliver incoming emails to an Amazon Q Business application for indexing.
type nonrec sns_action = {payload_type : sns_notification_payload_type option;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.
encoding : sns_notification_encoding option;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.
role_arn : iam_role_arn;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.
topic_arn : sns_topic_arn;The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
*)action_failure_policy : action_failure_policy option;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.
}The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.
type nonrec bounce_action = {message : bounce_message option;The human-readable text to include in the bounce message.
*)diagnostic_message : diagnostic_message;The diagnostic message included in the Diagnostic-Code header of the bounce.
*)smtp_reply_code : smtp_reply_code;The SMTP reply code for the bounce, as defined by RFC 5321.
*)status_code : status_code;The enhanced status code for the bounce, in the format of x.y.z (e.g. 5.1.1).
*)sender : email_address;The sender email address of the bounce message.
*)role_arn : iam_role_arn;The Amazon Resource Name (ARN) of the IAM role to use to send the bounce message.
*)action_failure_policy : action_failure_policy option;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 SendBounce API.
*)}The action to send a bounce response for the email. When executed, this action generates a non-delivery report (bounce) back to the sender.
type nonrec invoke_lambda_action = {retry_time_minutes : lambda_retry_time_minutes option;The maximum time in minutes that the email processing can be retried if the Lambda invocation fails. The maximum value is 2160 minutes (36 hours).
*)role_arn : iam_role_arn;The Amazon Resource Name (ARN) of the IAM role to use to invoke the Lambda function.
*)invocation_type : lambda_invocation_type;The invocation type of the Lambda function. Use EVENT for asynchronous invocation or REQUEST_RESPONSE for synchronous invocation.
*)function_arn : lambda_function_arn;The Amazon Resource Name (ARN) of the Lambda function to invoke.
*)action_failure_policy : action_failure_policy option;A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the Amazon Web Services Lambda function no longer exists.
*)}The action to invoke an Amazon Web Services Lambda function for processing the email.
type nonrec rule_action = | InvokeLambda of invoke_lambda_actionThis action invokes an Amazon Web Services Lambda function to process the email.
*)| Bounce of bounce_actionThis action sends a bounce response for the email.
*)| PublishToSns of sns_actionThis action publishes the email content to an Amazon SNS topic.
*)| DeliverToQBusiness of deliver_to_q_business_actionThis action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
*)| DeliverToMailbox of deliver_to_mailbox_actionThis action delivers an email to a WorkMail mailbox.
*)| ReplaceRecipient of replace_recipient_actionThe action replaces certain or all recipients with a different set of recipients.
*)| AddHeader of add_header_actionThis action adds a header. This can be used to add arbitrary email headers.
*)| Send of send_actionThis action sends the email to the internet.
*)| WriteToS3 of s3_actionThis action writes the MIME content of the email to an S3 bucket.
*)| Archive of archive_actionThis action archives the email. This can be used to deliver an email to an archive.
*)| Relay of relay_actionThis action relays the email to another SMTP server.
*)| Drop of drop_actionThis action terminates the evaluation of rules in the rule set.
*)The action for a rule to take. Only one of the contained actions can be set.
type nonrec rule_actions = rule_action listtype nonrec rule = {actions : rule_actions;The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.
*)unless : rule_conditions option;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.
*)conditions : rule_conditions option;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"
*)name : rule_name option;The user-friendly name of the rule.
*)}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".
type nonrec rules = rule listtype nonrec update_rule_set_request = {rules : rules option;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.
*)rule_set_name : rule_set_name option;A user-friendly name for the rule set resource.
*)rule_set_id : rule_set_id;The identifier of a rule set you want to update.
*)}type nonrec relay_authentication = | NoAuthentication of no_authenticationKeep an empty structure if the relay destination server does not require SMTP credential authentication.
*)| SecretArn of secret_arnThe ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.
*)Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.
type nonrec update_relay_request = {authentication : relay_authentication option;Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
*)server_port : relay_server_port option;The destination relay server port.
*)server_name : relay_server_name option;The destination relay server address.
*)relay_name : relay_name option;The name of the relay resource.
*)relay_id : relay_id;The unique relay identifier.
*)}type nonrec trust_store = {kms_key_arn : kms_key_arn option;The Amazon Resource Name (ARN) of the KMS key used to encrypt the trust store contents.
*)crl_content : crl_content option;The PEM-encoded certificate revocation lists (CRLs) for the trust store. There can be one CRL per certificate authority (CA) in the trust store.
*)ca_content : ca_content;The PEM-encoded certificate authority (CA) certificates bundle for the trust store.
*)}The trust store used for mutual TLS authentication. It contains the certificate authority (CA) certificates and optional certificate revocation list (CRL).
type nonrec tls_auth_configuration = {trust_store : trust_store option;The trust store configuration for mutual TLS authentication.
*)}The mutual TLS authentication configuration for an ingress endpoint.
type nonrec ingress_point_configuration = | TlsAuthConfiguration of tls_auth_configurationThe mutual TLS authentication configuration of the ingress endpoint resource.
*)| SecretArn of secret_arnThe SecretsManager::Secret ARN of the ingress endpoint resource.
*)| SmtpPassword of smtp_passwordThe password of the ingress endpoint resource.
*)The configuration of the ingress endpoint resource.
type nonrec update_ingress_point_request = {tls_policy : tls_policy option;The Transport Layer Security (TLS) policy for the ingress point. Valid values are REQUIRED, OPTIONAL. Only ingress endpoints using REQUIRED or OPTIONAL as TlsPolicy can be updated.
*)ingress_point_configuration : ingress_point_configuration option;If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
*)traffic_policy_id : traffic_policy_id option;The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
*)rule_set_id : rule_set_id option;The identifier of an existing rule set that you attach to an ingress endpoint resource.
*)status_to_update : ingress_point_status_to_update option;The update status of an ingress endpoint.
*)ingress_point_name : ingress_point_name option;A user friendly name for the ingress endpoint resource.
*)ingress_point_id : ingress_point_id;The identifier for the ingress endpoint you want to update.
*)}type nonrec archive_retention = | RetentionPeriod of retention_periodThe enum value sets the period for retaining emails in an archive.
*)The retention policy for an email archive that specifies how long emails are kept before being automatically deleted.
type nonrec update_archive_request = {retention : archive_retention option;A new retention period for emails in the archive.
*)archive_name : archive_name_string option;A new, unique name for the archive.
*)archive_id : archive_id_string;The identifier of the archive to update.
*)}The request to update properties of an existing email archive.
Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
Occurs when an operation exceeds a predefined service quota or limit.
Occurs when a user is denied access to a specific resource or action.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
*)resource_arn : taggable_resource_arn;The Amazon Resource Name (ARN) of the resource that you want to untag.
*)}Specifies whether to include trust store contents in the GetIngressPoint response.
type nonrec traffic_policy_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec traffic_policy = {default_action : accept_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
*)traffic_policy_id : traffic_policy_id;The identifier of the traffic policy resource.
*)traffic_policy_name : traffic_policy_name;A user-friendly name of the traffic policy resource.
*)}The structure of a traffic policy resource which is a container for policy statements.
type nonrec traffic_policy_list = traffic_policy listtype nonrec tag = {value : tag_value;The value of the key-value tag.
*)key : tag_key;The key of the key-value tag.
*)}A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_arn : taggable_resource_arn;The Amazon Resource Name (ARN) of the resource that you want to tag.
*)}type nonrec string_value_list = string_value listtype nonrec stop_archive_search_request = {search_id : search_id;The identifier of the search job to stop.
*)}The request to stop an in-progress archive search job.
type nonrec stop_archive_export_request = {export_id : export_id;The identifier of the export job to stop.
*)}The request to stop an in-progress archive export job.
type nonrec stop_address_list_import_job_request = {job_id : job_id;The identifier of the import job that needs to be stopped.
*)}type nonrec start_archive_search_response = {search_id : search_id option;The unique identifier for the initiated search job.
*)}The response from initiating an archive search.
type nonrec archive_string_to_evaluate = | Attribute of archive_string_email_attributeThe name of the email attribute to evaluate.
*)Specifies the email attribute to evaluate in a string expression.
type nonrec archive_string_expression = {values : string_value_list;The list of string values to evaluate the email attribute against.
*)operator : archive_string_operator;The operator to use when evaluating the string values.
*)evaluate : archive_string_to_evaluate;The attribute of the email to evaluate.
*)}A string expression to evaluate an email attribute value against one or more string values.
type nonrec archive_boolean_to_evaluate = | Attribute of archive_boolean_email_attributeThe name of the email attribute to evaluate.
*)The attribute to evaluate in a boolean expression.
type nonrec archive_boolean_expression = {operator : archive_boolean_operator;The boolean operator to use for evaluation.
*)evaluate : archive_boolean_to_evaluate;The email attribute value to evaluate.
*)}A boolean expression to evaluate email attribute values.
type nonrec archive_filter_condition = | BooleanExpression of archive_boolean_expressionA boolean expression to evaluate against email attributes.
*)| StringExpression of archive_string_expressionA string expression to evaluate against email attributes.
*)A filter condition used to include or exclude emails when exporting from or searching an archive.
type nonrec archive_filter_conditions = archive_filter_condition listtype nonrec archive_filters = {unless : archive_filter_conditions option;The filter conditions for emails to exclude.
*)include_ : archive_filter_conditions option;The filter conditions for emails to include.
*)}A set of filter conditions to include and/or exclude emails.
type nonrec start_archive_search_request = {max_results : search_max_results;The maximum number of search results to return.
*)to_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The end timestamp of the range to search emails from.
*)from_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The start timestamp of the range to search emails from.
*)filters : archive_filters option;Criteria to filter which emails are included in the search results.
*)archive_id : archive_id;The identifier of the archive to search emails in.
*)}The request to initiate a search across emails in an archive.
type nonrec start_archive_export_response = {export_id : export_id option;The unique identifier for the initiated export job.
*)}The response from initiating an archive export.
type nonrec s3_export_destination_configuration = {s3_location : s3_location option;The S3 location to deliver the exported email data.
*)}The configuration for exporting email data to an Amazon S3 bucket.
type nonrec export_destination_configuration = | S3 of s3_export_destination_configurationConfiguration for delivering to an Amazon S3 bucket.
*)The destination configuration for delivering exported email data.
type nonrec start_archive_export_request = {include_metadata : Smaws_Lib.Smithy_api.Types.boolean_ option;Whether to include message metadata as JSON files in the export.
*)export_destination_configuration : export_destination_configuration;Details on where to deliver the exported email data.
*)max_results : export_max_results option;The maximum number of email items to include in the export.
*)to_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The end of the timestamp range to include emails from.
*)from_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The start of the timestamp range to include emails from.
*)filters : archive_filters option;Criteria to filter which emails are included in the export.
*)archive_id : archive_id;The identifier of the archive to export emails from.
*)}The request to initiate an export of emails from an archive.
type nonrec start_address_list_import_job_request = {job_id : job_id;The identifier of the import job that needs to be started.
*)}type nonrec search_status = {error_message : error_message option;An error message if the search failed.
*)state : search_state option;The current state of the search job.
*)completion_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the search completed (if finished).
*)submission_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the search was submitted.
*)}The current status of an archive search job.
type nonrec search_summary = {status : search_status option;The current status of the search job.
*)search_id : search_id option;The unique identifier of the search job.
*)}Summary details of an archive search job.
type nonrec search_summary_list = search_summary listtype nonrec saved_address = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp of when the address was added to the address list.
*)address : address;The email or domain that constitutes the address.
*)}An address that is a member of an address list.
type nonrec saved_addresses = saved_address listtype nonrec rule_set = {last_modification_date : Smaws_Lib.Smithy_api.Types.timestamp option;The last modification date of the rule set.
*)rule_set_name : rule_set_name option;A user-friendly name for the rule set.
*)rule_set_id : rule_set_id option;The identifier of the rule set.
*)}A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.
type nonrec rule_sets = rule_set listtype nonrec rule_set_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec email_received_headers_list =
Smaws_Lib.Smithy_api.Types.string_ listtype nonrec envelope = {to_ : string_list option;All SMTP TO entries given by the host from which the email was received.
*)from_ : Smaws_Lib.Smithy_api.Types.string_ option;The RCPT FROM given by the host from which the email was received.
*)helo : Smaws_Lib.Smithy_api.Types.string_ option;The HELO used by the host from which the email was received.
*)}The SMTP envelope information of the email.
type nonrec row = {source_arn : Smaws_Lib.Smithy_api.Types.string_ option;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 : envelope option;The SMTP envelope information of the email.
*)sender_ip_address : sender_ip_address option;sender_hostname : Smaws_Lib.Smithy_api.Types.string_ option;The name of the host from which the email was received.
*)ingress_point_id : ingress_point_id option;The ID of the ingress endpoint through which the email was received.
*)x_priority : Smaws_Lib.Smithy_api.Types.string_ option;The priority level of the email.
*)x_original_mailer : Smaws_Lib.Smithy_api.Types.string_ option;The original user agent that sent the email.
*)x_mailer : Smaws_Lib.Smithy_api.Types.string_ option;The user agent that sent the email.
*)in_reply_to : Smaws_Lib.Smithy_api.Types.string_ option;The email message ID this is a reply to.
*)received_headers : email_received_headers_list option;The received headers from the email delivery path.
*)has_attachments : Smaws_Lib.Smithy_api.Types.boolean_ option;A flag indicating if the email has attachments.
*)message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique message ID of the email.
*)subject : Smaws_Lib.Smithy_api.Types.string_ option;The subject header value of the email.
*)cc : Smaws_Lib.Smithy_api.Types.string_ option;The email addresses in the CC header.
*)from_ : Smaws_Lib.Smithy_api.Types.string_ option;The email address of the sender.
*)to_ : Smaws_Lib.Smithy_api.Types.string_ option;The email addresses in the To header.
*)date : Smaws_Lib.Smithy_api.Types.string_ option;The date the email was sent.
*)received_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the email was received.
*)archived_message_id : archived_message_id option;The unique identifier of the archived message.
*)}A result row containing metadata for an archived email message.
type nonrec rows_list = row listtype nonrec relay = {last_modified_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the relay was last modified.
*)relay_name : relay_name option;The unique relay name.
*)relay_id : relay_id option;The unique relay identifier.
*)}The relay resource that can be used as a rule to relay receiving emails to the destination relay server.
type nonrec relays = relay listtype nonrec relay_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec register_member_to_address_list_request = {address : address;The address to be added to the address list.
*)address_list_id : address_list_id;The unique identifier of the address list where the address should be added.
*)}type nonrec public_network_configuration = {ip_type : ip_type;The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.
*)}Specifies the network configuration for the public ingress point.
type nonrec private_network_configuration = {vpc_endpoint_id : vpc_endpoint_id;The identifier of the VPC endpoint to associate with this private ingress point.
*)}Specifies the network configuration for the private ingress point.
type nonrec network_configuration = | PrivateNetworkConfiguration of private_network_configurationSpecifies the network configuration for the private ingress point.
*)| PublicNetworkConfiguration of public_network_configurationSpecifies the network configuration for the public ingress point.
*)The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.
type nonrec metadata = {source_arn : Smaws_Lib.Smithy_api.Types.string_ option;Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
*)configuration_set : Smaws_Lib.Smithy_api.Types.string_ option;The name of the configuration set used when sent through a configuration set with archiving enabled.
*)sending_pool : Smaws_Lib.Smithy_api.Types.string_ option;The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.
*)source_identity : Smaws_Lib.Smithy_api.Types.string_ option;The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.
*)sending_method : Smaws_Lib.Smithy_api.Types.string_ option;The name of the API call used when sent through a configuration set with archiving enabled.
*)tls_protocol : Smaws_Lib.Smithy_api.Types.string_ option;The TLS protocol used to communicate with the host from which the email was received.
*)tls_cipher_suite : Smaws_Lib.Smithy_api.Types.string_ option;The TLS cipher suite used to communicate with the host from which the email was received.
*)sender_ip_address : sender_ip_address option;The IP address of the host from which the email was received.
*)sender_hostname : Smaws_Lib.Smithy_api.Types.string_ option;The name of the host from which the email was received.
*)rule_set_id : rule_set_id option;The ID of the rule set that processed the email.
*)traffic_policy_id : traffic_policy_id option;The ID of the traffic policy that was in effect when the email was received.
*)ingress_point_id : ingress_point_id option;The ID of the ingress endpoint through which the email was received.
*)timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the email was received.
*)}The metadata about the email.
type nonrec message_body = {message_malformed : Smaws_Lib.Smithy_api.Types.boolean_ option;A flag indicating if the email was malformed.
*)html : Smaws_Lib.Smithy_api.Types.string_ option;The HTML body content of the message.
*)text : Smaws_Lib.Smithy_api.Types.string_ option;The plain text body content of the message.
*)}The textual body content of an email message.
type nonrec list_members_of_address_list_response = {next_token : pagination_token option;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.
*)addresses : saved_addresses;The list of addresses.
*)}type nonrec address_filter = {address_prefix : address_prefix option;Filter to limit the results to addresses having the provided prefix.
*)}Filtering options for ListMembersOfAddressList operation.
type nonrec list_members_of_address_list_request = {page_size : address_page_size option;The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.
*)next_token : pagination_token option;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.
*)filter : address_filter option;Filter to be used to limit the results.
*)address_list_id : address_list_id;The unique identifier of the address list to list the addresses from.
*)}type nonrec list_archive_searches_response = {next_token : pagination_token option;If present, use to retrieve the next page of results.
*)searches : search_summary_list option;The list of search job identifiers and statuses.
*)}The response containing a list of archive search jobs and their statuses.
type nonrec list_archive_searches_request = {page_size : page_size option;The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.
*)next_token : pagination_token option;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.
*)archive_id : archive_id;The identifier of the archive.
*)}The request to list archive search jobs in your account.
type nonrec export_status = {error_message : error_message option;An error message if the export job failed.
*)state : export_state option;The current state of the export job.
*)completion_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the export job completed (if finished).
*)submission_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the export job was submitted.
*)}The current status of an archive export job.
type nonrec export_summary = {status : export_status option;The current status of the export job.
*)export_id : export_id option;The unique identifier of the export job.
*)}Summary statuses of an archive export job.
type nonrec export_summary_list = export_summary listtype nonrec list_archive_exports_response = {next_token : pagination_token option;If present, use to retrieve the next page of results.
*)exports : export_summary_list option;The list of export job identifiers and statuses.
*)}The response containing a list of archive export jobs and their statuses.
type nonrec list_archive_exports_request = {page_size : page_size option;The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.
*)next_token : pagination_token option;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.
*)archive_id : archive_id;The identifier of the archive.
*)}The request to list archive export jobs in your account.
type nonrec import_data_format = {import_data_type : import_data_type;The type of file that would be passed as an input for the address list import job.
*)}The import data format contains the specifications of the input file that would be passed to the address list import job.
type nonrec import_job = {error : error_message option;The reason for failure of an import job.
*)completed_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the import job was completed.
*)start_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the import job was started.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp of when the import job was created.
*)address_list_id : address_list_id;The unique identifier of the address list the import job was created for.
*)import_data_format : import_data_format;The format of the input for the import job.
*)failed_items_count : job_items_count option;The number of addresses in the input that failed to get imported into address list.
*)imported_items_count : job_items_count option;The number of addresses in the input that were successfully imported into the address list.
*)pre_signed_url : pre_signed_url;The pre-signed URL target for uploading the input file.
*)status : import_job_status;The status of the import job.
*)name : job_name;A user-friendly name for the import job.
*)job_id : job_id;The identifier of the import job.
*)}Details about an import job.
type nonrec import_jobs = import_job listtype nonrec list_address_list_import_jobs_response = {next_token : pagination_token option;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.
*)import_jobs : import_jobs;The list of import jobs.
*)}type nonrec list_address_list_import_jobs_request = {page_size : page_size option;The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.
*)next_token : pagination_token option;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.
*)address_list_id : address_list_id;The unique identifier of the address list for listing import jobs.
*)}type nonrec get_member_of_address_list_response = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp of when the address was created.
*)address : address;The address retrieved from the address list.
*)}type nonrec get_member_of_address_list_request = {address : address;The address to be retrieved from the address list.
*)address_list_id : address_list_id;The unique identifier of the address list to retrieve the address from.
*)}type nonrec get_archive_search_results_response = {rows : rows_list option;The list of email result objects matching the search criteria.
*)}The response containing search results from a completed archive search.
type nonrec get_archive_search_results_request = {search_id : search_id;The identifier of the completed search job.
*)}The request to retrieve results from a completed archive search job.
type nonrec get_archive_search_response = {status : search_status option;The current status of the search job.
*)max_results : search_max_results option;The maximum number of search results to return.
*)to_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The end timestamp of the range the searched emails cover.
*)from_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The start timestamp of the range the searched emails cover.
*)filters : archive_filters option;The criteria used to filter emails included in the search.
*)archive_id : archive_id option;The identifier of the archive the email search was performed in.
*)}The response containing details of the specified archive search job.
type nonrec get_archive_search_request = {search_id : search_id;The identifier of the search job to get details for.
*)}The request to retrieve details of a specific archive search job.
type nonrec get_archive_message_content_response = {body : message_body option;The textual body content of the email message.
*)}The response containing the textual content of the requested archived email message.
type nonrec get_archive_message_content_request = {archived_message_id : archived_message_id;The unique identifier of the archived email message.
*)}The request to get the textual content of a specific email message stored in an archive.
type nonrec get_archive_message_response = {envelope : envelope option;The SMTP envelope information of the email.
*)metadata : metadata option;The metadata about the email.
*)message_download_link : s3_presigned_ur_l option;A pre-signed URL to temporarily download the full message content.
*)}The response containing details about the requested archived email message.
type nonrec get_archive_message_request = {archived_message_id : archived_message_id;The unique identifier of the archived email message.
*)}The request to get details of a specific email message stored in an archive.
type nonrec get_archive_export_response = {status : export_status option;The current status of the export job.
*)export_destination_configuration : export_destination_configuration option;Where the exported emails are being delivered.
*)max_results : export_max_results option;The maximum number of email items included in the export.
*)to_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The end of the date range the exported emails cover.
*)from_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The start of the timestamp range the exported emails cover.
*)filters : archive_filters option;The criteria used to filter emails included in the export.
*)archive_id : archive_id option;The identifier of the archive the email export was performed from.
*)}The response containing details of the specified archive export job.
type nonrec get_archive_export_request = {export_id : export_id;The identifier of the export job to get details for.
*)}The request to retrieve details of a specific archive export job.
type nonrec get_address_list_import_job_response = {error : error_message option;The reason for failure of an import job.
*)completed_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the import job was completed.
*)start_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the import job was started.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp of when the import job was created.
*)address_list_id : address_list_id;The unique identifier of the address list the import job was created for.
*)import_data_format : import_data_format;The format of the input for an import job.
*)failed_items_count : job_items_count option;The number of input addresses that failed to be imported into the address list.
*)imported_items_count : job_items_count option;The number of input addresses successfully imported into the address list.
*)pre_signed_url : pre_signed_url;The pre-signed URL target for uploading the input file.
*)status : import_job_status;The status of the import job.
*)name : job_name;A user-friendly name for the import job.
*)job_id : job_id;The identifier of the import job.
*)}type nonrec get_address_list_import_job_request = {job_id : job_id;The identifier of the import job that needs to be retrieved.
*)}type nonrec deregister_member_from_address_list_request = {address : address;The address to be removed from the address list.
*)address_list_id : address_list_id;The unique identifier of the address list to remove the address from.
*)}type nonrec create_address_list_import_job_response = {pre_signed_url : pre_signed_url;The pre-signed URL target for uploading the input file.
*)job_id : job_id;The identifier of the created import job.
*)}type nonrec create_address_list_import_job_request = {import_data_format : import_data_format;The format of the input for an import job.
*)name : job_name;A user-friendly name for the import job.
*)address_list_id : address_list_id;The unique identifier of the address list for importing addresses to.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec list_traffic_policies_response = {next_token : pagination_token option;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.
*)traffic_policies : traffic_policy_list option;The list of traffic policies.
*)}type nonrec list_traffic_policies_request = {next_token : pagination_token option;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.
*)page_size : page_size option;The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
*)}type nonrec list_rule_sets_response = {next_token : pagination_token option;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.
*)rule_sets : rule_sets;The list of rule sets.
*)}type nonrec list_rule_sets_request = {page_size : page_size option;The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.
*)next_token : pagination_token option;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.
*)}type nonrec list_relays_response = {next_token : pagination_token option;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.
*)relays : relays;The list of returned relays.
*)}type nonrec list_relays_request = {next_token : pagination_token option;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.
*)page_size : Smaws_Lib.Smithy_api.Types.integer option;The number of relays to be returned in one request.
*)}type nonrec ingress_point = {a_record : ingress_point_a_record option;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.
*)type_ : ingress_point_type;The type of ingress endpoint resource.
*)status : ingress_point_status;The status of the ingress endpoint resource.
*)ingress_point_id : ingress_point_id;The identifier of the ingress endpoint resource.
*)ingress_point_name : ingress_point_name;A user friendly name for the ingress endpoint resource.
*)}The structure of an ingress endpoint resource.
type nonrec ingress_points_list = ingress_point listtype nonrec list_ingress_points_response = {next_token : pagination_token option;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.
*)ingress_points : ingress_points_list option;The list of ingress endpoints.
*)}type nonrec list_ingress_points_request = {next_token : pagination_token option;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.
*)page_size : page_size option;The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
*)}type nonrec archive = {last_updated_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the archive was last updated.
*)archive_state : archive_state option;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.archive_name : archive_name_string option;The unique name assigned to the archive.
*)archive_id : archive_id_string;The unique identifier of the archive.
*)}An archive resource for storing and retaining emails.
type nonrec archives_list = archive listtype nonrec list_archives_response = {next_token : pagination_token option;If present, use to retrieve the next page of results.
*)archives : archives_list;The list of archive details.
*)}The response containing a list of your email archives.
type nonrec list_archives_request = {page_size : page_size option;The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
*)next_token : pagination_token option;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.
*)}The request to list email archives in your account.
type nonrec address_list = {last_updated_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp of when the address list was last updated.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp of when the address list was created.
*)address_list_name : address_list_name;The user-friendly name of the address list.
*)address_list_arn : address_list_arn;The Amazon Resource Name (ARN) of the address list.
*)address_list_id : address_list_id;The identifier of the address list.
*)}An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.
type nonrec address_lists = address_list listtype nonrec list_address_lists_response = {next_token : pagination_token option;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.
*)address_lists : address_lists;The list of address lists.
*)}type nonrec list_address_lists_request = {page_size : page_size option;The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.
*)next_token : pagination_token option;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.
*)}type nonrec addon_subscription = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the Add On subscription was created.
*)addon_subscription_arn : addon_subscription_arn option;The Amazon Resource Name (ARN) of the Add On subscription.
*)addon_name : addon_name option;The name of the Add On.
*)addon_subscription_id : addon_subscription_id option;The unique ID of the Add On subscription.
*)}A subscription for an Add On representing the acceptance of its terms of use and additional pricing.
type nonrec addon_subscriptions = addon_subscription listtype nonrec list_addon_subscriptions_response = {next_token : pagination_token option;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.
*)addon_subscriptions : addon_subscriptions option;The list of ingress endpoints.
*)}type nonrec list_addon_subscriptions_request = {page_size : page_size option;The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
*)next_token : pagination_token option;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.
*)}type nonrec addon_instance = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the Add On instance was created.
*)addon_instance_arn : addon_instance_arn option;The Amazon Resource Name (ARN) of the Add On instance.
*)addon_name : addon_name option;The name of the Add On for the instance.
*)addon_subscription_id : addon_subscription_id option;The subscription ID for the instance.
*)addon_instance_id : addon_instance_id option;The unique ID of the Add On instance.
*)}An Add On instance represents a specific configuration of an Add On.
type nonrec addon_instances = addon_instance listtype nonrec list_addon_instances_response = {next_token : pagination_token option;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.
*)addon_instances : addon_instances option;The list of ingress endpoints.
*)}type nonrec list_addon_instances_request = {page_size : page_size option;The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
*)next_token : pagination_token option;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.
*)}type nonrec ingress_point_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec ingress_point_password_configuration = {previous_smtp_password_expiry_timestamp : Smaws_Lib.Smithy_api.Types.timestamp
option;The previous password expiry timestamp of the ingress endpoint resource.
*)previous_smtp_password_version : Smaws_Lib.Smithy_api.Types.string_ option;The previous password version of the ingress endpoint resource.
*)smtp_password_version : Smaws_Lib.Smithy_api.Types.string_ option;The current password expiry timestamp of the ingress endpoint resource.
*)}The password configuration of the ingress endpoint resource.
type nonrec ingress_point_auth_configuration = {tls_auth_configuration : tls_auth_configuration option;The mutual TLS authentication configuration for the ingress endpoint resource.
*)secret_arn : secret_arn option;The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.
*)ingress_point_password_configuration : ingress_point_password_configuration
option;The ingress endpoint password configuration for the ingress endpoint resource.
*)}The authentication configuration for the ingress endpoint resource.
type nonrec get_traffic_policy_response = {last_updated_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the traffic policy was last updated.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the traffic policy was created.
*)default_action : accept_action option;The default action of the traffic policy.
*)max_message_size_bytes : max_message_size_bytes option;The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
*)policy_statements : policy_statement_list option;The list of conditions which are in the traffic policy resource.
*)traffic_policy_arn : traffic_policy_arn option;The Amazon Resource Name (ARN) of the traffic policy resource.
*)traffic_policy_id : traffic_policy_id;The identifier of the traffic policy resource.
*)traffic_policy_name : traffic_policy_name;A user-friendly name for the traffic policy resource.
*)}type nonrec get_traffic_policy_request = {traffic_policy_id : traffic_policy_id;The identifier of the traffic policy resource.
*)}type nonrec get_rule_set_response = {rules : rules;The rules contained in the rule set.
*)last_modification_date : Smaws_Lib.Smithy_api.Types.timestamp;The date of when the rule set was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.timestamp;The date of when then rule set was created.
*)rule_set_name : rule_set_name;A user-friendly name for the rule set resource.
*)rule_set_arn : rule_set_arn;The Amazon Resource Name (ARN) of the rule set resource.
*)rule_set_id : rule_set_id;The identifier of the rule set resource.
*)}type nonrec get_rule_set_request = {rule_set_id : rule_set_id;The identifier of an existing rule set to be retrieved.
*)}type nonrec get_relay_response = {last_modified_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when relay was last updated.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the relay was created.
*)authentication : relay_authentication option;The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.
*)server_port : relay_server_port option;The destination relay server port.
*)server_name : relay_server_name option;The destination relay server address.
*)relay_name : relay_name option;The unique name of the relay.
*)relay_arn : relay_arn option;The Amazon Resource Name (ARN) of the relay.
*)relay_id : relay_id;The unique relay identifier.
*)}type nonrec get_ingress_point_response = {last_updated_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the ingress endpoint was last updated.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the ingress endpoint was created.
*)tls_policy : tls_policy option;The selected Transport Layer Security (TLS) policy of the ingress point.
*)network_configuration : network_configuration option;The network configuration for the ingress point.
*)ingress_point_auth_configuration : ingress_point_auth_configuration option;The authentication configuration of the ingress endpoint resource.
*)traffic_policy_id : traffic_policy_id option;The identifier of the traffic policy resource associated with the ingress endpoint.
*)rule_set_id : rule_set_id option;The identifier of a rule set resource associated with the ingress endpoint.
*)a_record : ingress_point_a_record option;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.
*)type_ : ingress_point_type option;The type of ingress endpoint.
*)status : ingress_point_status option;The status of the ingress endpoint resource.
*)ingress_point_arn : ingress_point_arn option;The Amazon Resource Name (ARN) of the ingress endpoint resource.
*)ingress_point_name : ingress_point_name;A user friendly name for the ingress endpoint.
*)ingress_point_id : ingress_point_id;The identifier of an ingress endpoint resource.
*)}type nonrec get_ingress_point_request = {include_trust_store_contents : trust_store_response_option option;Whether to include the trust store contents in the response. Use INCLUDE to retrieve trust store certificate and CRL contents.
*)ingress_point_id : ingress_point_id;The identifier of an ingress endpoint.
*)}type nonrec get_archive_response = {kms_key_arn : kms_key_arn option;The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
*)last_updated_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the archive was modified.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the archive was created.
*)retention : archive_retention;The retention period for emails in this archive.
*)archive_state : archive_state;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.archive_arn : archive_arn;The Amazon Resource Name (ARN) of the archive.
*)archive_name : archive_name_string;The unique name assigned to the archive.
*)archive_id : archive_id_string;The unique identifier of the archive.
*)}The response containing details of the requested archive.
type nonrec get_archive_request = {archive_id : archive_id_string;The identifier of the archive to retrieve.
*)}The request to retrieve details of an email archive.
type nonrec get_address_list_response = {last_updated_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The date of when the address list was last updated.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;The date of when then address list was created.
*)address_list_name : address_list_name;A user-friendly name for the address list resource.
*)address_list_arn : address_list_arn;The Amazon Resource Name (ARN) of the address list resource.
*)address_list_id : address_list_id;The identifier of the address list resource.
*)}type nonrec get_address_list_request = {address_list_id : address_list_id;The identifier of an existing address list resource to be retrieved.
*)}type nonrec get_addon_subscription_response = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the Add On subscription was created.
*)addon_subscription_arn : addon_subscription_arn option;Amazon Resource Name (ARN) for the subscription.
*)addon_name : addon_name option;The name of the Add On for the subscription.
*)}type nonrec get_addon_subscription_request = {addon_subscription_id : addon_subscription_id;The Add On subscription ID to retrieve information for.
*)}type nonrec get_addon_instance_response = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of when the Add On instance was created.
*)addon_instance_arn : addon_instance_arn option;The Amazon Resource Name (ARN) of the Add On instance.
*)addon_name : addon_name option;The name of the Add On provider associated to the subscription of the instance.
*)addon_subscription_id : addon_subscription_id option;The subscription ID associated to the instance.
*)}type nonrec get_addon_instance_request = {addon_instance_id : addon_instance_id;The Add On instance ID to retrieve information for.
*)}type nonrec delete_traffic_policy_request = {traffic_policy_id : traffic_policy_id;The identifier of the traffic policy that you want to delete.
*)}type nonrec delete_rule_set_request = {rule_set_id : rule_set_id;The identifier of an existing rule set resource to delete.
*)}type nonrec delete_ingress_point_request = {ingress_point_id : ingress_point_id;The identifier of the ingress endpoint resource that you want to delete.
*)}type nonrec delete_archive_request = {archive_id : archive_id_string;The identifier of the archive to delete.
*)}The request to initiate deletion of an email archive.
type nonrec delete_address_list_request = {address_list_id : address_list_id;The identifier of an existing address list resource to delete.
*)}type nonrec delete_addon_subscription_request = {addon_subscription_id : addon_subscription_id;The Add On subscription ID to delete.
*)}type nonrec delete_addon_instance_request = {addon_instance_id : addon_instance_id;The Add On instance ID to delete.
*)}type nonrec create_traffic_policy_response = {traffic_policy_id : traffic_policy_id;The identifier of the traffic policy resource.
*)}type nonrec create_traffic_policy_request = {max_message_size_bytes : max_message_size_bytes option;The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
*)default_action : accept_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 : policy_statement_list;Conditional statements for filtering email traffic.
*)traffic_policy_name : traffic_policy_name;A user-friendly name for the traffic policy resource.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec create_rule_set_response = {rule_set_id : rule_set_id;The identifier of the created rule set.
*)}type nonrec create_rule_set_request = {rules : rules;Conditional rules that are evaluated for determining actions on email.
*)rule_set_name : rule_set_name;A user-friendly name for the rule set.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec create_relay_response = {relay_id : relay_id;A unique identifier of the created relay resource.
*)}type nonrec create_relay_request = {authentication : relay_authentication;Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
*)server_port : relay_server_port;The destination relay server port.
*)server_name : relay_server_name;The destination relay server address.
*)relay_name : relay_name;The unique name of the relay resource.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec create_ingress_point_response = {ingress_point_id : ingress_point_id;The unique identifier for a previously created ingress endpoint.
*)}type nonrec create_ingress_point_request = {tls_policy : tls_policy option;The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions.
*)network_configuration : network_configuration option;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.
*)ingress_point_configuration : ingress_point_configuration option;If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
*)traffic_policy_id : traffic_policy_id;The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
*)rule_set_id : rule_set_id;The identifier of an existing rule set that you attach to an ingress endpoint resource.
*)type_ : ingress_point_type;The type of the ingress endpoint to create.
*)ingress_point_name : ingress_point_name;A user friendly name for an ingress endpoint resource.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec create_archive_response = {archive_id : archive_id_string;The unique identifier for the newly created archive.
*)}The response from creating a new email archive.
type nonrec create_archive_request = {kms_key_arn : kms_key_arn option;The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*)retention : archive_retention option;The period for retaining emails in the archive before automatic deletion.
*)archive_name : archive_name_string;A unique name for the new archive.
*)client_token : idempotency_token option;A unique token Amazon SES uses to recognize retries of this request.
*)}The request to create a new email archive.
type nonrec create_address_list_response = {address_list_id : address_list_id;The identifier of the created address list.
*)}type nonrec create_address_list_request = {address_list_name : address_list_name;A user-friendly name for the address list.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec create_addon_subscription_response = {addon_subscription_id : addon_subscription_id;The unique ID of the Add On subscription created by this API.
*)}type nonrec create_addon_subscription_request = {addon_name : addon_name;The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec create_addon_instance_response = {addon_instance_id : addon_instance_id;The unique ID of the Add On instance created by this API.
*)}type nonrec create_addon_instance_request = {addon_subscription_id : 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.
*)client_token : idempotency_token option;A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*)}type nonrec archive_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec address_list_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec addon_subscription_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec addon_instance_resource = Smaws_Lib.CoreTypes.Resource.t