Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateIngressPoint

Provision a new ingress endpoint resource.

Request Syntax


{
   "ClientToken": "string",
   "IngressPointConfiguration": { ... },
   "IngressPointName": "string",
   "NetworkConfiguration": { ... },
   "RuleSetId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrafficPolicyId": "string",
   "Type": "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

IngressPointConfiguration

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

Type: IngressPointConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

IngressPointName

A user friendly name for an ingress endpoint resource.

Type: String

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

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

Required: Yes

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.

Type: NetworkConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

RuleSetId

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

Type: String

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

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

TrafficPolicyId

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

Type: String

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

Required: Yes

Type

The type of the ingress endpoint to create.

Type: String

Valid Values: OPEN | AUTH

Required: Yes

Response Syntax


{
   "IngressPointId": "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.

IngressPointId

The unique identifier for a previously created ingress endpoint.

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