+
    iC                         ^ 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# )    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                     V R 8w  d   R# VR9   # )generate_presigned_urlN)s3 )method_nameservice_namekwargss   &&,6/usr/lib/python3/dist-packages/botocore/docs/client.py!_allowlist_generate_presigned_urlr      s    ..6!!    c                      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                    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_exampless   &&&&r   __init__ClientDocumenter.__init__(   s]    "&,,"8"8"A"A- /  ($&D!!\\..<<IIr   c                    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_client ClientDocumenter.document_client1   sH    
 	 !!'*113w7  0r   c                N    \        V P                  4      pV P                  V4      # r   )r	   r   _filter_client_methods)r%   r2   s   & r   r.   $ClientDocumenter._get_client_methods<   s!    4T\\B**>::r   c                    / pVP                  4        F1  w  r4V P                  VVV P                  R 7      pV'       g   K-  WBV&   K3  	  V# ))methodr   r   )items_filter_client_methodr$   )r%   r2   filtered_methodsr   r9   includes   &&    r   r6   'ClientDocumenter._filter_client_methods@   sY    #1#7#7#9K00'!// 1 G
 w06- $:  r   c                L    V P                    F  pV! R/ VB pVf   K  Vu # 	  R# )NTr   )_CLIENT_METHODS_FILTERS)r%   r   filterfilter_includes   &,  r   r;   &ClientDocumenter._filter_client_methodL   s0    22F#-f-N)%%	 3 r   c                <    VP                   P                  R 4       R# )ClientNstyleh2r%   r1   s   &&r   r,   ClientDocumenter._add_titleV   s    "r   c                   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# )introz A low-level client representing z These are the available methods:z/client/N)add_new_sectionr   r   r"   r#   writerG   new_lineinclude_doc_stringdocumentation_add_client_creation_examplededentnew_paragraphwritelntoctreesortedtocitemr$   )r%   r1   r2   official_service_namer   s   &&&  r   r/   "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                X    VP                   P                  V P                   R 2R7       R# )z.Client
class_nameN)rG   start_sphinx_py_classr   rI   s   &&r   r-   %ClientDocumenter._add_class_signaturer   s*    ++112': 	, 	
r   c                    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)rG   start_codeblockrO   rN   r$   end_codeblockrI   s   &&r   rR   -ClientDocumenter._add_client_creation_examplew   sS    %%' /0B0B/C3G	
 	##%r   c                    \        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targetr&   N)	rW   r   _add_client_methodospathjoinr    r$   write_to_file)r%   r2   r   method_doc_structureclient_dir_paths   &&   r   r0   $ClientDocumenter._add_client_methods   sp    !.1K#4F$  ##$>3N
 !ggll$$d&8&8(O !..L 2r   c                   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)
rM   rG   refr   r$   rN   add_title_section_is_custom_method_add_custom_method_add_model_driven_method)r%   r1   r   r9   breadcrumb_sectionmethod_sections   &&&&  r   rh   #ClientDocumenter._add_client_method   s    $44\B  $$##vd.@.@-A%B	
 	  <}!=>!!+. 00 T%<%<$=X"FG 1 
 !!+..## )).Fr   c                F    WP                   P                  P                  9  # r   )r   r"   method_to_api_mapping)r%   r   s   &&r   rv   "ClientDocumenter._is_custom_method   s    ,,"3"3"I"IIIr   c                    \        WV4       R # r   )r   )r%   r1   r   r9   s   &&&&r   rw   #ClientDocumenter._add_custom_method   s    wV<r   c                `   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# )
exceptions
Exceptions.Client.exceptions.z:py:class:``N)rM   rG   rO   bolderror_shapesr   nameli)r%   r1   operation_modelerror_sectionerrorr]   s   &&&   r   _add_method_exceptions_list,ClientDocumenter._add_method_exceptions_list   s    //=$$&  .$$&$11E**++>uzzlK  ""[A#>?	 2r   c           	        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.rr    )event_emittermethod_descriptionexample_prefixN)r   r"   r#   r}   r   rs   getr   eventsrQ   r   r   r!   r   )	r%   r1   r   r#   operation_namer   r   full_method_namer(   s	   &&&      r   rx   )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   r@   r)   r3   r.   r6   r;   r,   r/   r-   rR   r0   rh   rv   rw   r   rx   __static_attributes____classdictcell____classdict__s   @r   r   r   #   sf     )J	1;
 #P2

&M G(J=	@ r   r   c                      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# )ClientExceptionsDocumenterzQhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/error-handling.htmlError	structurez1Normalized access to common exception attributes.Codestringz,An identifier specifying the exception type.)r   	type_namerQ   Messagez;A descriptive message explaining why the exception occured.)r   r   rQ   membersc                    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'   s   &&&r   r)   #ClientExceptionsDocumenter.__init__   sC    "&,,"8"8"A"A!\\..<<II-r   c                    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_classesrI   s   &&r   document_exceptions.ClientExceptionsDocumenter.document_exceptions   s6     7#!!'*##%r   c                <    VP                   P                  R 4       R# )zClient ExceptionsNrF   rI   s   &&r   r,   %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titlelink.N)rG   rO   rN   external_link_USER_GUIDE_LINKrI   s   &&r   r   (ClientExceptionsDocumenter._add_overview  sf     	
 	##&& 	$ 	
 	c r   c                8    V P                    R VP                   2# )r   )r   r   )r%   shapes   &&r   _exception_class_name0ClientExceptionsDocumenter._exception_class_name  s    ))**=ejj\JJr   c                   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   rG   rO   rN   rU   rV   rX   r$   r   )r%   r1   r   r   s   &&  r   r   /ClientExceptionsDocumenter._add_exceptions_list  s    ||((66CCMM""$MMIJMM""$ >?!EMM!!%%&&9%**F "r   c                Z   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# )re   rf   r&   r   N)r   r"   r#   r   r   r   _add_exception_classri   rj   rk   r    r$   rl   )r%   r   exception_doc_structureexception_dir_paths   &   r   r   1ClientExceptionsDocumenter._add_exception_classes&  s    \\&&44AAE&7

6'# %%&=E "$$$""	" $11"JJ Br   c                *   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# )rq   z	../../../z / Client / exceptions / r\   N)rM   rG   rt   r   r$   rN   r   ru   r   r^   _add_top_level_documentation_add_exception_catch_example_add_response_attrend_sphinx_py_class)r%   r1   r   ry   class_sectionr]   s   &&&   r   r   /ClientExceptionsDocumenter._add_exception_class9  s    $44\B  $$##y1C1C0D%E	
 	  #<UZZL!IJ!!%**-//

;//6
11Z1H))-?))-?5//1r   c                    VP                   '       dR   VP                  P                  4        VP                  VP                   4       VP                  P                  4        R # R # r   )rQ   rG   rO   rP   r%   r1   r   s   &&&r   r   7ClientExceptionsDocumenter._add_top_level_documentationH  sG    MM""$&&u':':;MM""$ r   c                   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# )Exampleztry:z...zexcept client.exceptions.z as e:zprint(e.response)N)
rG   rO   r   rT   ra   rN   indentrS   r   rb   r   s   &&&r   r   7ClientExceptionsDocumenter._add_exception_catch_exampleN  s    9%##%%%'f e 1%**VDE )*##%r   c                    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# )responseN)rM   rG   start_sphinx_py_attr_add_response_attr_description_add_response_example_add_response_paramsend_sphinx_py_attr)r%   r1   r   response_sections   &&& r   r   -ClientExceptionsDocumenter._add_response_attr`  sf    "22:>33J?++,<=""#3;!!"2:113r   c                    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)rG   rO   rP   rI   s   &&r   r   9ClientExceptionsDocumenter._add_response_attr_descriptionh  s7     ""*	
 	 r   c                p   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# )syntaxSyntaxNr   r   r   r=   )rM   rG   rO   r   rT   r   r$   r   r"   r   document_example_GENERIC_ERROR_SHAPE)r%   r1   r   example_section
documenters   &&&  r   r   0ClientExceptionsDocumenter._add_response_exampler  s    !11(;&&(""8,++-.++,,++22


 	##../ 	$ 	
r   c                p   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# )	StructureNr   r   )rM   rG   rO   r   rT   r
   r$   r   r"   r   document_paramsr   )r%   r1   r   params_sectionr   s   &&&  r   r   /ClientExceptionsDocumenter._add_response_params  s     00=%%'!!+.**,-++,,++22


 	""../ 	# 	
r   )r   r   r    r$   N)r   r   r   r   r   r   r   r   r)   r   r,   r   r   r   r   r   r   r   r   r   r   r   r   r   r   s   @r   r   r      s     	@  +J ##"*J		 #&"*'	

	>.&.!K&2%&$4!
 
 
r   r   c                   N   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  zPhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.htmlr   	s3controlc                    Wn         W n        R # r   )r$   _context_params)r%   r   context_paramss   &&&r   r)   &ClientContextParamsDocumenter.__init__  s    )-r   c                l    V P                  V4       V P                  V4       V P                  V4       R # r   )r,   r   _add_context_params_listrI   s   &&r   document_context_params5ClientContextParamsDocumenter.document_context_params  s*     7#%%g.r   c                <    VP                   P                  R 4       R# )zClient Context ParametersNrF   rI   s   &&r   r,   (ClientContextParamsDocumenter._add_title  s    45r   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 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 guider   r   N)rG   rO   rN   r   _CONFIG_GUIDE_LINKrI   s   &&r   r   +ClientContextParamsDocumenter._add_overview  sf     <	
 	##'(( 	$ 	
 	c r   c           	     l   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)
rG   rO   r$   rU   r   r   r   rN   typerQ   )r%   r1   snparamr   s   &&   r   r   6ClientContextParamsDocumenter._add_context_params_list  s     $$$%R(.,GHI))EMM""$
5::./r2DMMBtfBuzzl$u7J7J6KLM *r   )r   r$   N)
AccelerateDisableMultiRegionAccessPointsForcePathStyleUseArnRegion)r  )r   r   r   r   r   OMITTED_CONTEXT_PARAMSr)   r   r,   r   r   r   r   r   s   @r   r   r     sI     	?  	 
 	&./
6!N Nr   r   )ri   botocorer   botocore.compatr   botocore.docs.bcdoc.restdocr   botocore.docs.exampler   botocore.docs.methodr   r   r	   botocore.docs.paramsr
   botocore.docs.sharedexampler   botocore.docs.utilsr   r   r   r   r   r   r   r   r   <module>r     sV    
  ' 9 ; 
 : @ J"l l^~
 ~
B2N 2Nr   