Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438212159.2 KB

Returns information about a workflow.

get/v1/spaces/{spaceName}/projects/{projectName}/workflows/{id}

Path parameters

spaceNamestring required

The name of the space.

idstring required

The ID of the workflow. To rerieve a list of workflow IDs, use <a>ListWorkflows</a>.

projectNamestring required

The name of the project in the space.

Response

Success

spaceNamestring required

The name of the space.

projectNamestring required

The name of the project in the space.

idstring required

The ID of the workflow.

namestring required

The name of the workflow.

sourceRepositoryNamestring

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

sourceBranchNamestring

The name of the branch that contains the workflow YAML.

createdTimestring date-time required

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>

lastUpdatedTimestring date-time required

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>

runMode'QUEUED' | 'PARALLEL' | 'SUPERSEDED' required

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.

status'INVALID' | 'ACTIVE' required

The status of the workflow.