UpdateMailServerRequest¶

pydantic model openapi_client.models.update_mail_server_request.UpdateMailServerRequest¶

Partial update. Omitted keys are copied from the stored item; omitted Password is copied from SSM. Extra keys return IPV-1008. After fill, the same validation as create applies.

Fields:

account_email (str | None)
enabled (bool | None)
password (str | None)
port (float | int | None)
server_description (str | None)
server_name (str | None)
user_name (str | None)

field server_name: Optional[StrictStr] = None (alias 'ServerName')¶: Display name. Must be a string starting with a word character. Changing it to a name already in use returns IPV-1018.

field server_description: Optional[StrictStr] = None (alias 'ServerDescription')¶: Description. Must be a string; empty is allowed.

field port: Optional[Union[StrictFloat, StrictInt]] = None (alias 'Port')¶: SMTP port. Must be a number from 0 to 65535.

field enabled: Optional[StrictBool] = None (alias 'Enabled')¶: Whether to enable this server. True runs an SMTP test and disables other servers when the test succeeds.

field user_name: Optional[StrictStr] = None (alias 'UserName')¶: SMTP username. Letters, digits, underscore, hyphen, period, and @ only.

field password: Optional[StrictStr] = None (alias 'Password')¶: SMTP password. Stored in SSM, not DynamoDB. No whitespace. Omit to keep the current SSM value.

field account_email: Optional[StrictStr] = None (alias 'AccountEmail')¶: From-address for this server.

to_str()¶

Returns the string representation of the model using alias

Return type:: str

to_json()¶

Returns the JSON representation of the model using alias

Return type:: str

classmethod from_json(json_str)¶

Create an instance of UpdateMailServerRequest from a JSON string

Return type:: Optional[Self]

to_dict()¶

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:: Dict[str, Any]

classmethod from_dict(obj)¶

Create an instance of UpdateMailServerRequest from a dict

Return type:: Optional[Self]