MailManager / Client / list_archives
list_archives#
- MailManager.Client.list_archives(**kwargs)#
Returns a list of all email archives in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_archives( NextToken='string', PageSize=123 )
- Parameters:
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.
PageSize (integer) – The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
- Return type:
dict
- Returns:
Response Syntax
{ 'Archives': [ { 'ArchiveId': 'string', 'ArchiveName': 'string', 'ArchiveState': 'ACTIVE'|'PENDING_DELETION', 'LastUpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
The response containing a list of your email archives.
Archives (list) –
The list of archive details.
(dict) –
An archive resource for storing and retaining emails.
ArchiveId (string) –
The unique identifier of the archive.
ArchiveName (string) –
The unique name assigned to the archive.
ArchiveState (string) –
The current state of the archive:
ACTIVE
– The archive is ready and available for use.PENDING_DELETION
– The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
LastUpdatedTimestamp (datetime) –
The timestamp of when the archive was last updated.
NextToken (string) –
If present, use to retrieve the next page of results.
Exceptions
MailManager.Client.exceptions.ValidationException
MailManager.Client.exceptions.AccessDeniedException
MailManager.Client.exceptions.ThrottlingException