Skip to content

StartWorkflowRunRequest

Source code in docs_src/capo_codecatalyst/types/start_workflow_run_request.py 
12
13
14
15
16
17
18
19
20
class StartWorkflowRunRequest(TypedDict, closed=True):
    space_name: "capo_codecatalyst.types.name_string.NameString"
    """<p>The name of the space.</p>"""
    project_name: "capo_codecatalyst.types.name_string.NameString"
    """<p>The name of the project in the space.</p>"""
    workflow_id: "capo_codecatalyst.types.uuid.Uuid"
    """<p>The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use <a>ListWorkflows</a>.</p>"""
    client_token: NotRequired["str"]
    """<p>A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.</p>"""

client_token instance-attribute 

client_token: NotRequired[str]

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

project_name instance-attribute 

project_name: NameString

The name of the project in the space.

space_name instance-attribute 

space_name: NameString

The name of the space.

workflow_id instance-attribute 

workflow_id: Uuid

The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.