+
     IiuC  c                   s    ^ RI t ^ RIHt ^ RIHt ^ RIHt ^ RIHt ^ RI	H
t
HtHt ^ RIHt ^ RIHt ^ R	IHtHt R
 t ! R R4      t ! R R4      t ! R R4      tR# )i    N)
xform_name)OrderedDict)DocumentStructure)ResponseExampleDocumenter)document_custom_methoddocument_model_driven_methodget_instance_public_methods)ResponseParamsDocumenter)document_shared_examples)DocumentedShapeget_official_service_namec                 s    V R 8w  d   R# VR9   # )Zgenerate_presigned_urlN)s3 )method_nameservice_namekwargss   &&,9/usr/lib/python3.14/site-packages/botocore/docs/client.py!_allowlist_generate_presigned_urlr      s    ..6!!    c                   s   a  ] tR t^#t o ].tRR ltR tR tR t	R t
R tR tR	 tR
 tR tR tR tR tR tR tRtV tR# )ClientDocumenterNc                s    Wn         V P                   P                  P                  V n        W n        W0n        V P
                  f   / V n        V P                   P                  P                  P                  V n	        R # N)
_client	__class____name___client_class_name_root_docs_path_shared_examplesmetaservice_modelr   _service_name)selfclientroot_docs_pathshared_examples   &&&&r   __init__ZClientDocumenter.__init__(   s]    "&,,"8"8"A"A- /  ($&D!!\\..<<IIr   c                s    V P                  V4       V P                  V4       V P                  4       pV P                  W4       V P	                  V4       R# )zMDocuments a client and its methods

:param section: The section to write to.
N)
_add_title_add_class_signature_get_client_methods_add_client_intro_add_client_methods)r   sectionclient_methodss   && r   document_clientZ ClientDocumenter.document_client1   sH    
 	 !!'*113w7  0r   c                sN    \        V P                  4      pV P                  V4      # r   )r   r   _filter_client_methods)r   r*   s   & r   r&   Z$ClientDocumenter._get_client_methods<   s!    4T\\B**>::r   c                s    / pVP                  4        F1  w  r4V P                  VVV P                  R 7      pV'       g   K-  WBV&   K3  	  V# ))methodr   r   )Zitems_filter_client_methodr   )r   r*   Zfiltered_methodsr   r-   includes   &&    r   r,   Z'ClientDocumenter._filter_client_methods@   sY    #1#7#7#9K00'!// 1 G
 w06- $:  r   c                sL    V P                    F  pV! R/ VB pVf   K  Vu # 	  R# )NTr   )_CLIENT_METHODS_FILTERS)r   r   ZfilterZfilter_includes   &,  r   r.   Z&ClientDocumenter._filter_client_methodL   s0    22F#-f-N)%%	 3 r   c                <    VP                   P                  R 4       R# )ZClientNstyleZh2r   r)      &&r   r$   ZClientDocumenter._add_titleV   s    "r   c                s   VP                  R 4      p\        V P                  P                  P                  4      pVP                  RV 24       VP                  P                  4        VP                  V P                  P                  P                  P                  4       V P                  V4       VP                  P                  4        VP                  P                  4        VP                  R4       VP                  P                  4        \        V4       F-  pVP                  P!                  V P"                   RV 24       K/  	  R# )Zintroz A low-level client representing z These are the available methods:z/client/N)add_new_sectionr
   r   r   r   writer3   new_lineinclude_doc_stringdocumentation_add_client_creation_examplededentnew_paragraphwritelntoctreesortedtocitemr   )r   r)   r*   Zofficial_service_namer      &&&  r   r'   Z"ClientDocumenter._add_client_introY   s   ))'2 9LL++!
 	./D.EF	
 	 ""LL++99	

 	))'2 	##%:;!.1KMM!!T%7%7$8"NO 2r   c                sX    VP                   P                  V P                   R 2R7       R# )z.Client
class_nameN)r3   start_sphinx_py_classr   r4   r5   r   r%   Z%ClientDocumenter._add_class_signaturer   s*    ++112': 	, 	
r   c                s    VP                   P                  4        VP                   P                  4        VP                  R V P                   R24       VP                   P                  4        R# )z client = session.create_client('z')N)r3   start_codeblockr8   r7   r   end_codeblockr4   r5   r   r;   Z-ClientDocumenter._add_client_creation_examplew   sS    %%' /0B0B/C3G	
 	##%r   c                s    \        V4       Fn  p\        VR R7      pV P                  W2W,          4       \        P                  P                  V P                  V P                  R4      pVP                  WB4       Kp  	  R# )htmlZtargetr   N)	r@   r   _add_client_methodospathjoinr   r   write_to_file)r   r*   r   Zmethod_doc_structureZclient_dir_path   &&   r   r(   Z$ClientDocumenter._add_client_methods   sp    !.1K#4F$  ##$>3N
 !ggll$$d&8&8(O !..L 2r   c                s   VP                  R 4      pVP                  P                  V P                  RV P                   24       VP                  RV 24       VP                  V4       VP                  VRV P                   R2/R7      pV P                  V4      '       d   V P                  VVV4       R# V P                  WR4       R# )
breadcrumbz../../z / Client / 	qualifierz.Client.)contextN)
r6   r3   refr   r   r7   add_title_section_is_custom_method_add_custom_method_add_model_driven_method)r   r)   r   r-   breadcrumb_sectionZmethod_sections   &&&&  r   rJ   Z#ClientDocumenter._add_client_method   s    $44\B  $$##vd.@.@-A%B	
 	  <}!=>!!+. 00 T%<%<$=X"FG 1 
 !!+..## )).Fr   c                sF    WP                   P                  P                  9  # r   )r   r   method_to_api_mapping)r   r   r5   r   rU   Z"ClientDocumenter._is_custom_method   s    ,,"3"3"I"IIIr   c                s    \        WV4       R # r   )r   )r   r)   r   r-   r"   r   rV   Z#ClientDocumenter._add_custom_method   s    wV<r   c                s`   VP                  R 4      pVP                  P                  4        VP                  P                  R4       VP                  P                  4        VP                   F=  pV P
                   RVP                   2pVP                  P                  RV R24       K?  	  R# )
exceptionsZ
Exceptions.Client.exceptions.z:py:class:`Z`N)r6   r3   r8   bolderror_shapesr   nameZli)r   r)   operation_modelZerror_sectionZerrorrD      &&&   r   _add_method_exceptions_listZ,ClientDocumenter._add_method_exceptions_list   s    //=$$&  .$$&$11E**++>uzzlK  ""[A#>?	 2r   c           	     s   V P                   P                  P                  pV P                   P                  P                  V,          pVP	                  V4      pR V 2pVP
                  P                  RR4       V 2p\        VVVV P                   P                  P                  VP                  VR7       VP                  '       d   V P                  W4       V P                  P                  V4      pV'       d   \        WWh4       R# R# )zresponse = client.rQ   Z )event_emitterZmethod_descriptionexample_prefixN)r   r   r   rY   r_   rR   Zgetr   eventsr:   r]   ra   r   r   )	r   r)   r   r   operation_namer_   rc   Zfull_method_namer!   s	   &&&      r   rW   Z)ClientDocumenter._add_model_driven_method   s    ))77**@@M'77G-k];"";34[MB 	 	%,,++22.<<)	
 ''',,WF //33NC$. r   )r   r   r   r   r   r   )r   
__module____qualname____firstlineno__r   r0   r#   r+   r&   r,   r.   r$   r'   r%   r;   r(   rJ   rU   rV   ra   rW   __static_attributes____classdictcell__Z__classdict__   @r   r   r   #   sf     )J	1;
 #P2

&M G(J=	@ r   r   c                   s   a  ] tR t^t o Rt]! RRR]! R]! RRRR7      3R	]! R	RR
R7      3.4      R7      tR tR t	R t
R tR tR tR tR tR tR tR tR tR tR tRtV tR# )ClientExceptionsDocumenterzBhttps://docs.aws.amazon.com/boto3/latest/guide/error-handling.htmlZErrorZ	structurez1Normalized access to common exception attributes.ZCodeZstringz,An identifier specifying the exception type.)r^   	type_namer:   ZMessagez;A descriptive message explaining why the exception occured.)r^   rn   r:   Zmembersc                s    Wn         V P                   P                  P                  V n        V P                   P                  P
                  P                  V n        W n        R # r   )	r   r   r   r   r   r   r   r   r   )r   r   r       &&&r   r#   Z#ClientExceptionsDocumenter.__init__   sC    "&,,"8"8"A"A!\\..<<II-r   c                s    V P                  V4       V P                  V4       V P                  V4       V P                  4        R # r   )r$   _add_overview_add_exceptions_list_add_exception_classesr4   r5   r   document_exceptionsZ.ClientExceptionsDocumenter.document_exceptions   s6     7#!!'*##%r   c                r1   )zClient ExceptionsNr2   r4   r5   r   r$   Z%ClientExceptionsDocumenter._add_title  s    ,-r   c                    VP                   P                  4        VP                  R 4       VP                   P                  RV P                  R7       VP                  R4       VP                   P                  4        R# )zClient exceptions are available on a client instance via the ``exceptions`` property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling z
user guideZtitleZlink.N)r3   r8   r7   external_link_USER_GUIDE_LINKr4   r5   r   rp   Z(ClientExceptionsDocumenter._add_overview  sf     	
 	##&& 	$ 	
 	c r   c                s8    V P                    R VP                   2# )r[   )r   r^   )r   shaper5   r   _exception_class_nameZ0ClientExceptionsDocumenter._exception_class_name  s    ))**=ejj\JJr   c                s   V P                   P                  P                  P                  pV'       gH   VP                  P                  4        VP                  R 4       VP                  P                  4        R# VP                  P                  4        VP                  R4       VP                  P                  4        V F7  pVP                  P                  V P                   RVP                   24       K9  	  R# )z-This client has no modeled exception classes.Nz$The available client exceptions are:z/client/exceptions/)r   r   r   r]   r3   r8   r7   r>   r?   rA   r   r^   )r   r)   r]   ry   s   &&  r   rq   Z/ClientExceptionsDocumenter._add_exceptions_list  s    ||((66CCMM""$MMIJMM""$ >?!EMM!!%%&&9%**F "r   c                sZ   V P                   P                  P                  P                   F|  p\	        VP
                  R R7      pV P                  W!4       \        P                  P                  V P                  V P                  RR4      pVP                  W1P
                  4       K~  	  R# )rH   rI   r   rZ   N)r   r   r   r]   r   r^   _add_exception_classrK   rL   rM   r   r   rN   )r   ry   Zexception_doc_structureZexception_dir_paths   &   r   rr   Z1ClientExceptionsDocumenter._add_exception_classes%  s    \\&&44AAE&7

6'# %%&=E "$$$""	" $11"JJ Br   c                s*   VP                  R 4      pVP                  P                  V P                  RV P                   24       VP                  RVP                   24       VP                  VP                  4       VP                  VP                  4      pV P                  V4      pVP                  P                  VR7       V P                  WB4       V P                  WB4       V P                  WB4       VP                  P                  4        R# )rP   z	../../../z / Client / exceptions / rC   N)r6   r3   rS   r   r   r7   r^   rT   rz   rE   _add_top_level_documentation_add_exception_catch_example_add_response_attrZend_sphinx_py_class)r   r)   ry   rX   Zclass_sectionrD   r`   r   r{   Z/ClientExceptionsDocumenter._add_exception_class8  s    $44\B  $$##y1C1C0D%E	
 	  #<UZZL!IJ!!%**-//

;//6
11Z1H))-?))-?5//1r   c                s    VP                   '       dR   VP                  P                  4        VP                  VP                   4       VP                  P                  4        R # R # r   )r:   r3   r8   r9   r   r)   ry   ro   r   r|   Z7ClientExceptionsDocumenter._add_top_level_documentationG  sG    MM""$&&u':':;MM""$ r   c                s   VP                   P                  4        VP                   P                  R 4       VP                   P                  4        VP                   P	                  4        VP                  R4       VP                   P                  4        VP                   P                  4        VP                  R4       VP                   P                  4        VP                   P                  4        VP                  RVP                   R24       VP                   P                  4        VP                   P                  4        VP                  R4       VP                   P                  4        VP                   P                  4        R# )ZExampleztry:z...zexcept client.exceptions.z as e:zprint(e.response)N)
r3   r8   r\   r=   rF   r7   Zindentr<   r^   rG   r   ro   r   r}   Z7ClientExceptionsDocumenter._add_exception_catch_exampleM  s    9%##%%%'f e 1%**VDE )*##%r   c                s    VP                  R 4      pVP                  P                  R 4       V P                  V4       V P	                  W24       V P                  W24       VP                  P                  4        R# )ZresponseN)r6   r3   Zstart_sphinx_py_attr_add_response_attr_description_add_response_example_add_response_paramsZend_sphinx_py_attr)r   r)   ry   Zresponse_sections   &&& r   r~   Z-ClientExceptionsDocumenter._add_response_attr_  sf    "22:>33J?++,<=""#3;!!"2:113r   c                s    VP                   P                  4        VP                  R 4       VP                   P                  4        R# )zThe parsed error response. All exceptions have a top level ``Error`` key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.N)r3   r8   r9   r4   r5   r   r   Z9ClientExceptionsDocumenter._add_response_attr_descriptiong  s7     ""*	
 	 r   c                sp   VP                  R 4      pVP                  P                  4        VP                  P                  R4       VP                  P	                  4        \        V P                  RV P                  P                  P                  R7      pVP                  VVV P                  .R7       R# )ZsyntaxZSyntaxNr   re   rb   r/   )r6   r3   r8   r\   r=   r   r   r   r   rd   Zdocument_example_GENERIC_ERROR_SHAPE)r   r)   ry   Zexample_section
documenterrB   r   r   Z0ClientExceptionsDocumenter._add_response_exampleq  s    !11(;&&(""8,++-.++,,++22


 	##../ 	$ 	
r   c                sp   VP                  R 4      pVP                  P                  4        VP                  P                  R 4       VP                  P	                  4        \        V P                  RV P                  P                  P                  R7      pVP                  VVV P                  .R7       R# )Z	StructureNr   r   )r6   r3   r8   r\   r=   r   r   r   r   rd   Zdocument_paramsr   )r   r)   ry   Zparams_sectionr   rB   r   r   Z/ClientExceptionsDocumenter._add_response_params  s     00=%%'!!+.**,-++,,++22


 	""../ 	# 	
r   )r   r   r   r   N)r   rf   rg   rh   rx   r	   r   r   r#   rs   r$   rp   rz   rq   rr   r{   r|   r}   r~   r   r   r   ri   rj   rk   rl   r   rm   rm      s     L  +J ##"*J		 #&"*'	

	>.&.!K&2%&$4!
 
 
r   rm   c                   sN   a  ] tR tRt o RtRRRR/tR tR tR tR t	R	 t
R
tV tR# )ClientContextParamsDocumenteri  zAhttps://docs.aws.amazon.com/boto3/latest/guide/configuration.htmlr   Z	s3controlc                s    Wn         W n        R # r   )r   _context_params)r   r   Zcontext_paramsro   r   r#   Z&ClientContextParamsDocumenter.__init__  s    )-r   c                sl    V P                  V4       V P                  V4       V P                  V4       R # r   )r$   rp   _add_context_params_listr4   r5   r   document_context_paramsZ5ClientContextParamsDocumenter.document_context_params  s*     7#%%g.r   c                r1   )zClient Context ParametersNr2   r4   r5   r   r$   Z(ClientContextParamsDocumenter._add_title  s    45r   c                rt   )zClient context parameters are configurable on a client instance via the ``client_context_params`` parameter in the ``Config`` object. For more detailed instructions and examples on the exact usage of context params see the zconfiguration guideru   rv   N)r3   r8   r7   rw   _CONFIG_GUIDE_LINKr4   r5   r   rp   Z+ClientContextParamsDocumenter._add_overview  sf     <	
 	##'(( 	$ 	
 	c r   c           	     sl   VP                   P                  4        R V P                   R 2pVP                  RV R24       V P                   Fd  pVP                   P                  4        R \        VP                  4       R 2pVP                  RV RVP                   RVP                   24       Kf  	  R# )z``zThe available z client context params are:z* z (z) - N)
r3   r8   r   r>   r   r    r^   r7   Ztyper:   )r   r)   ZsnZparamr^   rO   r   r   Z6ClientContextParamsDocumenter._add_context_params_list  s     $$$%R(.,GHI))EMM""$
5::./r2DMMBtfBuzzl$u7J7J6KLM *r   )r   r   N)Z
AccelerateZDisableMultiRegionAccessPointsZForcePathStyleUseArnRegion)r   )r   rf   rg   rh   r   ZOMITTED_CONTEXT_PARAMSr#   r   r$   rp   r   ri   rj   rk   rl   r   r   r     sG     K 
 	 
 	&./
6!N Nr   r   )rK   Zbotocorer    Zbotocore.compatr   Zbotocore.docs.bcdoc.restdocr   Zbotocore.docs.exampler   Zbotocore.docs.methodr   r   r   Zbotocore.docs.paramsr   Zbotocore.docs.sharedexampler   Zbotocore.docs.utilsr	   r
   r   r   rm   r   r   r   r   <module>r      sV    
  ' 9 ; 
 : @ J"l l^}
 }
@1N 1Nr   