"sphinx.addnodesdocument)}( rawsourcechildren]docutils.nodessection)}(hhh](h title)}(hAWS\_secrets moduleh]h TextAWS_secrets module}(parenth _documenthsourceNlineNuba attributes}(ids]classes]names]dupnames]backrefs]utagnamehhh hhh\C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\docs\AWSModules\AWS_secrets.rsthKubhindex)}(hhh]h}(h!]h#]h%]h']h)]entries](pairmodule; AWS_secretsmodule-AWS_secretshNtauh+h-hh hhhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](single$get_secret() (in module AWS_secrets)AWS_secrets.get_secrethNtauh+h-hh hhhNhNubhdesc)}(hhh](hdesc_signature)}(h$get_secret(secret_name, region_name)h](h desc_addname)}(h AWS_secrets.h]h AWS_secrets.}(hhZhhhNhNubah}(h!]h#]( sig-prename descclassnameeh%]h']h)] xml:spacepreserveuh+hXhhThhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_secrets.py:docstring of AWS_secrets.get_secrethKubh desc_name)}(h get_secreth]h get_secret}(hhohhhNhNubah}(h!]h#](sig-namedescnameeh%]h']h)]hjhkuh+hmhhThhhhlhKubhdesc_parameterlist)}(hsecret_name, region_nameh](hdesc_parameter)}(h secret_nameh]h desc_sig_name)}(h secret_nameh]h secret_name}(hhhhhNhNubah}(h!]h#]nah%]h']h)]uh+hhhubah}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(h region_nameh]h)}(h region_nameh]h region_name}(hhhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubah}(h!]h#]h%]h']h)]hjhkuh+hhhubeh}(h!]h#]h%]h']h)]hjhkuh+hhhThhhhlhKubeh}(h!]hKah#](sig sig-objecteh%]h']h)]module AWS_secretsclasshfullnamehq _toc_partshhq _toc_name get_secret()uh+hRhhlhKhhOhhubh desc_content)}(hhh](h paragraph)}(hAssuming the proper IAM permissions are set, a python script can utilize this function to grab the AWS managed secrets to access other services such as databases.h]hAssuming the proper IAM permissions are set, a python script can utilize this function to grab the AWS managed secrets to access other services such as databases.}(hhhhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_secrets.py:docstring of AWS_secrets.get_secrethKhhhhubh)}(h|This enables developers to create pipelines that utilize proper security protocols without hard coding security information.h]h|This enables developers to create pipelines that utilize proper security protocols without hard coding security information.}(hhhhhNhNubah}(h!]h#]h%]h']h)]uh+hhhhKhhhhubh field_list)}(hhh](h field)}(hhh](h field_name)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhhhhlhKubh field_body)}(hhh]h)}(hdicth]h pending_xref)}(h:py:class:`dict`h]h literal)}(hjh]hdict}(hjhhhNhNubah}(h!]h#](xrefpypy-classeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocAWSModules/AWS_secrets refdomainj*reftypeclass refexplicitrefwarn py:modulehɌpy:classN reftargetdictuh+jhhhK hjhhubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhhubeh}(h!]h#]h%]h']h)]uh+hhhubh)}(hhh](h)}(h Parametersh]h Parameters}(hjUhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjRhhlhKubj)}(hhh]h bullet_list)}(hhh](h list_item)}(hhh]h)}(h4secret_name (str) -- Name of the AWS Secret to grab.h](hliteral_strong)}(h secret_nameh]h secret_name}(hjvhhhNhNubah}(h!]h#]h%]h']h)]uh+jthjpubh (}(hjphhhNhNubj)}(hhh]hliteral_emphasis)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetj refspecificj<hj=Nuh+jhjpubh)}(hjphhhNhNubh – }(hjphhhNhNubhName of the AWS Secret to grab.}(hjphhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjmubah}(h!]h#]h%]h']h)]uh+jkhjhubjl)}(hhh]h)}(h6region_name (str) -- Region where this secret resides.h](ju)}(h region_nameh]h region_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jthjubh (}(hjhhhNhNubj)}(hhh]j)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetjjj<hj=Nuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubh!Region where this secret resides.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jkhjhubeh}(h!]h#]h%]h']h)]uh+jfhjcubah}(h!]h#]h%]h']h)]uh+jhjRubeh}(h!]h#]h%]h']h)]uh+hhhubh)}(hhh](h)}(hReturnsh]hReturns}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhhlhKubj)}(hhh]h)}(hHA dictionary of secret information, including the username and password.h]hHA dictionary of secret information, including the username and password.}(hj1hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj.ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhhubh)}(hhh](h)}(h Return typeh]h Return type}(hjNhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjKhhlhKubj)}(hhh]h)}(hdicth]j)}(hhh]hdict}(hjchhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetdictjj<hj=Nuh+jhj_ubah}(h!]h#]h%]h']h)]uh+hhj\ubah}(h!]h#]h%]h']h)]uh+jhjKubeh}(h!]h#]h%]h']h)]uh+hhhubeh}(h!]h#]h%]h']h)]uh+hhhhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhhOhhhhlhKubeh}(h!]h#](jfunctioneh%]h']h)]domainjobjtypejdesctypejnoindex noindexentrynocontentsentryuh+hMhhhh hNhNubeh}(h!](h<aws-secrets-moduleeh#]h%]aws_secrets moduleah']h)]uh+h hhhhhh,hKubah}(h!]h#]h%]h']h)]sourceh,uh+hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh, _destinationN _config_files]file_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}jjs nametypes}jsh!}(jh h