Skip to content

GetWorkflowResponse

Source code in docs_src/capo_codecatalyst/types/get_workflow_response.py
class GetWorkflowResponse(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>"""
    id: "capo_codecatalyst.types.uuid.Uuid"
    """<p>The ID of the workflow.</p>"""
    name: "str"
    """<p>The name of the workflow.</p>"""
    source_repository_name: NotRequired[
        "capo_codecatalyst.types.source_repository_name_string.SourceRepositoryNameString"
    ]
    """<p>The name of the source repository where the workflow YAML is stored.</p>"""
    source_branch_name: NotRequired[
        "capo_codecatalyst.types.source_repository_branch_string.SourceRepositoryBranchString"
    ]
    """<p>The name of the branch that contains the workflow YAML.</p>"""
    definition: "capo_codecatalyst.types.workflow_definition.WorkflowDefinition"
    """<p>Information about the workflow definition file for the workflow.</p>"""
    created_time: "capo_codecatalyst.types.timestamp.Timestamp"
    """<p>The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a> </p>"""
    last_updated_time: "capo_codecatalyst.types.timestamp.Timestamp"
    """<p>The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a> </p>"""
    run_mode: "capo_codecatalyst.types.workflow_run_mode.WorkflowRunMode"
    """<p>The behavior to use when multiple workflows occur at the same time. For more information, see <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html">https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html</a> in the Amazon CodeCatalyst User Guide.</p>"""
    status: "capo_codecatalyst.types.workflow_status.WorkflowStatus"
    """<p>The status of the workflow.</p>"""

created_time instance-attribute

created_time: Timestamp

The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

definition instance-attribute

definition: WorkflowDefinition

Information about the workflow definition file for the workflow.

id instance-attribute

id: Uuid

The ID of the workflow.

last_updated_time instance-attribute

last_updated_time: Timestamp

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

name instance-attribute

name: str

The name of the workflow.

project_name instance-attribute

project_name: NameString

The name of the project in the space.

run_mode instance-attribute

run_mode: WorkflowRunMode

The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

source_branch_name instance-attribute

source_branch_name: NotRequired[SourceRepositoryBranchString]

The name of the branch that contains the workflow YAML.

source_repository_name instance-attribute

source_repository_name: NotRequired[SourceRepositoryNameString]

The name of the source repository where the workflow YAML is stored.

space_name instance-attribute

space_name: NameString

The name of the space.

status instance-attribute

The status of the workflow.