Returns a list of all email archives in your account.
Parameters:
-
next_token
(Optional[PaginationToken], default:
None
)
–
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.
-
page_size
(Optional[PageSize], default:
None
)
–
The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
Raises:
-
AccessDeniedException
–
Occurs when a user is denied access to a specific resource or action.
-
ThrottlingException
–
Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
-
ValidationException
–
The request validation has failed. For details, see the accompanying error message.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
| def list_archives(
self,
*,
config_overrides: Optional[MailManagerClientConfig] = None,
next_token: Optional[
"capo_mailmanager.types.pagination_token.PaginationToken"
] = None,
page_size: Optional["capo_mailmanager.types.page_size.PageSize"] = None,
) -> "capo_mailmanager.types.list_archives_response.ListArchivesResponse":
"""<p>Returns a list of all email archives in your account.</p>
Args:
next_token: <p>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. </p>
page_size: <p>The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives. </p>
Raises:
capo_mailmanager.errors.access_denied_exception.AccessDeniedException: <p>Occurs when a user is denied access to a specific resource or action.</p>
capo_mailmanager.errors.throttling_exception.ThrottlingException: <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_mailmanager.types.list_archives_request.ListArchivesRequest]",
) -> OperationResponse[
"capo_mailmanager.types.list_archives_response.ListArchivesResponse"
]:
import capo_mailmanager._operations.mail_manager_svc.list_archives
output, http_response = (
capo_mailmanager._operations.mail_manager_svc.list_archives.list_archives(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListArchives")
)
input_: capo_mailmanager.types.list_archives_request.ListArchivesRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if page_size is not None:
input_["page_size"] = page_size
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|