NovaActService / Client / create_workflow_run

create_workflow_run

NovaActService.Client.create_workflow_run(**kwargs)

Creates a new execution instance of a workflow definition with specified parameters.

See also: AWS API Documentation

Request Syntax

response = client.create_workflow_run(
    workflowDefinitionName='string',
    modelId='string',
    clientToken='string',
    logGroupName='string',
    clientInfo={
        'compatibilityVersion': 123,
        'sdkVersion': 'string'
    }
)

Parameters:

• workflowDefinitionName (string) –

  [REQUIRED]

  The name of the workflow definition to execute.

• modelId (string) –

  [REQUIRED]

  The ID of the AI model to use for workflow execution.

• clientToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• logGroupName (string) – The CloudWatch log group name for storing workflow execution logs.

• clientInfo (dict) –

  [REQUIRED]

  Information about the client making the request, including compatibility version and SDK version.

  • compatibilityVersion (integer) – [REQUIRED]

    The compatibility version of the client, used to ensure API compatibility.

  • sdkVersion (string) –

    The version of the SDK being used by the client.

Return type:

dict

Returns:

Response Syntax

{
    'workflowRunId': 'string',
    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'DELETING'
}

Response Structure

• (dict) –

  • workflowRunId (string) –

    The unique identifier for the created workflow run.

  • status (string) –

    The initial status of the workflow run after creation.

Exceptions

• NovaActService.Client.exceptions.AccessDeniedException

• NovaActService.Client.exceptions.ConflictException

• NovaActService.Client.exceptions.ThrottlingException

• NovaActService.Client.exceptions.ResourceNotFoundException

• NovaActService.Client.exceptions.InternalServerException

• NovaActService.Client.exceptions.ValidationException