Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateTrafficPolicy

Provision a new traffic policy resource.

Request Syntax


{
   "ClientToken": "string",
   "DefaultAction": "string",
   "MaxMessageSizeBytes": number,
   "PolicyStatements": [ 
      { 
         "Action": "string",
         "Conditions": [ 
            { ... }
         ]
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrafficPolicyName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

DefaultAction

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

Type: String

Valid Values: ALLOW | DENY

Required: Yes

MaxMessageSizeBytes

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

PolicyStatements

Conditional statements for filtering email traffic.

Type: Array of PolicyStatement objects

Required: Yes

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

TrafficPolicyName

A user-friendly name for the traffic policy resource.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[A-Za-z0-9_\-]+$

Required: Yes

Response Syntax


{
   "TrafficPolicyId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TrafficPolicyId

The identifier of the traffic policy resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 400

ServiceQuotaExceededException

Occurs when an operation exceeds a predefined service quota or limit.

HTTP Status Code: 400

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400