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)WaiterDocumenter c Xl U R R R U l U R R R
R U l X l X0l SU l
g )NzRhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters) _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 'lib/third_party/botocore/docs/waiter.py__init__WaiterDocumenter.__init__ sW "&,,"8"8"A"A !\\ . . < < I I%9" -
E
c 6 UR R S5 U R U5 UR R 5 UR S5 UR R 5 U R R H nUR R U R SU 35 [ USS9nU R X25 [ R R U R U R S5 nUR! XB5 M g)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 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 - 5 UR R 5 UR R 5 [ UUU R R R U R R R U R" S9 g )N
breadcrumbz../../z / Waiter / z.Waiter.)
class_namez waiter = client.get_waiter('%s'))r2 r3
event_emitterr r )add_new_sectionr% refr r writeadd_title_sectionstart_sphinx_py_classstart_codeblockr( r
end_codeblockdocument_wait_methodr
r eventsr r )r r2 r3 breadcrumb_sectionwaiter_sections r r- #WaiterDocumenter._add_single_waiter; sI $ 4 4\ B $$ # #vd.@.@-A%B
< }!=>!!+. 00= 22 112(;-H 3
,,. %%' 0:k3J J
**, %%' "# ,,++22 ,,++99!%!;!;
r c UR R 5 UR S5 UR R SU R S9 UR S5 UR R 5 g )NzWaiters 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.)r% r( r>
external_linkr )r r2 s r r' WaiterDocumenter._add_overviewY sf
## && $
c
r )r r
r r r r N) r
__module__ __qualname____firstlineno__r r6 r- r' __static_attributes__ r r r
r
s
M0
<
!r r
c UR U5 nUR UR 5 n[ 5 n[ SSSR UR 5 S9US' [ SSSR UR 5 S9US' [ SSS US
9/n S R [ U5 [ UR 5 UR UR 5 n
[ U S UUU
S
U SUS9 g)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.
DelayintegerzJThe amount of time in seconds to wait between attempts. Default: {}
)name type_name
documentation MaxAttemptsz=The maximum number of attempts to be made. Default: {}
WaiterConfig structurezIA dictionary that provides parameters to control waiting behavior.
)rV rW rX memberszPolls :py:meth:`{}.Client.{}` every {} seconds until a successful state is reached. An error is returned after {} failed checks.waitz waiter.waitF)r; method_descriptionexample_prefix
include_inputdocument_outputinclude_signatureN)
get_waiteroperation_model operationr r formatdelay max_attemptsr r r ) r2 r3 r; r r rb waiter_modelrd waiter_config_membersbotocore_waiter_paramswait_descriptions r rC rC i s
. (22;?L#33L4J4JKO 'M%4
((.|/A/A(B &'" ,;
$f\%>%> ? ,-( !( *
++16 #M 2 |-- . % % ,
!#+$, +
r )T)r. botocorer botocore.compatr botocore.docs.bcdoc.restdocr botocore.docs.methodr botocore.docs.utilsr botocore.utilsr r
rC rR r r rs s4
' 9 = / 2O! O!p
Or