MailManager / Client / create_relay

create_relay#

MailManager.Client.create_relay(**kwargs)#

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

See also: AWS API Documentation

Request Syntax

response = client.create_relay(
    Authentication={
        'NoAuthentication': {}
        ,
        'SecretArn': 'string'
    },
    ClientToken='string',
    RelayName='string',
    ServerName='string',
    ServerPort=123,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Authentication (dict) –

    [REQUIRED]

    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.

  • ClientToken (string) –

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    This field is autopopulated if not provided.

  • RelayName (string) –

    [REQUIRED]

    The unique name of the relay resource.

  • ServerName (string) –

    [REQUIRED]

    The destination relay server address.

  • ServerPort (integer) –

    [REQUIRED]

    The destination relay server port.

  • Tags (list) –

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

    • (dict) –

      A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.

      • Key (string) – [REQUIRED]

        The key of the key-value tag.

      • Value (string) – [REQUIRED]

        The value of the key-value tag.

Return type:

dict

Returns:

Response Syntax

{
    'RelayId': 'string'
}

Response Structure

  • (dict) –

    • RelayId (string) –

      A unique identifier of the created relay resource.

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.ServiceQuotaExceededException

  • MailManager.Client.exceptions.ConflictException