Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetWorkflow

Returns information about a workflow.

Request Syntax


GET /v1/spaces/spaceName/projects/projectName/workflows/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

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

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

projectName

The name of the project in the space.

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

Required: Yes

spaceName

The name of the space.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdTime": "string",
   "definition": { 
      "path": "string"
   },
   "id": "string",
   "lastUpdatedTime": "string",
   "name": "string",
   "projectName": "string",
   "runMode": "string",
   "sourceBranchName": "string",
   "sourceRepositoryName": "string",
   "spaceName": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdTime

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

Type: Timestamp

definition

Information about the workflow definition file for the workflow.

Type: WorkflowDefinition object

id

The ID of the workflow.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

lastUpdatedTime

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

Type: Timestamp

name

The name of the workflow.

Type: String

projectName

The name of the project in the space.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

runMode

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.

Type: String

Valid Values: QUEUED | PARALLEL | SUPERSEDED

sourceBranchName

The name of the branch that contains the workflow YAML.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

sourceRepositoryName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: (?!.*[.]git$)[\w\-.]*

spaceName

The name of the space.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

status

The status of the workflow.

Type: String

Valid Values: INVALID | ACTIVE

Errors

AccessDeniedException

The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.

HTTP Status Code: 403

ConflictException

The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.

HTTP Status Code: 409

ResourceNotFoundException

The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.

HTTP Status Code: 400

Examples

Example

The following example illustrates using GetWorkflow to retrieve information about a workflow named MyDemoWorkflow in the MyDemoProject project that is part of the ExampleCorp space.

Sample Request


GET https://codecatalyst.global.api.aws/v1/spaces/ExampleCorp/projects/MyDemoProject/workflows/MyDemoWorkflow
Host: codecatalyst.global.api.aws
User-Agent: aws-cli/2.9.12 Python/3.9.11 Darwin/21.6.0 exe/x86_64 prompt/off command/codecatalyst.get-workflow
Content-Type: application/json
Authorization: Bearer AKIAI44QH8DHBEXAMPLE

{}

Sample Response


200 OK 642b
Content-Type: application/json; charset=utf-8
Date: Tue, 01 Aug 2023 19:31:23 GMT


{
   "spaceName": "ExampleCorp",
   "projectName": "MyDemoProject",
   "name": "MyDemoWorkflow",
   "sourceRepository": {
        "name": "MyDemoRepo",
        "defaultBranch": "main",
        "metadata": null
    },
    "sourceBranch": {
        "branchName": "refs/heads/main",
        "headCommitId": "12345678EXAMPLE"
    },
    "definition": {
        "definition": "...",
        "path": ".codecatalyst/workflows/MyDemoWorkflow.yaml",
        "format": "YAML"
    },
    "createdTime": "2022-10-27T22:34:57.734Z",
    "lastUpdatedTime": "2022-10-31T16:48:35.623Z"
    "runMode": "QUEUED",
    "status": "ACTIVE"
    "latestRuns": {
        "items": [
            {
                "workflowVersion": 1,
                "id": "example-workflow-run-id-123abc"
            }
        ]
    }
}