Amazon CodeCatalyst Codecatalyst Workflowruns API
The Codecatalyst Workflowruns API from Amazon CodeCatalyst — 2 operation(s) for codecatalyst workflowruns.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-codecatalyst:amazon-codecatalyst-workflowruns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon CodeCatalyst Workflowruns API
version: '2022-09-28'
description: Generated from AWS's published Smithy model for Amazon CodeCatalyst. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://codecatalyst.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Workflowruns
paths:
/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns:
put:
operationId: StartWorkflowRun
summary: Start Workflow Run
description: Begins a run of a specified workflow.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartWorkflowRunResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartWorkflowRunRequest'
tags:
- Workflowruns
post:
operationId: ListWorkflowRuns
summary: List Workflow Runs
description: Retrieves a list of workflow runs of a specified workflow.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowRunsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowRunsRequest'
tags:
- Workflowruns
/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns/{id}:
get:
operationId: GetWorkflowRun
summary: Get Workflow Run
description: Returns information about a specified run of a workflow.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowRunResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowRunRequest'
tags:
- Workflowruns
components:
schemas:
ListWorkflowRunsRequest:
type: object
properties:
spaceName:
type: string
description: The name of the space.
workflowId:
type: string
description: The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
projectName:
type: string
description: The name of the project in the space.
nextToken:
type: string
description: A token returned from a call to this API to indicate the next batch of results to return, if any.
maxResults:
type: integer
description: The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
sortBy:
type: array
items:
$ref: '#/components/schemas/WorkflowRunSortCriteria'
description: Information used to sort the items in the returned list.
required:
- spaceName
- projectName
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
required:
- message
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
GetWorkflowRunRequest:
type: object
properties:
spaceName:
type: string
description: The name of the space.
id:
type: string
description: The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.
projectName:
type: string
description: The name of the project in the space.
required:
- spaceName
- id
- projectName
WorkflowRunStatusReason:
type: object
properties: {}
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
WorkflowRunSortCriteria:
type: object
properties: {}
ConflictException:
type: object
properties:
message:
type: string
required:
- message
WorkflowRunSummary:
type: object
properties:
id:
type: string
description: The system-generated unique ID of the workflow run.
workflowId:
type: string
description: The system-generated unique ID of the workflow.
workflowName:
type: string
description: The name of the workflow.
status:
type: string
description: The status of the workflow run.
statusReasons:
type: array
items:
$ref: '#/components/schemas/WorkflowRunStatusReason'
description: The reasons for the workflow run status.
startTime:
type: string
format: date-time
description: The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
endTime:
type: string
format: date-time
description: The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
lastUpdatedTime:
type: string
format: date-time
description: The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
required:
- id
- workflowId
- workflowName
- status
- startTime
- lastUpdatedTime
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
ValidationException:
type: object
properties:
message:
type: string
required:
- message
StartWorkflowRunResponse:
type: object
properties:
spaceName:
type: string
description: The name of the space.
projectName:
type: string
description: The name of the project in the space.
id:
type: string
description: The system-generated unique ID of the workflow run.
workflowId:
type: string
description: The system-generated unique ID of the workflow.
required:
- spaceName
- projectName
- id
- workflowId
StartWorkflowRunRequest:
type: object
properties:
spaceName:
type: string
description: The name of the space.
projectName:
type: string
description: The name of the project in the space.
workflowId:
type: string
description: The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
clientToken:
type: string
description: 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.
required:
- spaceName
- projectName
- workflowId
ListWorkflowRunsResponse:
type: object
properties:
nextToken:
type: string
description: A token returned from a call to this API to indicate the next batch of results to return, if any.
items:
type: array
items:
$ref: '#/components/schemas/WorkflowRunSummary'
description: Information about the runs of a workflow.
GetWorkflowRunResponse:
type: object
properties:
spaceName:
type: string
description: The name of the space.
projectName:
type: string
description: The name of the project in the space.
id:
type: string
description: The ID of the workflow run.
workflowId:
type: string
description: The ID of the workflow.
status:
type: string
description: The status of the workflow run.
statusReasons:
type: array
items:
$ref: '#/components/schemas/WorkflowRunStatusReason'
description: Information about the reasons for the status of the workflow run.
startTime:
type: string
format: date-time
description: The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
endTime:
type: string
format: date-time
description: The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
lastUpdatedTime:
type: string
format: date-time
description: The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
required:
- spaceName
- projectName
- id
- workflowId
- status
- startTime
- lastUpdatedTime
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: codecatalyst
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/codecatalyst/service/2022-09-28/codecatalyst-2022-09-28.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)