NovaActService / Client / delete_workflow_run

delete_workflow_run

NovaActService.Client.delete_workflow_run(**kwargs)

Terminates and cleans up a workflow run, stopping all associated acts and sessions.

See also: AWS API Documentation

Request Syntax

response = client.delete_workflow_run(
    workflowDefinitionName='string',
    workflowRunId='string'
)

Parameters:

• workflowDefinitionName (string) –

  [REQUIRED]

  The name of the workflow definition containing the workflow run.

• workflowRunId (string) –

  [REQUIRED]

  The unique identifier of the workflow run to delete.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'DELETING'
}

Response Structure

• (dict) –

  • status (string) –

    The status of the workflow run after deletion request.

Exceptions

• NovaActService.Client.exceptions.AccessDeniedException

• NovaActService.Client.exceptions.ConflictException

• NovaActService.Client.exceptions.ResourceNotFoundException

• NovaActService.Client.exceptions.ThrottlingException

• NovaActService.Client.exceptions.InternalServerException

• NovaActService.Client.exceptions.ValidationException