UpdateRelay
Updates the attributes of an existing relay resource.
Request Syntax
{
"Authentication": { ... },
"RelayId": "string",
"RelayName": "string",
"ServerName": "string",
"ServerPort": number
}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: No
- RelayId
-
The unique relay identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-]+$Required: Yes
- RelayName
-
The name of the relay resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-_]+$Required: No
- ServerName
-
The destination relay server address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-\.]+$Required: No
- ServerPort
-
The destination relay server port.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ResourceNotFoundException
-
Occurs when a requested resource is not found.
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:
