Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
Request Syntax
{
"Authentication": { ... },
"ClientToken": "string",
"RelayName": "string",
"ServerName": "string",
"ServerPort": number,
"Tags": [
{
"Key": "string",
"Value": "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.
- Authentication
-
Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
Type: RelayAuthentication object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- 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
- RelayName
-
The unique name of the relay resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-_]+$Required: Yes
- ServerName
-
The destination relay server address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-\.]+$Required: Yes
- ServerPort
-
The destination relay server port.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
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
Response Syntax
{
"RelayId": "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.
- RelayId
-
A unique identifier of the created relay resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-]+$
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
