WorkMail.Paginator.
ListAliases
¶paginator = client.get_paginator('list_aliases')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from WorkMail.Client.list_aliases()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationId='string',
EntityId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier for the organization under which the entity exists.
[REQUIRED]
The identifier for the entity for which to list the aliases.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Aliases': [
'string',
],
}
Response Structure
(dict) --
Aliases (list) --
The entity's paginated aliases.