Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Add Workflow.create_or_update() to update workflow if it exists or create it if it doesn't #168

Open
a13zen opened this issue Sep 16, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@a13zen
Copy link

a13zen commented Sep 16, 2021

When running notebooks in an automated fashion many times the StepFunction created by the workflow.create() method already exists. The same for when running the workflow.update() method when defining the Workflow for the first time.

We could extend the Workflow class with a create_or_update method that would check if the stepfunction exists, if it does, attach to that otherwise, update it.

# Grab account/region from Boto/Sagemaker Session

class CustomWorkflow(Workflow):
    def __init__(self, name, definition, role, update_sleep_seconds=8, **kwargs):
        super(CustomWorkflow, self).__init__(name, definition, role, **kwargs)
        self.update_sleep_seconds = update_sleep_seconds
        self.expected_arn = f"arn:aws:states:{region}:{account_id}:stateMachine:{self.name}"
        
    def create_or_update(self):
        try:
            target_wf = Workflow.attach(self.expected_arn)
            print('State Machine Exists. Attaching and updating')
            target_wf.update(definition=self.definition, role=self.role)
            # Sleep to allow infrastructure to update before executing a new job
            time.sleep(self.update_sleep_seconds)
        except boto3.client('stepfunctions').exceptions.StateMachineDoesNotExist:
            print('State Machine Not found, creating')
            self.expected_arn = self.create()
        return Workflow.attach(self.expected_arn)
@a13zen a13zen changed the title [Feature Request] Add Workflow.create_or_update() to update workflow if it exists or create it if it doesn't Feature Request: Add Workflow.create_or_update() to update workflow if it exists or create it if it doesn't Sep 17, 2021
@ca-nguyen
Copy link
Contributor

Hi @a13zen,
Having a function that would do the check for you and call the create/update function accordingly would surely be useful and save you he hassle to having to edit the notebook between runs.
Thank you for bringing this to our attention!

@ca-nguyen ca-nguyen added the enhancement New feature or request label Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants