MailManager / Client / update_relay

update_relay#

MailManager.Client.update_relay(**kwargs)#

Updates the attributes of an existing relay resource.

See also: AWS API Documentation

Request Syntax

response = client.update_relay(
    Authentication={
        'NoAuthentication': {}
        ,
        'SecretArn': 'string'
    },
    RelayId='string',
    RelayName='string',
    ServerName='string',
    ServerPort=123
)
Parameters:

  • Authentication (dict) –

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: NoAuthentication, SecretArn.

    • NoAuthentication (dict) –

      Keep an empty structure if the relay destination server does not require SMTP credential authentication.

    • SecretArn (string) –

      The ARN of the secret created in secrets manager where the relay server’s SMTP credentials are stored.

  • RelayId (string) –

    [REQUIRED]

    The unique relay identifier.

  • RelayName (string) – The name of the relay resource.

  • ServerName (string) – The destination relay server address.

  • ServerPort (integer) – The destination relay server port.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.ConflictException

  • MailManager.Client.exceptions.ResourceNotFoundException