UpdateRelay

Updates the attributes of an existing relay resource.

Request Syntax


{
   "Authentication": { ... },
   "RelayId": "string",
   "RelayName": "string",
   "ServerName": "string",
   "ServerPort": number
}

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

The request accepts the following data in JSON format.

Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

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

Required: No

The unique relay identifier.

Type: String

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

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

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

The destination relay server address.

Type: String

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

Pattern: ^[a-zA-Z0-9-\.]+$

Required: No

The destination relay server port.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No

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

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