sphinx.addnodesdocument)}( rawsourcechildren]docutils.nodessection)}(hhh](h title)}(hAWSBatch moduleh]h TextAWSBatch module}(parenth _documenthsourceNlineNuba attributes}(ids]classes]names]dupnames]backrefs]utagnamehhh hhhYC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\docs\AWSModules\AWSBatch.rsthKubhindex)}(hhh]h}(h!]h#]h%]h']h)]entries](pairmodule; AWSBatchmodule-AWSBatchhNtauh+h-hh hhhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](singlebatch (class in AWSBatch)AWSBatch.batchhNtauh+h-hh hhhNhNubhdesc)}(hhh](hdesc_signature)}(hbatch(infrastructure_type, region='us-east-1', batch_namespace='batch-namespace', queue_name='my-queue-1', computeEnvironmentName='TwinFlow_batch_env', minvCpus=1, maxvCpus=500, instanceTypes='optimal', IAM_role=None)h](hdesc_annotation)}(h2[<#text: 'class'>, >]h](hclass}(hhZhhhNhNubhdesc_sig_space)}(h h]h }(hhdhhhNhNubah}(h!]h#]wah%]h']h)]uh+hbhhZubeh}(h!]h#]h%]h']h)] xml:spacepreserveuh+hXhhThhh{C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batchhKubh desc_addname)}(h AWSBatch.h]h AWSBatch.}(hh~hhhNhNubah}(h!]h#]( sig-prename descclassnameeh%]h']h)]hyhzuh+h|hhThhhh{hKubh desc_name)}(hbatchh]hbatch}(hhhhhNhNubah}(h!]h#](sig-namedescnameeh%]h']h)]hyhzuh+hhhThhhh{hKubhdesc_parameterlist)}(hinfrastructure_type, region='us-east-1', batch_namespace='batch-namespace', queue_name='my-queue-1', computeEnvironmentName='TwinFlow_batch_env', minvCpus=1, maxvCpus=500, instanceTypes='optimal', IAM_role=Noneh](hdesc_parameter)}(hinfrastructure_typeh]h desc_sig_name)}(hinfrastructure_typeh]hinfrastructure_type}(hhhhhNhNubah}(h!]h#]nah%]h']h)]uh+hhhubah}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(hregion='us-east-1'h](h)}(hregionh]hregion}(hhhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubhdesc_sig_operator)}(h=h]h=}(hhhhhNhNubah}(h!]h#]oah%]h']h)]uh+hhhubh inline)}(h 'us-east-1'h]h 'us-east-1'}(hhhhhNhNubah}(h!]h#] default_valueah%]h']h)]support_smartquotesuh+hhhubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(h!batch_namespace='batch-namespace'h](h)}(hbatch_namespaceh]hbatch_namespace}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubh)}(h'batch-namespace'h]h'batch-namespace'}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhhubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(hqueue_name='my-queue-1'h](h)}(h queue_nameh]h queue_name}(hj7hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj3ubh)}(h=h]h=}(hjEhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj3ubh)}(h 'my-queue-1'h]h 'my-queue-1'}(hjShhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhj3ubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(h+computeEnvironmentName='TwinFlow_batch_env'h](h)}(hcomputeEnvironmentNameh]hcomputeEnvironmentName}(hjlhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjhubh)}(h=h]h=}(hjzhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjhubh)}(h'TwinFlow_batch_env'h]h'TwinFlow_batch_env'}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjhubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(h minvCpus=1h](h)}(hminvCpush]hminvCpus}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h1h]h1}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(h maxvCpus=500h](h)}(hmaxvCpush]hmaxvCpus}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h500h]h500}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(hinstanceTypes='optimal'h](h)}(h instanceTypesh]h instanceTypes}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h 'optimal'h]h 'optimal'}(hj'hhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubh)}(h IAM_role=Noneh](h)}(hIAM_roleh]hIAM_role}(hj@hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj<ubh)}(h=h]h=}(hjNhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj<ubh)}(hNoneh]hNone}(hj\hhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhj<ubeh}(h!]h#]h%]h']h)]hyhzuh+hhhubeh}(h!]h#]h%]h']h)]hyhzuh+hhhThhhh{hKubeh}(h!]hKah#](sig sig-objecteh%]h']h)]moduleAWSBatchclasshfullnameh _toc_partsjh _toc_namehuh+hRhh{hKhhOhhubh desc_content)}(hhh](h paragraph)}(hBases: :py:class:`object`h](hBases: }(hjhhhNhNubh pending_xref)}(h:py:class:`object`h]h literal)}(hjh]hobject}(hjhhhNhNubah}(h!]h#](xrefpypy-classeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocAWSModules/AWSBatch refdomainjreftypeclass refexplicitrefwarn py:modulejpy:classh reftargetobjectuh+jh{C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batchhKhjubeh}(h!]h#]h%]h']h)]uh+jhjhKhjhhubj)}(hQHandle both the IaC for AWS Batch and utilization of queues, job submission, etc.h]hQHandle both the IaC for AWS Batch and utilization of queues, job submission, etc.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jh{C:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batchhKhjhhubj)}(hHThe IaC is relying on AWS SDK, in the future it will be swapped for CDK.h]hHThe IaC is relying on AWS SDK, in the future it will be swapped for CDK.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhKhjhhubh field_list)}(hhh](h field)}(hhh](h field_name)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhh{hKubh field_body)}(hhh]h bullet_list)}(hhh](h list_item)}(hhh]j)}(h^infrastructure_type (str) -- Determines underlying infrastructure type. e.g. EKS, Fargate, EC2h](hliteral_strong)}(hinfrastructure_typeh]hinfrastructure_type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhj ubh (}(hj hhhNhNubj)}(hhh]hliteral_emphasis)}(hstrh]hstr}(hj(hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj#ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetj* refspecificjjjhuh+jhj ubh)}(hj hhhNhNubh – }(hj hhhNhNubhADetermines underlying infrastructure type. e.g. EKS, Fargate, EC2}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(h:infrastructure_type -- Options are: 'ec2', 'eks','fargate'h](j)}(hinfrastructure_typeh]hinfrastructure_type}(hjahhhNhNubah}(h!]h#]h%]h']h)]uh+jhj]ubh – }(hj]hhhNhNubh/Options are: ‘ec2’, ‘eks’,’fargate’}(hj]hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjZubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(h5region (str, optional) -- The default is "us-east-1".h](j)}(hregionh]hregion}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubhThe default is “us-east-1”.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hDbatch_namespace (str, optional) -- The default is "batch-namespace".h](j)}(hbatch_namespaceh]hbatch_namespace}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(h, h]h, }(hj,hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hoptionalh]hoptional}(hj=hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj:ubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetj?jAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubh%The default is “batch-namespace”.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(h:queue_name (str, optional) -- The default is "my-queue-1".h](j)}(h queue_nameh]h queue_name}(hjthhhNhNubah}(h!]h#]h%]h']h)]uh+jhjpubh (}(hjphhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjpubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjpubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjpubh)}(hjphhhNhNubh – }(hjphhhNhNubh The default is “my-queue-1”.}(hjphhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjmubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hNcomputeEnvironmentName (str, optional) -- The default is 'TwinFlow_batch_env'.h](j)}(hcomputeEnvironmentNameh]hcomputeEnvironmentName}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hoptionalh]hoptional}(hj'hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj$ubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetj)jAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubh(The default is ‘TwinFlow_batch_env’.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hXminvCpus (int, optional) -- Any value greater than or equal to zero. A value of zero means the cluster will auto close all compute instances when finished, but requires the longest start up time for new jobs. If a user selects a warm startup configuration such as a value of 500, a cluster will remain provisioned and provide the fastest startup time for new jobs, but also includes costs of keeping these instances open. The default is 1.h](j)}(hminvCpush]hminvCpus}(hj^hhhNhNubah}(h!]h#]h%]h']h)]uh+jhjZubh (}(hjZhhhNhNubj)}(hhh]j')}(hinth]hint}(hjshhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjpubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjujAjjjhuh+jhjZubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjZubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjZubh)}(hjZhhhNhNubh – }(hjZhhhNhNubhXAny value greater than or equal to zero. A value of zero means the cluster will auto close all compute instances when finished, but requires the longest start up time for new jobs. If a user selects a warm startup configuration such as a value of 500, a cluster will remain provisioned and provide the fastest startup time for new jobs, but also includes costs of keeping these instances open. The default is 1.}(hjZhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjWubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hfmaxvCpus (int, optional) -- Prevent AWS Batch from using more than this many cpus. The default is 500.h](j)}(hmaxvCpush]hmaxvCpus}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hinth]hint}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubhJPrevent AWS Batch from using more than this many cpus. The default is 500.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hX0instanceTypes (str, optional) -- Specify the exact instant type or leave this as default for Batch auto selection. When defining batch jobs with 'defineBatchJob', users can select a GPU instance. However, if a user wants a specific type, such as a P4, that must be defined here. The default is 'optimal'.h](j)}(h instanceTypesh]h instanceTypes}(hjHhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjDubh (}(hjDhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hj]hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjZubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetj_jAjjjhuh+jhjDubj')}(h, h]h, }(hjuhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjDubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjDubh)}(hjDhhhNhNubh – }(hjDhhhNhNubhXSpecify the exact instant type or leave this as default for Batch auto selection. When defining batch jobs with ‘defineBatchJob’, users can select a GPU instance. However, if a user wants a specific type, such as a P4, that must be defined here. The default is ‘optimal’.}(hjDhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjAubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hmIAM_role (str, optional) -- What is the IAM role that the compute instances will assume. The default is None.h](j)}(hIAM_roleh]hIAM_role}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetjjAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubhQWhat is the IAM role that the compute instances will assume. The default is None.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j)}(h Return typeh]h Return type}(hj@hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj=hh{hKubj)}(hhh]j)}(hNone.h]j)}(hhh]hNone.}(hjUhhhNhNubah}(h!]h#]h%]h']h)] refdomainj= refexplicitreftypej reftargetNone.jAjjjhuh+jhjQubah}(h!]h#]h%]h']h)]uh+jhjNubah}(h!]h#]h%]h']h)]uh+jhj=ubeh}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjhhhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI&sendBatchJob() (AWSBatch.batch method)AWSBatch.batch.sendBatchJobhNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(hEbatch.sendBatchJob(jobName, jobDefinitionName, override_command=None)h](h)}(h sendBatchJobh]h sendBatchJob}(hjhhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.sendBatchJobhKubh)}(h1jobName, jobDefinitionName, override_command=Noneh](h)}(hjobNameh]h)}(hjobNameh]hjobName}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hyhzuh+hhjubh)}(hjobDefinitionNameh]h)}(hjobDefinitionNameh]hjobDefinitionName}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hyhzuh+hhjubh)}(hoverride_command=Noneh](h)}(hoverride_commandh]hoverride_command}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(hNoneh]hNone}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjubeh}(h!]h#]h%]h']h)]hyhzuh+hhjubeh}(h!]h#]h%]h']h)]hyhzuh+hhjhhhjhKubeh}(h!]jah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.sendBatchJobjjbatch sendBatchJobjbatch.sendBatchJob()uh+hRhjhKhjhhubj)}(hhh]j)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hj'hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj$hjhKubj)}(hhh]j)}(hNoneh]j)}(h:py:obj:`None`h]j)}(hj>h]hNone}(hj@hhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhj<ubah}(h!]h#]h%]h']h)]refdocj refdomainjJreftypeobj refexplicitrefwarnjjjhjNoneuh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.sendBatchJobhKhj8hhubah}(h!]h#]h%]h']h)]uh+jhj5ubah}(h!]h#]h%]h']h)]uh+jhj$ubeh}(h!]h#]h%]h']h)]uh+jhj!ubj)}(hhh](j)}(h Parametersh]h Parameters}(hjrhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjohjhKubj)}(hhh]j)}(hhh](j)}(hhh]j)}(h;jobName (str) -- The name for this specific job submission.h](j)}(hjobNameh]hjobName}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetjjAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubh*The name for this specific job submission.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hAjobDefinitionName (str) -- The name of the job definition to use.h](j)}(hjobDefinitionNameh]hjobDefinitionName}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetjjAjjjhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubh&The name of the job definition to use.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh]j)}(hoverride_command (list, optional) -- When running this job, what command line argument should be used instead of the command provided in the job definition. The default is None.h](j)}(hoverride_commandh]hoverride_command}(hj& hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj" ubh (}(hj" hhhNhNubj)}(hhh]j')}(hlisth]hlist}(hj; hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj8 ubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetj= jAjjjhuh+jhj" ubj')}(h, h]h, }(hjS hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj" ubj)}(hhh]j')}(hoptionalh]hoptional}(hjd hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hja ubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetjf jAjjjhuh+jhj" ubh)}(hj" hhhNhNubh – }(hj" hhhNhNubhWhen running this job, what command line argument should be used instead of the command provided in the job definition. The default is None.}(hj" hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjoubeh}(h!]h#]h%]h']h)]uh+jhj!ubj)}(hhh](j)}(hReturnsh]hReturns}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj hjhKubj)}(hhh]j)}(hprint(response) { 'jobId': '876da822-4198-45f2-a252-6cea32512ea8', 'jobName': 'example', 'ResponseMetadata': { '...': '...', }, }h]h literal_block)}(hprint(response) { 'jobId': '876da822-4198-45f2-a252-6cea32512ea8', 'jobName': 'example', 'ResponseMetadata': { '...': '...', }, }h]hprint(response) { 'jobId': '876da822-4198-45f2-a252-6cea32512ea8', 'jobName': 'example', 'ResponseMetadata': { '...': '...', }, }}(hj hhhNhNubah}(h!]h#]h%]h']h)]hyhzforcelanguagepythonhighlight_args}uh+j hj\hKhj hhubah}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+jhj!ubeh}(h!]h#]h%]h']h)]uh+jhjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhhhjhKubeh}(h!]h#](jmethodeh%]h']h)]domainjobjtypej desctypej noindex noindexentrynocontentsentryuh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI-removeJobDefinition() (AWSBatch.batch method)"AWSBatch.batch.removeJobDefinitionhNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(h,batch.removeJobDefinition(jobDefinitionName)h](h)}(hremoveJobDefinitionh]hremoveJobDefinition}(hj hhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhj hhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.removeJobDefinitionhKubh)}(hjobDefinitionNameh]h)}(hjobDefinitionNameh]h)}(hjobDefinitionNameh]hjobDefinitionName}(hj* hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj& ubah}(h!]h#]h%]h']h)]hyhzuh+hhj" ubah}(h!]h#]h%]h']h)]hyhzuh+hhj hhhj! hKubeh}(h!]j ah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.removeJobDefinitionjjJ batchremoveJobDefinitionjbatch.removeJobDefinition()uh+hRhj! hKhj hhubj)}(hhh](j)}(h4This will delete all versions of the job definition.h]h4This will delete all versions of the job definition.}(hjS hhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.removeJobDefinitionhKhjP hhubj)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hjh hhhNhNubah}(h!]h#]h%]h']h)]uh+jhje hj! hKubj)}(hhh]j)}(hNoneh]j)}(h:py:obj:`None`h]j)}(hj h]hNone}(hj hhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhj} ubah}(h!]h#]h%]h']h)]refdocj refdomainj reftypeobj refexplicitrefwarnjjJ jhjNoneuh+jhja hKhjy hhubah}(h!]h#]h%]h']h)]uh+jhjv ubah}(h!]h#]h%]h']h)]uh+jhje ubeh}(h!]h#]h%]h']h)]uh+jhjb ubj)}(hhh](j)}(h Parametersh]h Parameters}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj hj! hKubj)}(hhh]j)}(hjobDefinitionName (str) -- h](j)}(hjobDefinitionNameh]hjobDefinitionName}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj ubh (}(hj hhhNhNubj)}(hhh]j')}(hstrh]hstr}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetj jAjjJ jhuh+jhj ubh)}(hj hhhNhNubh – }(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+jhjb ubj)}(hhh](j)}(h Return typeh]h Return type}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj hj! hKubj)}(hhh]j)}(hNone.h]j)}(hhh]hNone.}(hj' hhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetNone.jAjjJ jhuh+jhj# ubah}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+jhjb ubeh}(h!]h#]h%]h']h)]uh+jhjP hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj hhhj! hKubeh}(h!]h#](j methodeh%]h']h)]j j j jZ j jZ j j j uh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI(defineBatchJob() (AWSBatch.batch method)AWSBatch.batch.defineBatchJobhNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(hbatch.defineBatchJob(image_name_uri, host_path, job_command, cpu, memory, jobDefinitionName, gpu=0, timeout=0, environ_vars=None)h](h)}(hdefineBatchJobh]hdefineBatchJob}(hjs hhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhjo hhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.defineBatchJobhKubh)}(hkimage_name_uri, host_path, job_command, cpu, memory, jobDefinitionName, gpu=0, timeout=0, environ_vars=Noneh](h)}(himage_name_urih]h)}(himage_name_urih]himage_name_uri}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(h host_pathh]h)}(h host_pathh]h host_path}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(h job_commandh]h)}(h job_commandh]h job_command}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(hcpuh]h)}(hcpuh]hcpu}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(hmemoryh]h)}(hmemoryh]hmemory}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(hjobDefinitionNameh]h)}(hjobDefinitionNameh]hjobDefinitionName}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubah}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(hgpu=0h](h)}(hgpuh]hgpu}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubh)}(h=h]h=}(hj( hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubh)}(h0h]h0}(hj6 hhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhj ubeh}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(h timeout=0h](h)}(htimeouth]htimeout}(hjO hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjK ubh)}(h=h]h=}(hj] hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjK ubh)}(h0h]h0}(hjk hhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjK ubeh}(h!]h#]h%]h']h)]hyhzuh+hhj ubh)}(henviron_vars=Noneh](h)}(h environ_varsh]h environ_vars}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubh)}(h=h]h=}(hj hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj ubh)}(hNoneh]hNone}(hj hhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhj ubeh}(h!]h#]h%]h']h)]hyhzuh+hhj ubeh}(h!]h#]h%]h']h)]hyhzuh+hhjo hhhj hKubeh}(h!]jj ah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.defineBatchJobjj batchdefineBatchJobjbatch.defineBatchJob()uh+hRhj hKhjl hhubj)}(hhh](j)}(hNCreate an AWS Batch job definition that can be utilized by any number of jobs.h]hNCreate an AWS Batch job definition that can be utilized by any number of jobs.}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.defineBatchJobhKhj hhubj)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj hj hKubj)}(hhh]j)}(hNoneh]j)}(h:py:obj:`None`h]j)}(hj h]hNone}(hj hhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]refdocj refdomainj reftypeobj refexplicitrefwarnjj jhjNoneuh+jhj hKhj hhubah}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+jhj ubj)}(hhh](j)}(h Parametersh]h Parameters}(hj) hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj& hj hKubj)}(hhh]j)}(hhh](j)}(hhh]j)}(hOimage_name_uri (str) -- The container end point reference such as ECR location.h](j)}(himage_name_urih]himage_name_uri}(hjD hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj@ ubh (}(hj@ hhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjY hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjV ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetj[ jAjj jhuh+jhj@ ubh)}(hj@ hhhNhNubh – }(hj@ hhhNhNubh7The container end point reference such as ECR location.}(hj@ hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj= ubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(h;host_path (str) -- If using EKS, host path must be defined.h](j)}(h host_pathh]h host_path}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj ubh (}(hj hhhNhNubj)}(hhh]j')}(hstrh]hstr}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj ubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetj jAjj jhuh+jhj ubh)}(hj hhhNhNubh – }(hj hhhNhNubh(If using EKS, host path must be defined.}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(h`job_command (list) -- Default command line arguments, can be overridden for each job submission.h](j)}(h job_commandh]h job_command}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj ubh (}(hj hhhNhNubj)}(hhh]j')}(hlisth]hlist}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj ubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetj jAjj jhuh+jhj ubh)}(hj hhhNhNubh – }(hj hhhNhNubhJDefault command line arguments, can be overridden for each job submission.}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(h(cpu (int) -- How many vcpu are required.h](j)}(hcpuh]hcpu}(hj)hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj%ubh (}(hj%hhhNhNubj)}(hhh]j')}(hinth]hint}(hj>hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj;ubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetj@jAjj jhuh+jhj%ubh)}(hj%hhhNhNubh – }(hj%hhhNhNubhHow many vcpu are required.}(hj%hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj"ubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(h/memory (int) -- How much RAM in MB is required.h](j)}(hmemoryh]hmemory}(hjuhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjqubh (}(hjqhhhNhNubj)}(hhh]j')}(hinth]hint}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetjjAjj jhuh+jhjqubh)}(hjqhhhNhNubh – }(hjqhhhNhNubhHow much RAM in MB is required.}(hjqhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjnubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(h.jobDefinitionName (str) -- Name the definitionh](j)}(hjobDefinitionNameh]hjobDefinitionName}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetjjAjj jhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubhName the definition}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(hBgpu (int, optional) -- How many GPUs are needed. The default is 0.h](j)}(hgpuh]hgpu}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj ubh (}(hj hhhNhNubj)}(hhh]j')}(hinth]hint}(hj"hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetj$jAjj jhuh+jhj ubj')}(h, h]h, }(hj:hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj ubj)}(hhh]j')}(hoptionalh]hoptional}(hjKhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjHubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetjMjAjj jhuh+jhj ubh)}(hj hhhNhNubh – }(hj hhhNhNubh+How many GPUs are needed. The default is 0.}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(hftimeout (int, optional) -- Job will be auto-aborted after this amount of time (sec). The default is 0.h](j)}(htimeouth]htimeout}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhj~ubh (}(hj~hhhNhNubj)}(hhh]j')}(hinth]hint}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetjjAjj jhuh+jhj~ubj')}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj~ubj)}(hhh]j')}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetjjAjj jhuh+jhj~ubh)}(hj~hhhNhNubh – }(hj~hhhNhNubhKJob will be auto-aborted after this amount of time (sec). The default is 0.}(hj~hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj{ubah}(h!]h#]h%]h']h)]uh+jhj: ubj)}(hhh]j)}(henviron_vars (dict, optional) -- What environmental variables should be set prior to job command execution. The default is None.h](j)}(h environ_varsh]h environ_vars}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hdicth]hdict}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj ubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetjjAjj jhuh+jhjubj')}(h, h]h, }(hj$hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hoptionalh]hoptional}(hj5hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj2ubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetj7jAjj jhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubh_What environmental variables should be set prior to job command execution. The default is None.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhj: ubeh}(h!]h#]h%]h']h)]uh+jhj7 ubah}(h!]h#]h%]h']h)]uh+jhj& ubeh}(h!]h#]h%]h']h)]uh+jhj ubj)}(hhh](j)}(h Return typeh]h Return type}(hjzhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjwhj hKubj)}(hhh]j)}(hNoneh]j)}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainjn refexplicitreftypej reftargetNonejAjj jhuh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjwubeh}(h!]h#]h%]h']h)]uh+jhj ubeh}(h!]h#]h%]h']h)]uh+jhj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjl hhhj hKubeh}(h!]h#](jn methodeh%]h']h)]j jn j jj jj j j uh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI'generateBatch() (AWSBatch.batch method)AWSBatch.batch.generateBatchhNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(hbatch.generateBatch(**kwargs)h](h)}(h generateBatchh]h generateBatch}(hjhhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.generateBatchhKubh)}(h**kwargsh]h)}(h**kwargsh](h)}(h**h]h**}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(hkwargsh]hkwargs}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubeh}(h!]h#]h%]h']h)]hyhzuh+hhjubah}(h!]h#]h%]h']h)]hyhzuh+hhjhhhjhKubeh}(h!]jah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.generateBatchjj batch generateBatchjbatch.generateBatch()uh+hRhjhKhjhhubj)}(hhh](j)}(hQGenerate the AWS Batch environment and the queue needed to run jobs in AWS Batch.h]hQGenerate the AWS Batch environment and the queue needed to run jobs in AWS Batch.}(hj)hhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.generateBatchhKhj&hhubj)}(hhh](j)}(hhh](j)}(h Parametersh]h Parameters}(hj>hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj;hjhKubj)}(hhh]j)}(hhh](j)}(hhh]j)}(h>and (Most setup should be set during object instantiation) -- h](j)}(handh]hand}(hjYhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjUubh (}(hjUhhhNhNubj)}(hhh]j')}(h4Most setup should be set during object instantiationh]h4Most setup should be set during object instantiation}(hjnhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjkubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetjpjAjj jhuh+jhjUubh)}(hjUhhhNhNubh – }(hjUhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjRubah}(h!]h#]h%]h']h)]uh+jhjOubj)}(hhh]j)}(hGbatch. (thus a user only needs to call this method to generate the) -- h](j)}(hbatch.h]hbatch.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(h:thus a user only needs to call this method to generate theh]h:thus a user only needs to call this method to generate the}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetjjAjj jhuh+jhjubh)}(hjhhhNhNubh – }(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjOubeh}(h!]h#]h%]h']h)]uh+jhjLubah}(h!]h#]h%]h']h)]uh+jhj;ubeh}(h!]h#]h%]h']h)]uh+jhj8ubj)}(hhh](j)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjhKubj)}(hhh]j)}(hNone.h]j)}(hhh]hNone.}(hj hhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetNone.jAjj jhuh+jhj ubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhj8ubeh}(h!]h#]h%]h']h)]uh+jhj&hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjhhhjhKubeh}(h!]h#](jmethodeh%]h']h)]j jj j@j j@j j j uh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI(terminateBatch() (AWSBatch.batch method)AWSBatch.batch.terminateBatchhNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(hbatch.terminateBatch()h](h)}(hterminateBatchh]hterminateBatch}(hjYhhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhjUhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.terminateBatchhKubh)}(h()h]h}(h!]h#]h%]h']h)]hyhzuh+hhjUhhhjghKubeh}(h!]jPah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.terminateBatchjjxbatchterminateBatchjbatch.terminateBatch()uh+hRhjghKhjRhhubj)}(hhh](j)}(hWhen a user is done using an AWS Batch environment, this function will terminate both the queue and the batch compute environment.h]hWhen a user is done using an AWS Batch environment, this function will terminate both the queue and the batch compute environment.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.terminateBatchhKhj~hhubj)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjghKubj)}(hhh]j)}(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 refexplicitrefwarnjjxjhjNoneuh+jhjhKhjhhubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjghKubj)}(hhh]j)}(hNoneh]j)}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetNonejAjjxjhuh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhj~hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjRhhhjghKubeh}(h!]h#](jmethodeh%]h']h)]j jj j)j j)j j j uh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI.wait_for_jobs_finish() (AWSBatch.batch method)#AWSBatch.batch.wait_for_jobs_finishhNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(h$batch.wait_for_jobs_finish(all_jobs)h](h)}(hwait_for_jobs_finishh]hwait_for_jobs_finish}(hjBhhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhj>hhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.wait_for_jobs_finishhKubh)}(hall_jobsh]h)}(hall_jobsh]h)}(hall_jobsh]hall_jobs}(hjYhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjUubah}(h!]h#]h%]h']h)]hyhzuh+hhjQubah}(h!]h#]h%]h']h)]hyhzuh+hhj>hhhjPhKubeh}(h!]j9ah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.wait_for_jobs_finishjjybatchwait_for_jobs_finishjbatch.wait_for_jobs_finish()uh+hRhjPhKhj;hhubj)}(hhh](j)}(h~This is a blocking function that will pause execution of python code until all jobs have terminated within the specific queue.h]h~This is a blocking function that will pause execution of python code until all jobs have terminated within the specific queue.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.wait_for_jobs_finishhKhjhhubj)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjPhKubj)}(hhh]j)}(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 refexplicitrefwarnjjyjhjNoneuh+jhjhKhjhhubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjPhKubj)}(hhh]j)}(hall_jobs (list[str]) -- Job IDs to monitor for completion. Can be used with the 'get_running_jobs' to obtain a list of all currently running jobs in the queue.h](j)}(hall_jobsh]hall_jobs}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hlisth]hlist}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetj jAjjyjhuh+jhjubj')}(h[h]h[}(hj$hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hstrh]hstr}(hj5hhhNhNubah}(h!]h#]h%]h']h)]uh+j&hj2ubah}(h!]h#]h%]h']h)] refdomainj  refexplicitreftypej reftargetj7jAjjyjhuh+jhjubj')}(h]h]h]}(hjMhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubh)}(hjhhhNhNubh – }(hjhhhNhNubhJob IDs to monitor for completion. Can be used with the ‘get_running_jobs’ to obtain a list of all currently running jobs in the queue.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j)}(h Return typeh]h Return type}(hj|hhhNhNubah}(h!]h#]h%]h']h)]uh+jhjyhjPhKubj)}(hhh]j)}(hNoneh]j)}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainj  refexplicitreftypej reftargetNonejAjjyjhuh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjyubeh}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj;hhhjPhKubeh}(h!]h#](j methodeh%]h']h)]j j j jj jj j j uh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI#kill_jobs() (AWSBatch.batch method)AWSBatch.batch.kill_jobshNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(hbatch.kill_jobs(jobs)h](h)}(h kill_jobsh]h kill_jobs}(hjhhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhjhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.kill_jobshKubh)}(hjobsh]h)}(hjobsh]h)}(hjobsh]hjobs}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubah}(h!]h#]h%]h']h)]hyhzuh+hhjubah}(h!]h#]h%]h']h)]hyhzuh+hhjhhhjhKubeh}(h!]jah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.kill_jobsjjbatch kill_jobsjbatch.kill_jobs()uh+hRhjhKhjhhubj)}(hhh](j)}(h?Terminate all jobs provided in this list from a specific queue.h]h?Terminate all jobs provided in this list from a specific queue.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.kill_jobshKhjhhubj)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hj2hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj/hjhKubj)}(hhh]j)}(hNoneh]j)}(h:py:obj:`None`h]j)}(hjIh]hNone}(hjKhhhNhNubah}(h!]h#](jpypy-objeh%]h']h)]uh+jhjGubah}(h!]h#]h%]h']h)]refdocj refdomainjUreftypeobj refexplicitrefwarnjjjhjNoneuh+jhj+hKhjChhubah}(h!]h#]h%]h']h)]uh+jhj@ubah}(h!]h#]h%]h']h)]uh+jhj/ubeh}(h!]h#]h%]h']h)]uh+jhj,ubj)}(hhh](j)}(h Parametersh]h Parameters}(hj|hhhNhNubah}(h!]h#]h%]h']h)]uh+jhjyhjhKubj)}(hhh]j)}(hXjobs (list[str]) -- List of job IDs that will be terminated. Note, this is often not instances, i.e. the termination command will be sent to Batch, and there may be a delay in seeing termination in the AWS Console as Batch graceful to terminates the container.h](j)}(hjobsh]hjobs}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjubh (}(hjhhhNhNubj)}(hhh]j')}(hlisth]hlist}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(hj&h]h[}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubj)}(hhh]j')}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetjjAjjjhuh+jhjubj')}(hjOh]h]}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j&hjubh)}(hjhhhNhNubh – }(hjhhhNhNubhList of job IDs that will be terminated. Note, this is often not instances, i.e. the termination command will be sent to Batch, and there may be a delay in seeing termination in the AWS Console as Batch graceful to terminates the container.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjyubeh}(h!]h#]h%]h']h)]uh+jhj,ubj)}(hhh](j)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjhKubj)}(hhh]j)}(hNoneh]j)}(hhh]hNone}(hj*hhhNhNubah}(h!]h#]h%]h']h)] refdomainj refexplicitreftypej reftargetNonejAjjjhuh+jhj&ubah}(h!]h#]h%]h']h)]uh+jhj#ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhj,ubeh}(h!]h#]h%]h']h)]uh+jhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjhhhjhKubeh}(h!]h#](jmethodeh%]h']h)]j jj j]j j]j j j uh+hMhhhjhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](hI*get_running_jobs() (AWSBatch.batch method)AWSBatch.batch.get_running_jobshNtauh+h-hjhhhNhNubhN)}(hhh](hS)}(hbatch.get_running_jobs()h](h)}(hget_running_jobsh]hget_running_jobs}(hjvhhhNhNubah}(h!]h#](hheh%]h']h)]hyhzuh+hhjrhhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.get_running_jobshKubh)}(h()h]h}(h!]h#]h%]h']h)]hyhzuh+hhjrhhhjhKubeh}(h!]jmah#](jzj{eh%]h']h)]jAWSBatchjhjbatch.get_running_jobsjjbatchget_running_jobsjbatch.get_running_jobs()uh+hRhjhKhjohhubj)}(hhh](j)}(hReturns a list that containers both the job name and the batch defined job ID. The 'kill_jobs' and 'wait_for_jobs_finish' only require the jobID.h]hReturns a list that containers both the job name and the batch defined job ID. The ‘kill_jobs’ and ‘wait_for_jobs_finish’ only require the jobID.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\AWSModules\AWSBatch.py:docstring of AWSBatch.batch.get_running_jobshKhjhhubj)}(hhh](j)}(hhh](j)}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjhKubj)}(hhh]j)}(hlisth]j)}(h:py:class:`list`h]j)}(hjh]hlist}(hjhhhNhNubah}(h!]h#](jpypy-classeh%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]refdocj refdomainjreftypeclass refexplicitrefwarnjjjhjlistuh+jhjhKhjhhubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j)}(hReturnsh]hReturns}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjhjhKubj)}(hhh]j)}(h [job['jobName'] , job['jobId'] ]h]h([job[‘jobName’] , job[‘jobId’] ]}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j)}(h Return typeh]h Return type}(hj+hhhNhNubah}(h!]h#]h%]h']h)]uh+jhj(hjhKubj)}(hhh]j)}(hlisth]j)}(hhh]hlist}(hj@hhhNhNubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetlistjAjjjhuh+jhj<ubah}(h!]h#]h%]h']h)]uh+jhj9ubah}(h!]h#]h%]h']h)]uh+jhj(ubeh}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjohhhjhKubeh}(h!]h#](jNmethodeh%]h']h)]j jNj jtj jtj j j uh+hMhhhjhNhNubeh}(h!]h#]h%]h']h)]uh+jhhOhhhh{hKubeh}(h!]h#](j=classeh%]h']h)]j j=j jj jj j j uh+hMhhhh hNhNubeh}(h!](h<awsbatch-moduleeh#]h%]awsbatch 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 hjjjmjru 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.