MailManager / Client / get_relay

get_relay#

MailManager.Client.get_relay(**kwargs)#

Fetch the relay resource and it’s attributes.

See also: AWS API Documentation

Request Syntax

response = client.get_relay(
    RelayId='string'
)
Parameters:

RelayId (string) –

[REQUIRED]

A unique relay identifier.

Return type:

dict

Returns:

Response Syntax

{
    'Authentication': {
        'NoAuthentication': {},
        'SecretArn': 'string'
    },
    'CreatedTimestamp': datetime(2015, 1, 1),
    'LastModifiedTimestamp': datetime(2015, 1, 1),
    'RelayArn': 'string',
    'RelayId': 'string',
    'RelayName': 'string',
    'ServerName': 'string',
    'ServerPort': 123
}

Response Structure

  • (dict) –

    • Authentication (dict) –

      The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: NoAuthentication, SecretArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • 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.

    • CreatedTimestamp (datetime) –

      The timestamp of when the relay was created.

    • LastModifiedTimestamp (datetime) –

      The timestamp of when relay was last updated.

    • RelayArn (string) –

      The Amazon Resource Name (ARN) of the relay.

    • RelayId (string) –

      The unique relay identifier.

    • RelayName (string) –

      The unique name of the relay.

    • ServerName (string) –

      The destination relay server address.

    • ServerPort (integer) –

      The destination relay server port.

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.ResourceNotFoundException