Amazon SES Ses Traffic Policy API

openapi: 3.1.0
info:
  title: Amazon Simple Email Service Traffic Policy API
  version: '2010-12-01'
  description: Generated from AWS's published Smithy model for Amazon Simple Email Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://mail-manager.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateTrafficPolicy:
    post:
      operationId: CreateTrafficPolicy
      summary: Create Traffic Policy
      description: Provision a new traffic policy resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateTrafficPolicyResponse'
              example:
                TrafficPolicyId: tp-13245
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/MailManagerConflictException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - MailManagerSvc.CreateTrafficPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateTrafficPolicyRequest'
            example:
              TrafficPolicyName: trafficPolicyName
              PolicyStatements:
              - Conditions:
                - IpExpression:
                    Evaluate:
                      Attribute: SENDER_IP
                    Operator: CIDR_MATCHES
                    Values:
                    - 0.0.0.0/12
                Action: ALLOW
              DefaultAction: DENY
      tags:
      - Traffic Policy
  /#GetTrafficPolicy:
    post:
      operationId: GetTrafficPolicy
      summary: Get Traffic Policy
      description: Fetch attributes of a traffic policy resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetTrafficPolicyResponse'
              example:
                TrafficPolicyName: trafficPolicyName
                TrafficPolicyId: tp-12345
                TrafficPolicyArn: arn:aws:ses:us-east-1:123456789012:mailmanager-traffic-policy/tp-12345
                PolicyStatements:
                - Conditions:
                  - StringExpression:
                      Evaluate:
                        Attribute: RECIPIENT
                      Operator: EQUALS
                      Values:
                      - example@amazon.com
                      - example@gmail.com
                  Action: ALLOW
                DefaultAction: DENY
                MaxMessageSizeBytes: 1000
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - MailManagerSvc.GetTrafficPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetTrafficPolicyRequest'
            example:
              TrafficPolicyId: tp-12345
      tags:
      - Traffic Policy
  /#UpdateTrafficPolicy:
    post:
      operationId: UpdateTrafficPolicy
      summary: Update Traffic Policy
      description: Update attributes of an already provisioned traffic policy resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateTrafficPolicyResponse'
              example: {}
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/MailManagerConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - MailManagerSvc.UpdateTrafficPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateTrafficPolicyRequest'
            example:
              TrafficPolicyId: tp-12345
              TrafficPolicyName: trafficPolicyNewName
      tags:
      - Traffic Policy
  /#DeleteTrafficPolicy:
    post:
      operationId: DeleteTrafficPolicy
      summary: Delete Traffic Policy
      description: Delete a traffic policy resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteTrafficPolicyResponse'
              example: {}
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/MailManagerConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - MailManagerSvc.DeleteTrafficPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteTrafficPolicyRequest'
            example:
              TrafficPolicyId: tp-12345
      tags:
      - Traffic Policy
  /#ListTrafficPolicies:
    post:
      operationId: ListTrafficPolicies
      summary: List Traffic Policies
      description: List traffic policy resources.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListTrafficPoliciesResponse'
              example:
                TrafficPolicies:
                - TrafficPolicyId: tp-12345
                  TrafficPolicyName: trafficPolicyName
                  DefaultAction: DENY
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - MailManagerSvc.ListTrafficPolicies
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListTrafficPoliciesRequest'
            example: {}
      tags:
      - Traffic Policy
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ses
  schemas:
    CreateTrafficPolicyRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: A unique token that Amazon SES uses to recognize subsequent retries of the same request.
        TrafficPolicyName:
          type: string
          description: A user-friendly name for the traffic policy resource.
        PolicyStatements:
          type: array
          items:
            $ref: '#/components/schemas/PolicyStatement'
          description: Conditional statements for filtering email traffic.
        DefaultAction:
          type: string
          enum:
          - ALLOW
          - DENY
          description: Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside
            of (or not addressed by) the conditions of your policy statements
        MaxMessageSizeBytes:
          type: integer
          description: The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger
            will be blocked.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/MailManagerTag'
          description: 'The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1",
            "key2":"value2"} }.'
      required:
      - TrafficPolicyName
      - PolicyStatements
      - DefaultAction
    CreateTrafficPolicyResponse:
      type: object
      properties:
        TrafficPolicyId:
          type: string
          description: The identifier of the traffic policy resource.
      required:
      - TrafficPolicyId
    DeleteTrafficPolicyRequest:
      type: object
      properties:
        TrafficPolicyId:
          type: string
          description: The identifier of the traffic policy that you want to delete.
      required:
      - TrafficPolicyId
    DeleteTrafficPolicyResponse:
      type: object
      properties: {}
    GetTrafficPolicyRequest:
      type: object
      properties:
        TrafficPolicyId:
          type: string
          description: The identifier of the traffic policy resource.
      required:
      - TrafficPolicyId
    GetTrafficPolicyResponse:
      type: object
      properties:
        TrafficPolicyName:
          type: string
          description: A user-friendly name for the traffic policy resource.
        TrafficPolicyId:
          type: string
          description: The identifier of the traffic policy resource.
        TrafficPolicyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the traffic policy resource.
        PolicyStatements:
          type: array
          items:
            $ref: '#/components/schemas/PolicyStatement'
          description: The list of conditions which are in the traffic policy resource.
        MaxMessageSizeBytes:
          type: integer
          description: The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger
            will be blocked.
        DefaultAction:
          type: string
          enum:
          - ALLOW
          - DENY
          description: The default action of the traffic policy.
        CreatedTimestamp:
          type: string
          description: The timestamp of when the traffic policy was created.
        LastUpdatedTimestamp:
          type: string
          description: The timestamp of when the traffic policy was last updated.
      required:
      - TrafficPolicyName
      - TrafficPolicyId
    IngressAnalysis:
      type: object
      properties:
        Analyzer:
          type: string
          description: The Amazon Resource Name (ARN) of an Add On.
        ResultField:
          type: string
          description: The returned value from an Add On.
      required:
      - Analyzer
      - ResultField
    IngressBooleanExpression:
      type: object
      properties:
        Evaluate:
          $ref: '#/components/schemas/IngressBooleanToEvaluate'
        Operator:
          type: string
          enum:
          - IS_TRUE
          - IS_FALSE
          description: The matching operator for a boolean condition expression.
      required:
      - Evaluate
      - Operator
    IngressBooleanToEvaluate:
      type: object
      properties:
        Analysis:
          $ref: '#/components/schemas/IngressAnalysis'
        IsInAddressList:
          $ref: '#/components/schemas/IngressIsInAddressList'
      description: Exactly one member is set.
    IngressIpToEvaluate:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - SENDER_IP
          description: An enum type representing the allowed attribute types for an IP condition.
      description: Exactly one member is set.
    IngressIpv4Expression:
      type: object
      properties:
        Evaluate:
          $ref: '#/components/schemas/IngressIpToEvaluate'
        Operator:
          type: string
          enum:
          - CIDR_MATCHES
          - NOT_CIDR_MATCHES
          description: The matching operator for an IP condition expression.
        Values:
          type: array
          items:
            type: string
          description: The right hand side argument of an IP condition expression.
      required:
      - Evaluate
      - Operator
      - Values
    IngressIpv6Expression:
      type: object
      properties:
        Evaluate:
          $ref: '#/components/schemas/IngressIpv6ToEvaluate'
        Operator:
          type: string
          enum:
          - CIDR_MATCHES
          - NOT_CIDR_MATCHES
          description: The matching operator for an IPv6 condition expression.
        Values:
          type: array
          items:
            type: string
          description: The right hand side argument of an IPv6 condition expression.
      required:
      - Evaluate
      - Operator
      - Values
    IngressIpv6ToEvaluate:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - SENDER_IPV6
          description: An enum type representing the allowed attribute types for an IPv6 condition.
      description: Exactly one member is set.
    IngressIsInAddressList:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - RECIPIENT
          description: The email attribute that needs to be evaluated against the address list.
        AddressLists:
          type: array
          items:
            type: string
          description: The address lists that will be used for evaluation.
      required:
      - Attribute
      - AddressLists
    IngressStringExpression:
      type: object
      properties:
        Evaluate:
          $ref: '#/components/schemas/IngressStringToEvaluate'
        Operator:
          type: string
          enum:
          - EQUALS
          - NOT_EQUALS
          - STARTS_WITH
          - ENDS_WITH
          - CONTAINS
          description: The matching operator for a string condition expression.
        Values:
          type: array
          items:
            type: string
          description: The right hand side argument of a string condition expression.
      required:
      - Evaluate
      - Operator
      - Values
    IngressStringToEvaluate:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - RECIPIENT
          description: The enum type representing the allowed attribute types for a string condition.
        Analysis:
          $ref: '#/components/schemas/IngressAnalysis'
      description: Exactly one member is set.
    IngressTlsProtocolExpression:
      type: object
      properties:
        Evaluate:
          $ref: '#/components/schemas/IngressTlsProtocolToEvaluate'
        Operator:
          type: string
          enum:
          - MINIMUM_TLS_VERSION
          - IS
          description: The matching operator for a TLS condition expression.
        Value:
          type: string
          enum:
          - TLS1_2
          - TLS1_3
          description: The right hand side argument of a TLS condition expression.
      required:
      - Evaluate
      - Operator
      - Value
    IngressTlsProtocolToEvaluate:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - TLS_PROTOCOL
          description: The enum type representing the allowed attribute types for the TLS condition.
      description: Exactly one member is set.
    ListTrafficPoliciesRequest:
      type: object
      properties:
        PageSize:
          type: integer
          description: The maximum number of traffic policy resources that are returned per call. You can use NextToken to
            obtain further traffic policies.
        NextToken:
          type: string
          description: 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.
    ListTrafficPoliciesResponse:
      type: object
      properties:
        TrafficPolicies:
          type: array
          items:
            $ref: '#/components/schemas/TrafficPolicy'
          description: The list of traffic policies.
        NextToken:
          type: string
          description: 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.
    MailManagerConflictException:
      type: object
      properties:
        Message:
          type: string
    MailManagerTag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the key-value tag.
        Value:
          type: string
          description: The value of the key-value tag.
      required:
      - Key
      - Value
    PolicyCondition:
      type: object
      properties:
        StringExpression:
          $ref: '#/components/schemas/IngressStringExpression'
        IpExpression:
          $ref: '#/components/schemas/IngressIpv4Expression'
        Ipv6Expression:
          $ref: '#/components/schemas/IngressIpv6Expression'
        TlsExpression:
          $ref: '#/components/schemas/IngressTlsProtocolExpression'
        BooleanExpression:
          $ref: '#/components/schemas/IngressBooleanExpression'
      description: Exactly one member is set.
    PolicyStatement:
      type: object
      properties:
        Conditions:
          type: array
          items:
            $ref: '#/components/schemas/PolicyCondition'
          description: The list of conditions to apply to incoming messages for filtering email traffic.
        Action:
          type: string
          enum:
          - ALLOW
          - DENY
          description: The action that informs a traffic policy resource to either allow or block the email if it matches
            a condition in the policy statement.
      required:
      - Conditions
      - Action
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    TrafficPolicy:
      type: object
      properties:
        TrafficPolicyName:
          type: string
          description: A user-friendly name of the traffic policy resource.
        TrafficPolicyId:
          type: string
          description: The identifier of the traffic policy resource.
        DefaultAction:
          type: string
          enum:
          - ALLOW
          - DENY
          description: 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
      required:
      - TrafficPolicyName
      - TrafficPolicyId
      - DefaultAction
    UpdateTrafficPolicyRequest:
      type: object
      properties:
        TrafficPolicyId:
          type: string
          description: The identifier of the traffic policy that you want to update.
        TrafficPolicyName:
          type: string
          description: A user-friendly name for the traffic policy resource.
        PolicyStatements:
          type: array
          items:
            $ref: '#/components/schemas/PolicyStatement'
          description: The list of conditions to be updated for filtering email traffic.
        DefaultAction:
          type: string
          enum:
          - ALLOW
          - DENY
          description: Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside
            of (or not addressed by) the conditions of your policy statements
        MaxMessageSizeBytes:
          type: integer
          description: The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger
            will be blocked.
      required:
      - TrafficPolicyId
    UpdateTrafficPolicyResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)