MailManager

2025/04/03 - MailManager - 5 updated api methods

Changes  Add support for Dual_Stack and PrivateLink types of IngressPoint. For configuration requests, SES Mail Manager will now accept both IPv4/IPv6 dual-stack endpoints and AWS PrivateLink VPC endpoints for email receiving.

CreateIngressPoint (updated) Link ¶
Changes (request)
{'NetworkConfiguration': {'PrivateNetworkConfiguration': {'VpcEndpointId': 'string'},
                          'PublicNetworkConfiguration': {'IpType': 'IPV4 | '
                                                                   'DUAL_STACK'}}}

Provision a new ingress endpoint resource.

See also: AWS API Documentation

Request Syntax

client.create_ingress_point(
    ClientToken='string',
    IngressPointConfiguration={
        'SecretArn': 'string',
        'SmtpPassword': 'string'
    },
    IngressPointName='string',
    NetworkConfiguration={
        'PrivateNetworkConfiguration': {
            'VpcEndpointId': 'string'
        },
        'PublicNetworkConfiguration': {
            'IpType': 'IPV4'|'DUAL_STACK'
        }
    },
    RuleSetId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TrafficPolicyId='string',
    Type='OPEN'|'AUTH'
)
type ClientToken:

string

param ClientToken:

A unique token that Amazon SES uses to recognize subsequent retries of the same request.

This field is autopopulated if not provided.

type IngressPointConfiguration:

dict

param IngressPointConfiguration:

If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

  • SecretArn (string) --

    The SecretsManager::Secret ARN of the ingress endpoint resource.

  • SmtpPassword (string) --

    The password of the ingress endpoint resource.

type IngressPointName:

string

param IngressPointName:

[REQUIRED]

A user friendly name for an ingress endpoint resource.

type NetworkConfiguration:

dict

param NetworkConfiguration:

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.

  • PrivateNetworkConfiguration (dict) --

    Specifies the network configuration for the private ingress point.

    • VpcEndpointId (string) -- [REQUIRED]

      The identifier of the VPC endpoint to associate with this private ingress point.

  • PublicNetworkConfiguration (dict) --

    Specifies the network configuration for the public ingress point.

    • IpType (string) -- [REQUIRED]

      The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.

type RuleSetId:

string

param RuleSetId:

[REQUIRED]

The identifier of an existing rule set that you attach to an ingress endpoint resource.

type Tags:

list

param Tags:

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

  • (dict) --

    A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.

    • Key (string) -- [REQUIRED]

      The key of the key-value tag.

    • Value (string) -- [REQUIRED]

      The value of the key-value tag.

type TrafficPolicyId:

string

param TrafficPolicyId:

[REQUIRED]

The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

type Type:

string

param Type:

[REQUIRED]

The type of the ingress endpoint to create.

rtype:

dict

returns:

Response Syntax

{
    'IngressPointId': 'string'
}

Response Structure

  • (dict) --

    • IngressPointId (string) --

      The unique identifier for a previously created ingress endpoint.

CreateTrafficPolicy (updated) Link ¶
Changes (request)
{'PolicyStatements': {'Conditions': {'Ipv6Expression': {'Evaluate': {'Attribute': 'SENDER_IPV6'},
                                                        'Operator': 'CIDR_MATCHES '
                                                                    '| '
                                                                    'NOT_CIDR_MATCHES',
                                                        'Values': ['string']}}}}

Provision a new traffic policy resource.

See also: AWS API Documentation

Request Syntax

client.create_traffic_policy(
    ClientToken='string',
    DefaultAction='ALLOW'|'DENY',
    MaxMessageSizeBytes=123,
    PolicyStatements=[
        {
            'Action': 'ALLOW'|'DENY',
            'Conditions': [
                {
                    'BooleanExpression': {
                        'Evaluate': {
                            'Analysis': {
                                'Analyzer': 'string',
                                'ResultField': 'string'
                            },
                            'IsInAddressList': {
                                'AddressLists': [
                                    'string',
                                ],
                                'Attribute': 'RECIPIENT'
                            }
                        },
                        'Operator': 'IS_TRUE'|'IS_FALSE'
                    },
                    'IpExpression': {
                        'Evaluate': {
                            'Attribute': 'SENDER_IP'
                        },
                        'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES',
                        'Values': [
                            'string',
                        ]
                    },
                    'Ipv6Expression': {
                        'Evaluate': {
                            'Attribute': 'SENDER_IPV6'
                        },
                        'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES',
                        'Values': [
                            'string',
                        ]
                    },
                    'StringExpression': {
                        'Evaluate': {
                            'Analysis': {
                                'Analyzer': 'string',
                                'ResultField': 'string'
                            },
                            'Attribute': 'RECIPIENT'
                        },
                        'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS',
                        'Values': [
                            'string',
                        ]
                    },
                    'TlsExpression': {
                        'Evaluate': {
                            'Attribute': 'TLS_PROTOCOL'
                        },
                        'Operator': 'MINIMUM_TLS_VERSION'|'IS',
                        'Value': 'TLS1_2'|'TLS1_3'
                    }
                },
            ]
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TrafficPolicyName='string'
)
type ClientToken:

string

param ClientToken:

A unique token that Amazon SES uses to recognize subsequent retries of the same request.

This field is autopopulated if not provided.

type DefaultAction:

string

param DefaultAction:

[REQUIRED]

Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

type MaxMessageSizeBytes:

integer

param MaxMessageSizeBytes:

The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

type PolicyStatements:

list

param PolicyStatements:

[REQUIRED]

Conditional statements for filtering email traffic.

  • (dict) --

    The structure containing traffic policy conditions and actions.

    • Action (string) -- [REQUIRED]

      The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.

    • Conditions (list) -- [REQUIRED]

      The list of conditions to apply to incoming messages for filtering email traffic.

      • (dict) --

        The email traffic filtering conditions which are contained in a traffic policy resource.

        • BooleanExpression (dict) --

          This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The operand on which to perform a boolean condition operation.

            • Analysis (dict) --

              The structure type for a boolean condition stating the Add On ARN and its returned value.

              • Analyzer (string) -- [REQUIRED]

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField (string) -- [REQUIRED]

                The returned value from an Add On.

            • IsInAddressList (dict) --

              The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.

              • AddressLists (list) -- [REQUIRED]

                The address lists that will be used for evaluation.

                • (string) --

              • Attribute (string) -- [REQUIRED]

                The email attribute that needs to be evaluated against the address list.

          • Operator (string) -- [REQUIRED]

            The matching operator for a boolean condition expression.

        • IpExpression (dict) --

          This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of an IP condition expression.

            • Attribute (string) --

              An enum type representing the allowed attribute types for an IP condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for an IP condition expression.

          • Values (list) -- [REQUIRED]

            The right hand side argument of an IP condition expression.

            • (string) --

        • Ipv6Expression (dict) --

          This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of an IPv6 condition expression.

            • Attribute (string) --

              An enum type representing the allowed attribute types for an IPv6 condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for an IPv6 condition expression.

          • Values (list) -- [REQUIRED]

            The right hand side argument of an IPv6 condition expression.

            • (string) --

        • StringExpression (dict) --

          This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of a string condition expression.

            • Analysis (dict) --

              The structure type for a string condition stating the Add On ARN and its returned value.

              • Analyzer (string) -- [REQUIRED]

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField (string) -- [REQUIRED]

                The returned value from an Add On.

            • Attribute (string) --

              The enum type representing the allowed attribute types for a string condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for a string condition expression.

          • Values (list) -- [REQUIRED]

            The right hand side argument of a string condition expression.

            • (string) --

        • TlsExpression (dict) --

          This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of a TLS condition expression.

            • Attribute (string) --

              The enum type representing the allowed attribute types for the TLS condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for a TLS condition expression.

          • Value (string) -- [REQUIRED]

            The right hand side argument of a TLS condition expression.

type Tags:

list

param Tags:

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

  • (dict) --

    A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.

    • Key (string) -- [REQUIRED]

      The key of the key-value tag.

    • Value (string) -- [REQUIRED]

      The value of the key-value tag.

type TrafficPolicyName:

string

param TrafficPolicyName:

[REQUIRED]

A user-friendly name for the traffic policy resource.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyId': 'string'
}

Response Structure

  • (dict) --

    • TrafficPolicyId (string) --

      The identifier of the traffic policy resource.

GetIngressPoint (updated) Link ¶
Changes (response)
{'NetworkConfiguration': {'PrivateNetworkConfiguration': {'VpcEndpointId': 'string'},
                          'PublicNetworkConfiguration': {'IpType': 'IPV4 | '
                                                                   'DUAL_STACK'}}}

Fetch ingress endpoint resource attributes.

See also: AWS API Documentation

Request Syntax

client.get_ingress_point(
    IngressPointId='string'
)
type IngressPointId:

string

param IngressPointId:

[REQUIRED]

The identifier of an ingress endpoint.

rtype:

dict

returns:

Response Syntax

{
    'ARecord': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'IngressPointArn': 'string',
    'IngressPointAuthConfiguration': {
        'IngressPointPasswordConfiguration': {
            'PreviousSmtpPasswordExpiryTimestamp': datetime(2015, 1, 1),
            'PreviousSmtpPasswordVersion': 'string',
            'SmtpPasswordVersion': 'string'
        },
        'SecretArn': 'string'
    },
    'IngressPointId': 'string',
    'IngressPointName': 'string',
    'LastUpdatedTimestamp': datetime(2015, 1, 1),
    'NetworkConfiguration': {
        'PrivateNetworkConfiguration': {
            'VpcEndpointId': 'string'
        },
        'PublicNetworkConfiguration': {
            'IpType': 'IPV4'|'DUAL_STACK'
        }
    },
    'RuleSetId': 'string',
    'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED',
    'TrafficPolicyId': 'string',
    'Type': 'OPEN'|'AUTH'
}

Response Structure

  • (dict) --

    • ARecord (string) --

      The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

    • CreatedTimestamp (datetime) --

      The timestamp of when the ingress endpoint was created.

    • IngressPointArn (string) --

      The Amazon Resource Name (ARN) of the ingress endpoint resource.

    • IngressPointAuthConfiguration (dict) --

      The authentication configuration of the ingress endpoint resource.

      • IngressPointPasswordConfiguration (dict) --

        The ingress endpoint password configuration for the ingress endpoint resource.

        • PreviousSmtpPasswordExpiryTimestamp (datetime) --

          The previous password expiry timestamp of the ingress endpoint resource.

        • PreviousSmtpPasswordVersion (string) --

          The previous password version of the ingress endpoint resource.

        • SmtpPasswordVersion (string) --

          The current password expiry timestamp of the ingress endpoint resource.

      • SecretArn (string) --

        The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.

    • IngressPointId (string) --

      The identifier of an ingress endpoint resource.

    • IngressPointName (string) --

      A user friendly name for the ingress endpoint.

    • LastUpdatedTimestamp (datetime) --

      The timestamp of when the ingress endpoint was last updated.

    • NetworkConfiguration (dict) --

      The network configuration for the ingress point.

      • PrivateNetworkConfiguration (dict) --

        Specifies the network configuration for the private ingress point.

        • VpcEndpointId (string) --

          The identifier of the VPC endpoint to associate with this private ingress point.

      • PublicNetworkConfiguration (dict) --

        Specifies the network configuration for the public ingress point.

        • IpType (string) --

          The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.

    • RuleSetId (string) --

      The identifier of a rule set resource associated with the ingress endpoint.

    • Status (string) --

      The status of the ingress endpoint resource.

    • TrafficPolicyId (string) --

      The identifier of the traffic policy resource associated with the ingress endpoint.

    • Type (string) --

      The type of ingress endpoint.

GetTrafficPolicy (updated) Link ¶
Changes (response)
{'PolicyStatements': {'Conditions': {'Ipv6Expression': {'Evaluate': {'Attribute': 'SENDER_IPV6'},
                                                        'Operator': 'CIDR_MATCHES '
                                                                    '| '
                                                                    'NOT_CIDR_MATCHES',
                                                        'Values': ['string']}}}}

Fetch attributes of a traffic policy resource.

See also: AWS API Documentation

Request Syntax

client.get_traffic_policy(
    TrafficPolicyId='string'
)
type TrafficPolicyId:

string

param TrafficPolicyId:

[REQUIRED]

The identifier of the traffic policy resource.

rtype:

dict

returns:

Response Syntax

{
    'CreatedTimestamp': datetime(2015, 1, 1),
    'DefaultAction': 'ALLOW'|'DENY',
    'LastUpdatedTimestamp': datetime(2015, 1, 1),
    'MaxMessageSizeBytes': 123,
    'PolicyStatements': [
        {
            'Action': 'ALLOW'|'DENY',
            'Conditions': [
                {
                    'BooleanExpression': {
                        'Evaluate': {
                            'Analysis': {
                                'Analyzer': 'string',
                                'ResultField': 'string'
                            },
                            'IsInAddressList': {
                                'AddressLists': [
                                    'string',
                                ],
                                'Attribute': 'RECIPIENT'
                            }
                        },
                        'Operator': 'IS_TRUE'|'IS_FALSE'
                    },
                    'IpExpression': {
                        'Evaluate': {
                            'Attribute': 'SENDER_IP'
                        },
                        'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES',
                        'Values': [
                            'string',
                        ]
                    },
                    'Ipv6Expression': {
                        'Evaluate': {
                            'Attribute': 'SENDER_IPV6'
                        },
                        'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES',
                        'Values': [
                            'string',
                        ]
                    },
                    'StringExpression': {
                        'Evaluate': {
                            'Analysis': {
                                'Analyzer': 'string',
                                'ResultField': 'string'
                            },
                            'Attribute': 'RECIPIENT'
                        },
                        'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS',
                        'Values': [
                            'string',
                        ]
                    },
                    'TlsExpression': {
                        'Evaluate': {
                            'Attribute': 'TLS_PROTOCOL'
                        },
                        'Operator': 'MINIMUM_TLS_VERSION'|'IS',
                        'Value': 'TLS1_2'|'TLS1_3'
                    }
                },
            ]
        },
    ],
    'TrafficPolicyArn': 'string',
    'TrafficPolicyId': 'string',
    'TrafficPolicyName': 'string'
}

Response Structure

  • (dict) --

    • CreatedTimestamp (datetime) --

      The timestamp of when the traffic policy was created.

    • DefaultAction (string) --

      The default action of the traffic policy.

    • LastUpdatedTimestamp (datetime) --

      The timestamp of when the traffic policy was last updated.

    • MaxMessageSizeBytes (integer) --

      The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

    • PolicyStatements (list) --

      The list of conditions which are in the traffic policy resource.

      • (dict) --

        The structure containing traffic policy conditions and actions.

        • Action (string) --

          The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.

        • Conditions (list) --

          The list of conditions to apply to incoming messages for filtering email traffic.

          • (dict) --

            The email traffic filtering conditions which are contained in a traffic policy resource.

            • BooleanExpression (dict) --

              This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

              • Evaluate (dict) --

                The operand on which to perform a boolean condition operation.

                • Analysis (dict) --

                  The structure type for a boolean condition stating the Add On ARN and its returned value.

                  • Analyzer (string) --

                    The Amazon Resource Name (ARN) of an Add On.

                  • ResultField (string) --

                    The returned value from an Add On.

                • IsInAddressList (dict) --

                  The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.

                  • AddressLists (list) --

                    The address lists that will be used for evaluation.

                    • (string) --

                  • Attribute (string) --

                    The email attribute that needs to be evaluated against the address list.

              • Operator (string) --

                The matching operator for a boolean condition expression.

            • IpExpression (dict) --

              This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

              • Evaluate (dict) --

                The left hand side argument of an IP condition expression.

                • Attribute (string) --

                  An enum type representing the allowed attribute types for an IP condition.

              • Operator (string) --

                The matching operator for an IP condition expression.

              • Values (list) --

                The right hand side argument of an IP condition expression.

                • (string) --

            • Ipv6Expression (dict) --

              This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

              • Evaluate (dict) --

                The left hand side argument of an IPv6 condition expression.

                • Attribute (string) --

                  An enum type representing the allowed attribute types for an IPv6 condition.

              • Operator (string) --

                The matching operator for an IPv6 condition expression.

              • Values (list) --

                The right hand side argument of an IPv6 condition expression.

                • (string) --

            • StringExpression (dict) --

              This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

              • Evaluate (dict) --

                The left hand side argument of a string condition expression.

                • Analysis (dict) --

                  The structure type for a string condition stating the Add On ARN and its returned value.

                  • Analyzer (string) --

                    The Amazon Resource Name (ARN) of an Add On.

                  • ResultField (string) --

                    The returned value from an Add On.

                • Attribute (string) --

                  The enum type representing the allowed attribute types for a string condition.

              • Operator (string) --

                The matching operator for a string condition expression.

              • Values (list) --

                The right hand side argument of a string condition expression.

                • (string) --

            • TlsExpression (dict) --

              This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

              • Evaluate (dict) --

                The left hand side argument of a TLS condition expression.

                • Attribute (string) --

                  The enum type representing the allowed attribute types for the TLS condition.

              • Operator (string) --

                The matching operator for a TLS condition expression.

              • Value (string) --

                The right hand side argument of a TLS condition expression.

    • TrafficPolicyArn (string) --

      The Amazon Resource Name (ARN) of the traffic policy resource.

    • TrafficPolicyId (string) --

      The identifier of the traffic policy resource.

    • TrafficPolicyName (string) --

      A user-friendly name for the traffic policy resource.

UpdateTrafficPolicy (updated) Link ¶
Changes (request)
{'PolicyStatements': {'Conditions': {'Ipv6Expression': {'Evaluate': {'Attribute': 'SENDER_IPV6'},
                                                        'Operator': 'CIDR_MATCHES '
                                                                    '| '
                                                                    'NOT_CIDR_MATCHES',
                                                        'Values': ['string']}}}}

Update attributes of an already provisioned traffic policy resource.

See also: AWS API Documentation

Request Syntax

client.update_traffic_policy(
    DefaultAction='ALLOW'|'DENY',
    MaxMessageSizeBytes=123,
    PolicyStatements=[
        {
            'Action': 'ALLOW'|'DENY',
            'Conditions': [
                {
                    'BooleanExpression': {
                        'Evaluate': {
                            'Analysis': {
                                'Analyzer': 'string',
                                'ResultField': 'string'
                            },
                            'IsInAddressList': {
                                'AddressLists': [
                                    'string',
                                ],
                                'Attribute': 'RECIPIENT'
                            }
                        },
                        'Operator': 'IS_TRUE'|'IS_FALSE'
                    },
                    'IpExpression': {
                        'Evaluate': {
                            'Attribute': 'SENDER_IP'
                        },
                        'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES',
                        'Values': [
                            'string',
                        ]
                    },
                    'Ipv6Expression': {
                        'Evaluate': {
                            'Attribute': 'SENDER_IPV6'
                        },
                        'Operator': 'CIDR_MATCHES'|'NOT_CIDR_MATCHES',
                        'Values': [
                            'string',
                        ]
                    },
                    'StringExpression': {
                        'Evaluate': {
                            'Analysis': {
                                'Analyzer': 'string',
                                'ResultField': 'string'
                            },
                            'Attribute': 'RECIPIENT'
                        },
                        'Operator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS',
                        'Values': [
                            'string',
                        ]
                    },
                    'TlsExpression': {
                        'Evaluate': {
                            'Attribute': 'TLS_PROTOCOL'
                        },
                        'Operator': 'MINIMUM_TLS_VERSION'|'IS',
                        'Value': 'TLS1_2'|'TLS1_3'
                    }
                },
            ]
        },
    ],
    TrafficPolicyId='string',
    TrafficPolicyName='string'
)
type DefaultAction:

string

param 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

type MaxMessageSizeBytes:

integer

param MaxMessageSizeBytes:

The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

type PolicyStatements:

list

param PolicyStatements:

The list of conditions to be updated for filtering email traffic.

  • (dict) --

    The structure containing traffic policy conditions and actions.

    • Action (string) -- [REQUIRED]

      The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.

    • Conditions (list) -- [REQUIRED]

      The list of conditions to apply to incoming messages for filtering email traffic.

      • (dict) --

        The email traffic filtering conditions which are contained in a traffic policy resource.

        • BooleanExpression (dict) --

          This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The operand on which to perform a boolean condition operation.

            • Analysis (dict) --

              The structure type for a boolean condition stating the Add On ARN and its returned value.

              • Analyzer (string) -- [REQUIRED]

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField (string) -- [REQUIRED]

                The returned value from an Add On.

            • IsInAddressList (dict) --

              The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.

              • AddressLists (list) -- [REQUIRED]

                The address lists that will be used for evaluation.

                • (string) --

              • Attribute (string) -- [REQUIRED]

                The email attribute that needs to be evaluated against the address list.

          • Operator (string) -- [REQUIRED]

            The matching operator for a boolean condition expression.

        • IpExpression (dict) --

          This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of an IP condition expression.

            • Attribute (string) --

              An enum type representing the allowed attribute types for an IP condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for an IP condition expression.

          • Values (list) -- [REQUIRED]

            The right hand side argument of an IP condition expression.

            • (string) --

        • Ipv6Expression (dict) --

          This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of an IPv6 condition expression.

            • Attribute (string) --

              An enum type representing the allowed attribute types for an IPv6 condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for an IPv6 condition expression.

          • Values (list) -- [REQUIRED]

            The right hand side argument of an IPv6 condition expression.

            • (string) --

        • StringExpression (dict) --

          This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of a string condition expression.

            • Analysis (dict) --

              The structure type for a string condition stating the Add On ARN and its returned value.

              • Analyzer (string) -- [REQUIRED]

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField (string) -- [REQUIRED]

                The returned value from an Add On.

            • Attribute (string) --

              The enum type representing the allowed attribute types for a string condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for a string condition expression.

          • Values (list) -- [REQUIRED]

            The right hand side argument of a string condition expression.

            • (string) --

        • TlsExpression (dict) --

          This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

          • Evaluate (dict) -- [REQUIRED]

            The left hand side argument of a TLS condition expression.

            • Attribute (string) --

              The enum type representing the allowed attribute types for the TLS condition.

          • Operator (string) -- [REQUIRED]

            The matching operator for a TLS condition expression.

          • Value (string) -- [REQUIRED]

            The right hand side argument of a TLS condition expression.

type TrafficPolicyId:

string

param TrafficPolicyId:

[REQUIRED]

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

type TrafficPolicyName:

string

param TrafficPolicyName:

A user-friendly name for the traffic policy resource.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --