+
i t ^ RI t ^ RIHt ^ RIHt ^ RIHt ^ RIHt ^ RI H
t
^ RI H t ! R R 4 t
R R
ltR# ) N)
xform_name) OrderedDict)DocumentStructure) document_model_driven_method)DocumentedShape)get_service_module_namec 8 a ] tR t^t o R tR tR tR tRtV t R# )WaiterDocumenterc Wn V P P P V n V P P P
P V n W n W0n R V n
R# )zRhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waitersN) _client __class____name___client_class_namemeta
service_model service_name
_service_name_service_waiter_model_root_docs_path_USER_GUIDE_LINK)selfclientservice_waiter_modelroot_docs_paths &&&&6/usr/lib/python3/dist-packages/botocore/docs/waiter.py__init__WaiterDocumenter.__init__ sW "&,,"8"8"A"A !\\ . . < < I I%9" -
E
c > VP P R4 V P V4 VP P 4 VP R4 VP P 4 V P P F pVP P V P RV 24 \ VRR7 pV P W24 \ P P V P V P R4 pVP! WB4 K R# )zWDocuments the various waiters for a service.
:param section: The section to write to.
WaiterszThe available waiters are:z/waiter/html)targetwaiterN)styleh2
_add_overviewnew_linewritelntoctreer waiter_namestocitemr r _add_single_waiterospathjoinr
write_to_file)r section waiter_namewaiter_doc_structurewaiter_dir_paths && r document_waiters!WaiterDocumenter.document_waiters# s
# 7#
45
55BBK MM ! !T%7%7$8
"N O#4F$
# #$8 F !ggll$$d&8&8( O
! . . L Cr c VP R 4 pVP P V P RV P 24 VP RV 24 VP
V4 VP V4 pVP P V P RV 2R7 VP P 4 VP P 4 VP R\ V4 R24 VP P 4 VP P 4 \ VVV P P P V P P P V P" R7 R# )
breadcrumbz../../z / Waiter / z.Waiter.)
class_namez waiter = client.get_waiter('z'))r1 r2
event_emitterr r N)add_new_sectionr$ refr r writeadd_title_sectionstart_sphinx_py_classstart_codeblockr' r
end_codeblockdocument_wait_methodr r eventsr r )r r1 r2 breadcrumb_sectionwaiter_sections &&& r r, #WaiterDocumenter._add_single_waiter; sN $ 4 4\ B $$ # #vd.@.@-A%B
< }!=>!!+. 00= 22 112(;-H 3
,,. %%' +J{,C+DC H
**, %%' "# ,,++22 ,,++99!%!;!;
r c VP P 4 VP R 4 VP P RV P R7 VP R4 VP P 4 R# )zWaiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters z
user guide)titlelink.N)r$ r' r=
external_linkr )r r1 s &&r r& WaiterDocumenter._add_overviewY sf
## && $
c
r )r r r r r r N)
r
__module__ __qualname____firstlineno__r r5 r, r& __static_attributes____classdictcell__)
__classdict__s @r r
r
s
M0
<
!
!r r
c VP V4 pVP VP 4 p\ 4 p\ RRRVP
R2R7 VR& \ RRRVP R2R7 VR& \ RR R
VR 7 .p R \ V4 R
\ VP 4 RVP
RVP R2 p
\ V RVVV
RV RVR7 R# )a Documents a the wait method of a waiter
:param section: The section to write to
:param waiter_name: The name of the waiter
:param event_emitter: The event emitter to use to emit events
:param service_model: The service model
:param service_waiter_model: The waiter model associated to the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
DelayintegerzDThe amount of time in seconds to wait between attempts. Default: z
)name type_name
documentation MaxAttemptsz7The maximum number of attempts to be made. Default: WaiterConfig structurezI
A dictionary that provides parameters to control waiting behavior.
)rV rW rX memberszPolls :py:meth:`z.Client.z` every zG seconds until a successful state is reached. An error is raised after z failed checks.waitz waiter.waitF)r: method_descriptionexample_prefix
include_inputdocument_outputinclude_signatureN)
get_waiteroperation_model operationr r delay max_attemptsr r r ) r1 r2 r: r r rb waiter_modelrd waiter_config_membersbotocore_waiter_paramswait_descriptions &&&&&& r rB rB i s& . (22;?L#33L4J4JKO 'M%4
""."4"4!5T
; &'" ,;
$112$
8 ,-( !( *
2=AB( l,, -
.h|7I7I6J K$112/ C !#+$, +
r )T)r- botocorer botocore.compatr botocore.docs.bcdoc.restdocr botocore.docs.methodr botocore.docs.utilsr botocore.utilsr r
rB r r rs s/
' 9 = / 2O! O!dKr