Amazon CodeCatalyst Codecatalyst Operations API
The Codecatalyst Operations API from Amazon CodeCatalyst — 9 operation(s) for codecatalyst operations.
The Codecatalyst Operations API from Amazon CodeCatalyst — 9 operation(s) for codecatalyst operations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-codecatalyst:amazon-codecatalyst-operations-api"
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.
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: 3.2.0
info:
title: Amazon CodeCatalyst Operations API
version: '2022-09-28'
description: Generated from AWS's published Smithy model for Amazon CodeCatalyst. 9 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: Operations
paths:
/v1/spaces/{spaceName}/projects/{projectName}/workflows/{id}:
get:
operationId: GetWorkflow
summary: Get Workflow
description: Returns information about a workflow.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowResponse'
'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/GetWorkflowRequest'
tags:
- Operations
/v1/spaces/{spaceName}/projects/{projectName}/workflows:
post:
operationId: ListWorkflows
summary: List Workflows
description: Retrieves a list of workflows in a specified project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowsResponse'
'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/ListWorkflowsRequest'
tags:
- Operations
components:
schemas:
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
WorkflowDefinitionSummary:
type: object
properties:
path:
type: string
description: The path to the workflow definition file stored in the source repository for the project, including the file name.
required:
- path
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
ConflictException:
type: object
properties:
message:
type: string
required:
- message
WorkflowSortCriteria:
type: object
properties: {}
GetWorkflowRequest:
type: object
properties:
spaceName:
type: string
description: The name of the space.
id:
type: string
description: The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.
projectName:
type: string
description: The name of the project in the space.
required:
- spaceName
- id
- projectName
ListWorkflowsRequest:
type: object
properties:
spaceName:
type: string
description: The name of the space.
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/WorkflowSortCriteria'
description: Information used to sort the items in the returned list.
required:
- spaceName
- projectName
GetWorkflowResponse:
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.
name:
type: string
description: The name of the workflow.
sourceRepositoryName:
type: string
description: The name of the source repository where the workflow YAML is stored.
sourceBranchName:
type: string
description: The name of the branch that contains the workflow YAML.
definition:
$ref: '#/components/schemas/WorkflowDefinition'
createdTime:
type: string
format: date-time
description: The date and time the workflow was created, 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
runMode:
type: string
description: 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.
status:
type: string
description: The status of the workflow.
required:
- spaceName
- projectName
- id
- name
- definition
- createdTime
- lastUpdatedTime
- runMode
- status
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
ValidationException:
type: object
properties:
message:
type: string
required:
- message
WorkflowDefinition:
type: object
properties:
path:
type: string
description: The path to the workflow definition file stored in the source repository for the project, including the file name.
required:
- path
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
required:
- message
WorkflowSummary:
type: object
properties:
id:
type: string
description: The system-generated unique ID of a workflow.
name:
type: string
description: The name of the workflow.
sourceRepositoryName:
type: string
description: The name of the source repository where the workflow definition file is stored.
sourceBranchName:
type: string
description: The name of the branch of the source repository where the workflow definition file is stored.
definition:
$ref: '#/components/schemas/WorkflowDefinitionSummary'
createdTime:
type: string
format: date-time
description: The date and time the workflow was created, 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
runMode:
type: string
description: The run mode of the workflow.
status:
type: string
description: The status of the workflow.
required:
- id
- name
- sourceRepositoryName
- sourceBranchName
- definition
- createdTime
- lastUpdatedTime
- runMode
- status
ListWorkflowsResponse:
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/WorkflowSummary'
description: Information about the workflows in a project.
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)