sphinx.addnodesdocument)}( rawsourcechildren]docutils.nodessection)}(hhh](h title)}(hAWS\_S3 moduleh]h TextAWS_S3 module}(parenth _documenthsourceNlineNuba attributes}(ids]classes]names]dupnames]backrefs]utagnamehhh hhhWC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\docs\AWSModules\AWS_S3.rsthKubhindex)}(hhh]h}(h!]h#]h%]h']h)]entries](pairmodule; AWS_S3 module-AWS_S3hNtauh+h-hh hhhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](single$s3_object_exist() (in module AWS_S3)AWS_S3.s3_object_existhNtauh+h-hh hhhNhNubhdesc)}(hhh](hdesc_signature)}(h,s3_object_exist(object_name, s3_bucket_name)h](h desc_addname)}(hAWS_S3.h]hAWS_S3.}(hhZhhhNhNubah}(h!]h#]( sig-prename descclassnameeh%]h']h)] xml:spacepreserveuh+hXhhThhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.s3_object_existhKubh desc_name)}(hs3_object_existh]hs3_object_exist}(hhohhhNhNubah}(h!]h#](sig-namedescnameeh%]h']h)]hjhkuh+hmhhThhhhlhKubhdesc_parameterlist)}(hobject_name, s3_bucket_nameh](hdesc_parameter)}(h object_nameh]h desc_sig_name)}(h object_nameh]h object_name}(hhhhhNhNubah}(h!]h#]nah%]h']h)]uh+hhhubah}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hs3_bucket_nameh]h)}(hs3_bucket_nameh]hs3_bucket_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)]moduleAWS_S3classhfullnamehq _toc_partshhq _toc_names3_object_exist()uh+hRhhlhKhhOhhubh desc_content)}(hhh](h paragraph)}(h6Determine if an object exists in a specific s3 bucket.h]h6Determine if an object exists in a specific s3 bucket.}(hhhhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.s3_object_existhKhhhhubh field_list)}(hhh](h field)}(hhh](h field_name)}(h Return typeh]h Return type}(hhhhhNhNubah}(h!]h#]h%]h']h)]uh+hhhhhlhKubh field_body)}(hhh]h)}(hboolh]h pending_xref)}(h:py:class:`bool`h]h literal)}(hj h]hbool}(hjhhhNhNubah}(h!]h#](xrefpypy-classeh%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]refdocAWSModules/AWS_S3 refdomainjreftypeclass refexplicitrefwarn py:modulehɌpy:classN reftargetbooluh+j hhhKhjhhubah}(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}(hjGhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjDhhlhKubj)}(hhh]h bullet_list)}(hhh](h list_item)}(hhh]h)}(h'object_name (str) -- Can include s3 keyh](hliteral_strong)}(h object_nameh]h object_name}(hjhhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjbubh (}(hjbhhhNhNubj )}(hhh]hliteral_emphasis)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjzubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetj refspecificj.hj/Nuh+j hjbubh)}(hjbhhhNhNubh – }(hjbhhhNhNubhCan include s3 key}(hjbhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj_ubah}(h!]h#]h%]h']h)]uh+j]hjZubj^)}(hhh]h)}(hs3_bucket_name (str) -- h](jg)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetjjj.hj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjZubeh}(h!]h#]h%]h']h)]uh+jXhjUubah}(h!]h#]h%]h']h)]uh+jhjDubeh}(h!]h#]h%]h']h)]uh+hhhubh)}(hhh](h)}(hReturnsh]hReturns}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hhlhKubj)}(hhh]h)}(hTrue if it exists.h]hTrue if it exists.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+hhhubh)}(hhh](h)}(h Return typeh]h Return type}(hj<hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj9hhlhKubj)}(hhh]h)}(hboolh]j )}(hhh]hbool}(hjQhhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetbooljj.hj/Nuh+j hjMubah}(h!]h#]h%]h']h)]uh+hhjJubah}(h!]h#]h%]h']h)]uh+jhj9ubeh}(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 hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI$s3_all_contents() (in module AWS_S3)AWS_S3.s3_all_contentshNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h,s3_all_contents(folder_name, s3_bucket_name)h](hY)}(hAWS_S3.h]hAWS_S3.}(hjhhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.s3_all_contentshKubhn)}(hs3_all_contentsh]hs3_all_contents}(hjhhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjhhhjhKubh)}(hfolder_name, s3_bucket_nameh](h)}(h folder_nameh]h)}(h folder_nameh]h folder_name}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(hs3_bucket_nameh]h)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhjhhhjhKubeh}(h!]jah#](hheh%]h']h)]hȌAWS_S3hhhjhjjhΌs3_all_contents()uh+hRhjhKhjhhubh)}(hhh](h)}(h-Return a list of all objects in an s3 bucket.h]h-Return a list of all objects in an s3 bucket.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.s3_all_contentshKhjhhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]h)}(h list[str]h](j )}(h:py:class:`list`h]j)}(hj2h]hlist}(hj4hhhNhNubah}(h!]h#](jpypy-classeh%]h']h)]uh+jhj0ubah}(h!]h#]h%]h']h)]refdocj( refdomainj>reftypeclass refexplicitrefwarnj.jj/Nj0listuh+j hjhKhj,hhubh[}(hj,hhhNhNubj )}(h:py:class:`str`h]j)}(hjVh]hstr}(hjXhhhNhNubah}(h!]h#](jpypy-classeh%]h']h)]uh+jhjTubah}(h!]h#]h%]h']h)]refdocj( refdomainjbreftypeclass refexplicitrefwarnj.jj/Nj0struh+j hjhKhj,hhubh]}(hj,hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj)ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hifolder_name (str) -- Folder or s3 key name, can be '' if looking for objects in root s3 bucket directory.h](jg)}(h folder_nameh]h folder_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjjj.jj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubhXFolder or s3 key name, can be ‘’ if looking for objects in root s3 bucket directory.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hs3_bucket_name (str) -- h](jg)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetj jj.jj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubeh}(h!]h#]h%]h']h)]uh+jXhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(hReturnsh]hReturns}(hjKhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjHhjhKubj)}(hhh]h)}(h>A list of all objects in a specific s3_bucket_name/folder_nameh]h>A list of all objects in a specific s3_bucket_name/folder_name}(hj\hhhNhNubah}(h!]h#]h%]h']h)]uh+hhjYubah}(h!]h#]h%]h']h)]uh+jhjHubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Return typeh]h Return type}(hjyhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjvhjhKubj)}(hhh]h)}(h list[str]h](j )}(hhh]hlist}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetlistjj.jj/Nuh+j hjubh[}(hjhhhNhNubj )}(hhh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetstrjj.jj/Nuh+j hjubh]}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjvubeh}(h!]h#]h%]h']h)]uh+hhjubeh}(h!]h#]h%]h']h)]uh+hhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjhhhjhKubeh}(h!]h#](jfunctioneh%]h']h)]jjjjjjjjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI get_data_s3() (in module AWS_S3)AWS_S3.get_data_s3hNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h6get_data_s3(local_data_path, file_to_get, bucket_name)h](hY)}(hAWS_S3.h]hAWS_S3.}(hjhhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjhhh}C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.get_data_s3hKubhn)}(h get_data_s3h]h get_data_s3}(hjhhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjhhhjhKubh)}(h)local_data_path, file_to_get, bucket_nameh](h)}(hlocal_data_pathh]h)}(hlocal_data_pathh]hlocal_data_path}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(h file_to_geth]h)}(h file_to_geth]h file_to_get}(hj1hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj-ubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(h bucket_nameh]h)}(h bucket_nameh]h bucket_name}(hjIhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjEubah}(h!]h#]h%]h']h)]hjhkuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhjhhhjhKubeh}(h!]jah#](hheh%]h']h)]hȌAWS_S3hhhjhjijhΌ get_data_s3()uh+hRhjhKhjhhubh)}(hhh](h)}(h-Download an s3 object from the 'bucket_name'.h]h1Download an s3 object from the ‘bucket_name’.}(hjohhhNhNubah}(h!]h#]h%]h']h)]uh+hh}C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.get_data_s3hKhjlhhubh)}(hXFirst checks if object exists, if not a warning is thrown and the function returns none.h]hXFirst checks if object exists, if not a warning is thrown and the function returns none.}(hj~hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj}hKhjlhhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hjh]hNone}(hjhhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj( refdomainjreftypeobj refexplicitrefwarnj.jij/Nj0Noneuh+j hj}hKhjhhubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hSlocal_data_path (str) -- Location on the local file system to copy the object into.h](jg)}(hlocal_data_pathh]hlocal_data_path}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hj ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjjj.jij/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubh:Location on the local file system to copy the object into.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hnfile_to_get (str) -- The s3 object name to download, can include the s3 key if multiple folders in the bucket.h](jg)}(h file_to_geth]h file_to_get}(hjDhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj@ubh (}(hj@hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjYhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjVubah}(h!]h#]h%]h']h)] refdomainj! refexplicitreftypehʌ reftargetj[jj.jij/Nuh+j hj@ubh)}(hj@hhhNhNubh – }(hj@hhhNhNubhYThe s3 object name to download, can include the s3 key if multiple folders in the bucket.}(hj@hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj=ubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hbucket_name (str) -- h](jg)}(h bucket_nameh]h bucket_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainj! refexplicitreftypehʌ reftargetjjj.jij/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubeh}(h!]h#]h%]h']h)]uh+jXhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj! refexplicitreftypehʌ reftargetNonejj.jij/Nuh+j hjubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubeh}(h!]h#]h%]h']h)]uh+hhjlhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjhhhjhKubeh}(h!]h#](j!functioneh%]h']h)]jj!jj.jj.jjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI!send_data_s3() (in module AWS_S3)AWS_S3.send_data_s3hNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h;send_data_s3(local_data_path, remote_filename, bucket_name)h](hY)}(hAWS_S3.h]hAWS_S3.}(hjGhhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjChhh~C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.send_data_s3hKubhn)}(h send_data_s3h]h send_data_s3}(hjVhhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjChhhjUhKubh)}(h-local_data_path, remote_filename, bucket_nameh](h)}(hlocal_data_pathh]h)}(hlocal_data_pathh]hlocal_data_path}(hjlhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjhubah}(h!]h#]h%]h']h)]hjhkuh+hhjdubh)}(hremote_filenameh]h)}(hremote_filenameh]hremote_filename}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjdubh)}(h bucket_nameh]h)}(h bucket_nameh]h bucket_name}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjdubeh}(h!]h#]h%]h']h)]hjhkuh+hhjChhhjUhKubeh}(h!]j>ah#](hheh%]h']h)]hȌAWS_S3hhhjXhjjXhΌsend_data_s3()uh+hRhjUhKhj@hhubh)}(hhh](h)}(h8Simple pass through to boto3. Included for completeness.h]h8Simple pass through to boto3. Included for completeness.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hh~C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.send_data_s3hKhjhhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjUhKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hjh]hNone}(hjhhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj( refdomainjreftypeobj refexplicitrefwarnj.jj/Nj0Noneuh+j hjhKhjhhubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Parametersh]h Parameters}(hj!hhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjUhKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hKlocal_data_path (str) -- File include path to be uploaded to the s3 bucket.h](jg)}(hlocal_data_pathh]hlocal_data_path}(hj<hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj8ubh (}(hj8hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjQhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjNubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjSjj.jj/Nuh+j hj8ubh)}(hj8hhhNhNubh – }(hj8hhhNhNubh2File include path to be uploaded to the s3 bucket.}(hj8hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj5ubah}(h!]h#]h%]h']h)]uh+j]hj2ubj^)}(hhh]h)}(hFremote_filename (str) -- The name with key to upload to the s3 bucket.h](jg)}(hremote_filenameh]hremote_filename}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainjf refexplicitreftypehʌ reftargetjjj.jj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubh-The name with key to upload to the s3 bucket.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hj2ubj^)}(hhh]h)}(hbucket_name (str) -- h](jg)}(h bucket_nameh]h bucket_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainjf refexplicitreftypehʌ reftargetjjj.jj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hj2ubeh}(h!]h#]h%]h']h)]uh+jXhj/ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Return typeh]h Return type}(hj+ hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj( hjUhKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hj@ hhhNhNubah}(h!]h#]h%]h']h)] refdomainjf refexplicitreftypehʌ reftargetNonejj.jj/Nuh+j hj< ubah}(h!]h#]h%]h']h)]uh+hhj9 ubah}(h!]h#]h%]h']h)]uh+jhj( ubeh}(h!]h#]h%]h']h)]uh+hhjubeh}(h!]h#]h%]h']h)]uh+hhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj@hhhjUhKubeh}(h!]h#](jffunctioneh%]h']h)]jjfjjs jjs jjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI'stream_send_s3_csv() (in module AWS_S3)AWS_S3.stream_send_s3_csvhNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h4stream_send_s3_csv(df, remote_filename, bucket_name)h](hY)}(hAWS_S3.h]hAWS_S3.}(hj hhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhj hhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.stream_send_s3_csvhKubhn)}(hstream_send_s3_csvh]hstream_send_s3_csv}(hj hhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhj hhhj hKubh)}(h df, remote_filename, bucket_nameh](h)}(hdfh]h)}(hdfh]hdf}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hjhkuh+hhj ubh)}(hremote_filenameh]h)}(hremote_filenameh]hremote_filename}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hjhkuh+hhj ubh)}(h bucket_nameh]h)}(h bucket_nameh]h bucket_name}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hjhkuh+hhj ubeh}(h!]h#]h%]h']h)]hjhkuh+hhj hhhj hKubeh}(h!]j ah#](hheh%]h']h)]hȌAWS_S3hhhj hj j hΌstream_send_s3_csv()uh+hRhj hKhj hhubh)}(hhh](h)}(hADirectly upload a pandas dataframe to a csv file in an s3 bucket.h]hADirectly upload a pandas dataframe to a csv file in an s3 bucket.}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.stream_send_s3_csvhKhj hhubh)}(hmSimple pass through to awswrangler, very likely deprecate this function since it currently adds little value.h]hmSimple pass through to awswrangler, very likely deprecate this function since it currently adds little value.}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hKhj hhubh)}(hSee awswrangler for many more options: https://aws-sdk-pandas.readthedocs.io/en/stable/stubs/awswrangler.s3.to_csv.html#awswrangler.s3.to_csvh](h'See awswrangler for many more options: }(hj$ hhhNhNubh reference)}(hfhttps://aws-sdk-pandas.readthedocs.io/en/stable/stubs/awswrangler.s3.to_csv.html#awswrangler.s3.to_csvh]hfhttps://aws-sdk-pandas.readthedocs.io/en/stable/stubs/awswrangler.s3.to_csv.html#awswrangler.s3.to_csv}(hj. hhhNhNubah}(h!]h#]h%]h']h)]refurij0 uh+j, hj$ ubeh}(h!]h#]h%]h']h)]uh+hhj hKhj hhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjI hhhNhNubah}(h!]h#]h%]h']h)]uh+hhjF hj hKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hj` h]hNone}(hjb hhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhj^ ubah}(h!]h#]h%]h']h)]refdocj( refdomainjl reftypeobj refexplicitrefwarnj.j j/Nj0Noneuh+j hj hK hjZ hhubah}(h!]h#]h%]h']h)]uh+hhjW ubah}(h!]h#]h%]h']h)]uh+jhjF ubeh}(h!]h#]h%]h']h)]uh+hhjC ubh)}(hhh](h)}(h Parametersh]h Parameters}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hj hKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hdf (pandas.DataFrame) -- h](jg)}(hdfh]hdf}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj ubh (}(hj hhhNhNubj )}(hhh]j~)}(hpandas.DataFrameh]hpandas.DataFrame}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hj ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetj jj.j j/Nuh+j hj ubh)}(hj hhhNhNubh – }(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+j]hj ubj^)}(hhh]h)}(h+remote_filename (str) -- Can include s3 keyh](jg)}(hremote_filenameh]hremote_filename}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj ubh (}(hj hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hj ubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetj jj.j j/Nuh+j hj ubh)}(hj hhhNhNubh – }(hj hhhNhNubhCan include s3 key}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+j]hj ubj^)}(hhh]h)}(hbucket_name (str) -- h](jg)}(h bucket_nameh]h bucket_name}(hjC hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj? ubh (}(hj? hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjX hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjU ubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetjZ jj.j j/Nuh+j hj? ubh)}(hj? hhhNhNubh – }(hj? hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj< ubah}(h!]h#]h%]h']h)]uh+j]hj ubeh}(h!]h#]h%]h']h)]uh+jXhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+hhjC ubh)}(hhh](h)}(h Return typeh]h Return type}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hj hKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hj hhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetNonejj.j j/Nuh+j hj ubah}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+hhjC ubeh}(h!]h#]h%]h']h)]uh+hhj hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj hhhj hKubeh}(h!]h#](j functioneh%]h']h)]jj jj jj jjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI&stream_get_s3_csv() (in module AWS_S3)AWS_S3.stream_get_s3_csvhNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h/stream_get_s3_csv(remote_filename, bucket_name)h](hY)}(hAWS_S3.h]hAWS_S3.}(hj hhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhj hhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.stream_get_s3_csvhKubhn)}(hstream_get_s3_csvh]hstream_get_s3_csv}(hj hhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhj hhhj hKubh)}(hremote_filename, bucket_nameh](h)}(hremote_filenameh]h)}(hremote_filenameh]hremote_filename}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hjhkuh+hhj ubh)}(h bucket_nameh]h)}(h bucket_nameh]h bucket_name}(hj7 hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj3 ubah}(h!]h#]h%]h']h)]hjhkuh+hhj ubeh}(h!]h#]h%]h']h)]hjhkuh+hhj hhhj hKubeh}(h!]j ah#](hheh%]h']h)]hȌAWS_S3hhhj hjW j hΌstream_get_s3_csv()uh+hRhj hKhj hhubh)}(hhh](h)}(h5Directly download a csv file into a pandas dataframe.h]h5Directly download a csv file into a pandas dataframe.}(hj] hhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.stream_get_s3_csvhKhjZ hhubh)}(hmSimple pass through to awswrangler, very likely deprecate this function since it currently adds little value.h]hmSimple pass through to awswrangler, very likely deprecate this function since it currently adds little value.}(hjl hhhNhNubah}(h!]h#]h%]h']h)]uh+hhjk hKhjZ hhubh)}(htThis function does check if the s3 object exists first and will return a blank dataframe if the file does not exist.h]htThis function does check if the s3 object exists first and will return a blank dataframe if the file does not exist.}(hjz hhhNhNubah}(h!]h#]h%]h']h)]uh+hhjk hKhjZ hhubh)}(hSee awswrangler for many more options: https://aws-sdk-pandas.readthedocs.io/en/stable/stubs/awswrangler.s3.read_csv.html#awswrangler.s3.read_csvh](h'See awswrangler for many more options: }(hj hhhNhNubj- )}(hjhttps://aws-sdk-pandas.readthedocs.io/en/stable/stubs/awswrangler.s3.read_csv.html#awswrangler.s3.read_csvh]hjhttps://aws-sdk-pandas.readthedocs.io/en/stable/stubs/awswrangler.s3.read_csv.html#awswrangler.s3.read_csv}(hj hhhNhNubah}(h!]h#]h%]h']h)]refurij uh+j, hj ubeh}(h!]h#]h%]h']h)]uh+hhjk hK hjZ hhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hj hKubj)}(hhh]h)}(h DataFrameh]j )}(h(:py:class:`~pandas.core.frame.DataFrame`h]j)}(hj h]h DataFrame}(hj hhhNhNubah}(h!]h#](jpypy-classeh%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]refdocj( refdomainj reftypeclass refexplicitrefwarnj.jW j/Nj0pandas.core.frame.DataFrameuh+j hjk hK hj hhubah}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+hhj ubh)}(hhh](h)}(h Parametersh]h Parameters}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hj hKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(h5remote_filename (str) -- Remote file including s3 keyh](jg)}(hremote_filenameh]hremote_filename}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj ubh (}(hj hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hj% hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hj" ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetj' jj.jW j/Nuh+j hj ubh)}(hj hhhNhNubh – }(hj hhhNhNubhRemote file including s3 key}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+j]hj ubj^)}(hhh]h)}(hbucket_name (str) -- h](jg)}(h bucket_nameh]h bucket_name}(hj] hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjY ubh (}(hjY hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjr hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjo ubah}(h!]h#]h%]h']h)] refdomainj: refexplicitreftypehʌ reftargetjt jj.jW j/Nuh+j hjY ubh)}(hjY hhhNhNubh – }(hjY hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjV ubah}(h!]h#]h%]h']h)]uh+j]hj ubeh}(h!]h#]h%]h']h)]uh+jXhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+hhj ubh)}(hhh](h)}(h Return typeh]h Return type}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj hj hKubj)}(hhh]h)}(hpandas.DataFrameh]j )}(hhh]hpandas.DataFrame}(hj hhhNhNubah}(h!]h#]h%]h']h)] refdomainj: refexplicitreftypehʌ reftargetpandas.DataFramejj.jW j/Nuh+j hj ubah}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+hhj ubeh}(h!]h#]h%]h']h)]uh+hhjZ hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj hhhj hKubeh}(h!]h#](j: functioneh%]h']h)]jj: jj jj jjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI#delete_data_s3() (in module AWS_S3)AWS_S3.delete_data_s3hNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h,delete_data_s3(remote_filename, bucket_name)h](hY)}(hAWS_S3.h]hAWS_S3.}(hjhhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.delete_data_s3hKubhn)}(hdelete_data_s3h]hdelete_data_s3}(hj#hhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjhhhj"hKubh)}(hremote_filename, bucket_nameh](h)}(hremote_filenameh]h)}(hremote_filenameh]hremote_filename}(hj9hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj5ubah}(h!]h#]h%]h']h)]hjhkuh+hhj1ubh)}(h bucket_nameh]h)}(h bucket_nameh]h bucket_name}(hjQhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjMubah}(h!]h#]h%]h']h)]hjhkuh+hhj1ubeh}(h!]h#]h%]h']h)]hjhkuh+hhjhhhj"hKubeh}(h!]j ah#](hheh%]h']h)]hȌAWS_S3hhhj%hjqj%hΌdelete_data_s3()uh+hRhj"hKhj hhubh)}(hhh](h)}(h Delete an object from s3 bucket.h]h Delete an object from s3 bucket.}(hjwhhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.delete_data_s3hKhjthhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhj"hKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hjh]hNone}(hjhhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj( refdomainjreftypeobj refexplicitrefwarnj.jqj/Nj0Noneuh+j hjhKhjhhubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhj"hKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(h>remote_filename (str) -- Object to delete, can include s3 key.h](jg)}(hremote_filenameh]hremote_filename}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjjj.jqj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubh%Object to delete, can include s3 key.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hbucket_name (str) -- h](jg)}(h bucket_nameh]h bucket_name}(hj>hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj:ubh (}(hj:hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjShhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjPubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetjUjj.jqj/Nuh+j hj:ubh)}(hj:hhhNhNubh – }(hj:hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj7ubah}(h!]h#]h%]h']h)]uh+j]hjubeh}(h!]h#]h%]h']h)]uh+jXhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhj"hKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetNonejj.jqj/Nuh+j hjubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubeh}(h!]h#]h%]h']h)]uh+hhjthhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj hhhj"hKubeh}(h!]h#](jfunctioneh%]h']h)]jjjjjjjjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI&create_s3_buckets() (in module AWS_S3)AWS_S3.create_s3_bucketshNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h)create_s3_buckets(s3_bucket_name, region)h](hY)}(hAWS_S3.h]hAWS_S3.}(hjhhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.create_s3_bucketshKubhn)}(hcreate_s3_bucketsh]hcreate_s3_buckets}(hjhhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjhhhjhKubh)}(hs3_bucket_name, regionh](h)}(hs3_bucket_nameh]h)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(hregionh]h)}(hregionh]hregion}(hj2hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj.ubah}(h!]h#]h%]h']h)]hjhkuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhjhhhjhKubeh}(h!]jah#](hheh%]h']h)]hȌAWS_S3hhhjhjRjhΌcreate_s3_buckets()uh+hRhjhKhjhhubh)}(hhh](h)}(hCreate an s3 bucket using the SDK. All public access to this bucket will be shutoff. Note this function is expected to be replaced with CDK in the future.h]hCreate an s3 bucket using the SDK. All public access to this bucket will be shutoff. Note this function is expected to be replaced with CDK in the future.}(hjXhhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.create_s3_bucketshKhjUhhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjmhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjjhjhKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hjh]hNone}(hjhhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj( refdomainjreftypeobj refexplicitrefwarnj.jRj/Nj0Noneuh+j hjfhKhj~hhubah}(h!]h#]h%]h']h)]uh+hhj{ubah}(h!]h#]h%]h']h)]uh+jhjjubeh}(h!]h#]h%]h']h)]uh+hhjgubh)}(hhh](h)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hs3_bucket_name (str) -- h](jg)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjjj.jRj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(h;region (str) -- AWS region where the bucket will be createdh](jg)}(hregionh]hregion}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hj0hhhNhNubah}(h!]h#]h%]h']h)]uh+j}hj-ubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetj2jj.jRj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubh+AWS region where the bucket will be created}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubeh}(h!]h#]h%]h']h)]uh+jXhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjgubh)}(hhh](h)}(h Return typeh]h Return type}(hjuhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjrhjhKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetNonejj.jRj/Nuh+j hjubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjrubeh}(h!]h#]h%]h']h)]uh+hhjgubeh}(h!]h#]h%]h']h)]uh+hhjUhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjhhhjhKubeh}(h!]h#](jfunctioneh%]h']h)]jjjjjjjjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI+setup_s3_notifications() (in module AWS_S3)AWS_S3.setup_s3_notificationshNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(hSsetup_s3_notifications(s3_bucket_name, queue_attributes, notification_name, prefix)h](hY)}(hAWS_S3.h]hAWS_S3.}(hjhhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.setup_s3_notificationshKubhn)}(hsetup_s3_notificationsh]hsetup_s3_notifications}(hjhhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjhhhjhKubh)}(h;s3_bucket_name, queue_attributes, notification_name, prefixh](h)}(hs3_bucket_nameh]h)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(hqueue_attributesh]h)}(hqueue_attributesh]hqueue_attributes}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(hnotification_nameh]h)}(hnotification_nameh]hnotification_name}(hj+hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj'ubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(hprefixh]h)}(hprefixh]hprefix}(hjChhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj?ubah}(h!]h#]h%]h']h)]hjhkuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhjhhhjhKubeh}(h!]jah#](hheh%]h']h)]hȌAWS_S3hhhjhjcjhΌsetup_s3_notifications()uh+hRhjhKhjhhubh)}(hhh](h)}(hxSetup event notifications for an s3 bucket. This uses the AWS SDK and is expected to be replaced with CDK in the future.h]hxSetup event notifications for an s3 bucket. This uses the AWS SDK and is expected to be replaced with CDK in the future.}(hjihhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.setup_s3_notificationshKhjfhhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hj~hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj{hjhKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hjh]hNone}(hjhhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj( refdomainjreftypeobj refexplicitrefwarnj.jcj/Nj0Noneuh+j hjwhKhjhhubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhj{ubeh}(h!]h#]h%]h']h)]uh+hhjxubh)}(hhh](h)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hs3_bucket_name (str) -- h](jg)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjjj.jcj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hPqueue_attributes (str) -- The notifications will be sent to the SQS at this ARN.h](jg)}(hqueue_attributesh]hqueue_attributes}(hj,hhhNhNubah}(h!]h#]h%]h']h)]uh+jfhj(ubh (}(hj(hhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjAhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hj>ubah}(h!]h#]h%]h']h)] refdomainj  refexplicitreftypehʌ reftargetjCjj.jcj/Nuh+j hj(ubh)}(hj(hhhNhNubh – }(hj(hhhNhNubh6The notifications will be sent to the SQS at this ARN.}(hj(hhhNhNubeh}(h!]h#]h%]h']h)]uh+hhj%ubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hnotification_name (str) -- h](jg)}(hnotification_nameh]hnotification_name}(hjxhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjtubh (}(hjthhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainj  refexplicitreftypehʌ reftargetjjj.jcj/Nuh+j hjtubh)}(hjthhhNhNubh – }(hjthhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjqubah}(h!]h#]h%]h']h)]uh+j]hjubj^)}(hhh]h)}(hbprefix (str) -- Only look at changes for objects with this prefix (i.e. objects in this s3 folder)h](jg)}(hprefixh]hprefix}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainj  refexplicitreftypehʌ reftargetjjj.jcj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubhROnly look at changes for objects with this prefix (i.e. objects in this s3 folder)}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjubeh}(h!]h#]h%]h']h)]uh+jXhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjxubh)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hj/hhhNhNubah}(h!]h#]h%]h']h)] refdomainj  refexplicitreftypehʌ reftargetNonejj.jcj/Nuh+j hj+ubah}(h!]h#]h%]h']h)]uh+hhj(ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjxubeh}(h!]h#]h%]h']h)]uh+hhjfhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjhhhjhKubeh}(h!]h#](j functioneh%]h']h)]jj jjbjjbjjjuh+hMhhhh hNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI%delete_s3_bucket() (in module AWS_S3)AWS_S3.delete_s3_buckethNtauh+h-hh hhhNhNubhN)}(hhh](hS)}(h0delete_s3_bucket(s3_bucket_name, account_number)h](hY)}(hAWS_S3.h]hAWS_S3.}(hj{hhhNhNubah}(h!]h#](hehfeh%]h']h)]hjhkuh+hXhjwhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.delete_s3_buckethKubhn)}(hdelete_s3_bucketh]hdelete_s3_bucket}(hjhhhNhNubah}(h!]h#](hzh{eh%]h']h)]hjhkuh+hmhjwhhhjhKubh)}(hs3_bucket_name, account_numberh](h)}(hs3_bucket_nameh]h)}(hs3_bucket_nameh]hs3_bucket_name}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubh)}(haccount_numberh]h)}(haccount_numberh]haccount_number}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hjhkuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhjwhhhjhKubeh}(h!]jrah#](hheh%]h']h)]hȌAWS_S3hhhjhjjhΌdelete_s3_bucket()uh+hRhjhKhjthhubh)}(hhh](h)}(hDelete the s3 bucket. Note this uses the AWS SDK and is expected to be replaced with CDK in the future. Users are assumed to have proper IAM access or this function will fail for security reasons.h]hDelete the s3 bucket. Note this uses the AWS SDK and is expected to be replaced with CDK in the future. Users are assumed to have proper IAM access or this function will fail for security reasons.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWS_S3.py:docstring of AWS_S3.delete_s3_buckethKhjhhubh)}(hhh](h)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]h)}(hNoneh]j )}(h:py:obj:`None`h]j)}(hj h]hNone}(hj hhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj( refdomainjreftypeobj refexplicitrefwarnj.jj/Nj0Noneuh+j hjhKhjhhubah}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Parametersh]h Parameters}(hj=hhhNhNubah}(h!]h#]h%]h']h)]uh+hhj:hjhKubj)}(hhh]jY)}(hhh](j^)}(hhh]h)}(hs3_bucket_name (str) -- h](jg)}(hs3_bucket_nameh]hs3_bucket_name}(hjXhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjTubh (}(hjThhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjmhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypehʌ reftargetjojj.jj/Nuh+j hjTubh)}(hjThhhNhNubh – }(hjThhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjQubah}(h!]h#]h%]h']h)]uh+j]hjNubj^)}(hhh]h)}(h@account_number (str) -- The account where the s3 bucket resides.h](jg)}(haccount_numberh]haccount_number}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jfhjubh (}(hjhhhNhNubj )}(hhh]j~)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j}hjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetjjj.jj/Nuh+j hjubh)}(hjhhhNhNubh – }(hjhhhNhNubh(The account where the s3 bucket resides.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]uh+j]hjNubeh}(h!]h#]h%]h']h)]uh+jXhjKubah}(h!]h#]h%]h']h)]uh+jhj:ubeh}(h!]h#]h%]h']h)]uh+hhjubh)}(hhh](h)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+hhjhjhKubj)}(hhh]h)}(hNoneh]j )}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypehʌ reftargetNonejj.jj/Nuh+j hj ubah}(h!]h#]h%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+hhjubeh}(h!]h#]h%]h']h)]uh+hhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+hhjthhhjhKubeh}(h!]h#](jfunctioneh%]h']h)]jjjjCjjCjjjuh+hMhhhh hNhNubeh}(h!](h< aws-s3-moduleeh#]h%] aws_s3 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_handlerjrerror_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}jLjIs nametypes}jLsh!}(jIh hjCj j j j j jjjjjjrjwu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.