MailManager / Client / list_relays

list_relays#

MailManager.Client.list_relays(**kwargs)#

Lists all the existing relay resources.

See also: AWS API Documentation

Request Syntax

response = client.list_relays(
    NextToken='string',
    PageSize=123
)
Parameters:

  • NextToken (string) – If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize (integer) – The number of relays to be returned in one request.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Relays': [
        {
            'LastModifiedTimestamp': datetime(2015, 1, 1),
            'RelayId': 'string',
            'RelayName': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    • Relays (list) –

      The list of returned relays.

      • (dict) –

        The relay resource that can be used as a rule to relay receiving emails to the destination relay server.

        • LastModifiedTimestamp (datetime) –

          The timestamp of when the relay was last modified.

        • RelayId (string) –

          The unique relay identifier.

        • RelayName (string) –

          The unique relay name.

Exceptions