GetWorkflowRunCommand

Suggest an Edit

Returns information about a specified run of a workflow.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CodeCatalystClient, GetWorkflowRunCommand } from "@aws-sdk/client-codecatalyst"; // ES Modules import
// const { CodeCatalystClient, GetWorkflowRunCommand } = require("@aws-sdk/client-codecatalyst"); // CommonJS import
const client = new CodeCatalystClient(config);
const input = { // GetWorkflowRunRequest
  spaceName: "STRING_VALUE", // required
  id: "STRING_VALUE", // required
  projectName: "STRING_VALUE", // required
};
const command = new GetWorkflowRunCommand(input);
const response = await client.send(command);
// { // GetWorkflowRunResponse
//   spaceName: "STRING_VALUE", // required
//   projectName: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   workflowId: "STRING_VALUE", // required
//   status: "STRING_VALUE", // required
//   statusReasons: [ // WorkflowRunStatusReasons
//     {},
//   ],
//   startTime: new Date("TIMESTAMP"), // required
//   endTime: new Date("TIMESTAMP"),
//   lastUpdatedTime: new Date("TIMESTAMP"), // required
// };

GetWorkflowRunCommand Input

See GetWorkflowRunCommandInput for more details

Parameter
Type
Description
id
Required
string | undefined

The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.

projectName
Required
string | undefined

The name of the project in the space.

spaceName
Required
string | undefined

The name of the space.

GetWorkflowRunCommand Output

See GetWorkflowRunCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
id
Required
string | undefined

The ID of the workflow run.

lastUpdatedTime
Required
Date | undefined

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

projectName
Required
string | undefined

The name of the project in the space.

spaceName
Required
string | undefined

The name of the space.

startTime
Required
Date | undefined

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

status
Required
WorkflowRunStatus | undefined

The status of the workflow run.

workflowId
Required
string | undefined

The ID of the workflow.

endTime
Date | undefined

The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 .

statusReasons
WorkflowRunStatusReason[] | undefined

Information about the reasons for the status of the workflow run.

Throws

Name
Fault
Details
AccessDeniedException
client

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.

ConflictException
client

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.

ResourceNotFoundException
client

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.

ServiceQuotaExceededException
client

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.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

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.

CodeCatalystServiceException
Base exception class for all service exceptions from CodeCatalyst service.