<# t S SK r S SKJr S SKJr S SKJr S SKJr S SK J
r
S SK J r " S S 5 r
S S
jrg) N)
xform_name) OrderedDict)DocumentStructure) document_model_driven_method)DocumentedShape)get_service_module_namec , \ rS rSrS rS rS rS rSrg)PaginatorDocumenter c Xl U R R R U l U R R R
R U l X l X0l SU l
g )NzMhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html) _client __class____name___client_class_namemeta
service_model service_name
_service_name_service_paginator_model_root_docs_path_USER_GUIDE_LINK)selfclientservice_paginator_modelroot_docs_paths *lib/third_party/botocore/docs/paginator.py__init__ PaginatorDocumenter.__init__ sW "&,,"8"8"A"A !\\ . . < < I I(?% -
@
c L UR R S5 U R U5 UR R 5 UR S5 UR R 5 [
U R R 5 nU H nUR R U R SU 35 [ USS9nU R XC5 [ R R U R U R S5 nUR# XS5 M g)zXDocuments the various paginators for a service
param section: The section to write to.
Paginatorsz The available paginators are:z /paginator/html)target paginatorN)styleh2
_add_overviewnew_linewritelntoctreesortedr _paginator_configtocitemr r _add_paginatorospathjoinr
write_to_file)r sectionpaginator_namespaginator_namepaginator_doc_structurepaginator_dir_paths r document_paginators'PaginatorDocumenter.document_paginators# s
& 7#
78
) ) ; ;
.N MM ! !%%&k.1AB
'8 v' #
7 H "$ $$d&8&8+"
$ 1 1"
.r c UR S5 nUR R U R SU R 35 UR SU 35 UR
U5 UR U5 nUR R U R SU 3S9 UR R 5 UR R 5 UR S[ U5 S35 UR R 5 UR R 5 U R R U5 n[ UUU R R R" U R R R$ US9 g ) N
breadcrumbz../../z / Paginator / z .Paginator.)
class_namez"paginator = client.get_paginator('z'))r3 r5
event_emitterr paginator_config)add_new_sectionr% refr r writeadd_title_sectionstart_sphinx_py_classstart_codeblockr( r
end_codeblockr
get_paginatordocument_paginate_methodr
r eventsr )r r3 r5 breadcrumb_sectionpaginator_sectionr> s r r. "PaginatorDocumenter._add_paginatorE si $ 4 4\ B $$ # #vd.@.@-A%B
?>2B!CD!!.1 $ 3 3N C 55**+;~6FG 6
//1 ((* 0N1K0LB O
--/ ((* 88FF
!%) ,,++22 ,,++99 -
r c UR R 5 UR S5 UR R SU R S9 UR S5 UR R 5 g )NzPaginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators z
user guide)titlelink.)r% r( rA
external_linkr )r r3 s r r' !PaginatorDocumenter._add_overviewi sf
## && $
c
r )r r
r r r r N) r
__module__ __qualname____firstlineno__r r8 r. r' __static_attributes__ r r r
r
s
D"
H
!r r
c UR U5 n[ 5 n[ SSSS9US' UR SS5 ( a [ SSSS9US' [ S S
S S9US ' [ S S
SUS9/n[ SS
SS9/n / n
[ US [
5 ( a XS -
n
OU
R
US 5 UR SS5 ( a U
R
US 5 / n [ US [
5 ( a XS -
n OU R
US 5 SR [ U5 [ U5 5 n [ U SUUU SUU U
U US9 g)a Documents the paginate method of a paginator
:param section: The section to write to
:param paginator_name: The name of the paginator. It is snake cased.
:param event_emitter: The event emitter to use to emit events
:param service_model: The service model
:param paginator_config: The paginator config associated to a particular
paginator.
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
MaxItemsintegerzThe 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.
)name type_name
documentation limit_keyNPageSizez The size of each page.
StartingTokenstringzq
A token to specify where to start paginating. This is the NextToken from a previous response.
PaginationConfig structurezCA dictionary that provides parameters to control pagination.
)rZ r[ r\ members NextTokenz$A token to resume pagination.
input_token output_tokenzVCreates an iterator that will paginate through responses from :py:meth:`{}.Client.{}`.paginatez&response_iterator = paginator.paginate)r= method_descriptionexample_prefix
include_inputinclude_output
exclude_inputexclude_outputinclude_signature) operation_modelr r get
isinstancelistappendformatr r r )
r3 r5 r= r r> rn ro pagination_config_membersbotocore_pagination_params#botocore_pagination_response_paramsservice_pagination_params"service_pagination_response_paramspaginate_descriptions
r rG rG y s 2 $33NCO
!,
,;
%
- j) K..0? 81
!*- 2A
2 o. #!" .
" A
+' !# "=1488!m%DD!!(()9-)HI K..!(()9+)FG *,&">2D99*~.NN**11 ^ ,
((. #M 2J~4N)
!#/?0:/9+ r )T)r/ botocorer botocore.compatr botocore.docs.bcdoc.restdocr botocore.docs.methodr botocore.docs.utilsr botocore.utilsr r
rG rV r r r s4
' 9 = / 2_! _!P
zr