Amazon CodeDeploy Deployments API
Operations for creating and monitoring deployments
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-codedeploy-deployments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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 CodeDeploy Deployments API
description: AWS CodeDeploy is a fully managed deployment service that automates software deployments to a variety of compute services such as Amazon EC2, AWS Fargate, AWS Lambda, and your on-premises servers. CodeDeploy makes it easier to rapidly release new features, helps you avoid downtime during deployment, and handles the complexity of updating your applications.
version: '2014-10-06'
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://codedeploy.{region}.amazonaws.com
description: Amazon CodeDeploy Regional Endpoint
variables:
region:
default: us-east-1
description: AWS Region
tags:
- name: Deployments
description: Operations for creating and monitoring deployments
paths:
/deployments:
post:
operationId: CreateDeployment
summary: Amazon CodeDeploy Create a Deployment
description: Deploys an application revision through the specified deployment group.
tags:
- Deployments
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDeploymentRequest'
examples:
CreateDeploymentRequestExample:
summary: Default CreateDeployment request
x-microcks-default: true
value:
applicationName: example-resource
deploymentGroupName: example-resource
revision:
revisionType: S3
s3Location:
bucket: example-value
key: example-value
bundleType: tar
gitHubLocation:
repository: example-value
commitId: '500123'
description: Example description
autoRollbackConfiguration:
enabled: true
events:
- DEPLOYMENT_FAILURE
responses:
'200':
description: Deployment created
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDeploymentResponse'
examples:
CreateDeployment200Example:
summary: Default CreateDeployment 200 response
x-microcks-default: true
value:
deploymentId: '500123'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentGroupNameException'
examples:
CreateDeployment400Example:
summary: Default CreateDeployment 400 response
x-microcks-default: true
value:
message: example-value
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
CreateDeployment500Example:
summary: Default CreateDeployment 500 response
x-microcks-default: true
value:
message: example-value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: ListDeployments
summary: Amazon CodeDeploy List Deployments
description: Lists the deployments in a deployment group for an application registered with the user or AWS account.
tags:
- Deployments
parameters:
- name: applicationName
in: query
description: The name of the application.
schema:
type: string
- name: deploymentGroupName
in: query
description: The name of the deployment group.
schema:
type: string
- name: nextToken
in: query
description: Token for pagination.
schema:
type: string
- name: includeOnlyStatuses
in: query
description: Filter by deployment status.
schema:
type: array
items:
type: string
enum:
- Created
- Queued
- InProgress
- Baking
- Succeeded
- Failed
- Stopped
- Ready
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListDeploymentsResponse'
examples:
ListDeployments200Example:
summary: Default ListDeployments 200 response
x-microcks-default: true
value:
deployments:
- example-value
nextToken: example-value
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidApplicationNameException'
examples:
ListDeployments400Example:
summary: Default ListDeployments 400 response
x-microcks-default: true
value:
message: example-value
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListDeployments500Example:
summary: Default ListDeployments 500 response
x-microcks-default: true
value:
message: example-value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/deployments/{deploymentId}:
get:
operationId: GetDeployment
summary: Amazon CodeDeploy Get Deployment Details
description: Gets information about a deployment, including details about the deployment status.
tags:
- Deployments
parameters:
- name: deploymentId
in: path
required: true
description: The unique ID of a deployment.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetDeploymentResponse'
examples:
GetDeployment200Example:
summary: Default GetDeployment 200 response
x-microcks-default: true
value:
deploymentInfo:
deploymentId: '500123'
applicationName: example-resource
deploymentGroupName: example-resource
status: Created
createTime: example-value
startTime: example-value
completeTime: example-value
description: Example description
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentIdException'
examples:
GetDeployment400Example:
summary: Default GetDeployment 400 response
x-microcks-default: true
value:
message: example-value
'404':
description: Deployment not found
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentDoesNotExistException'
examples:
GetDeployment404Example:
summary: Default GetDeployment 404 response
x-microcks-default: true
value:
message: example-value
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
GetDeployment500Example:
summary: Default GetDeployment 500 response
x-microcks-default: true
value:
message: example-value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
CreateDeploymentRequest:
type: object
required:
- applicationName
- deploymentGroupName
properties:
applicationName:
type: string
description: The name of the application.
deploymentGroupName:
type: string
description: The name of the deployment group.
revision:
type: object
properties:
revisionType:
type: string
enum:
- S3
- GitHub
- String
- AppSpecContent
s3Location:
type: object
properties:
bucket:
type: string
key:
type: string
bundleType:
type: string
enum:
- tar
- tgz
- zip
- YAML
- JSON
gitHubLocation:
type: object
properties:
repository:
type: string
commitId:
type: string
description:
type: string
description: A comment about the deployment.
autoRollbackConfiguration:
type: object
properties:
enabled:
type: boolean
events:
type: array
items:
type: string
enum:
- DEPLOYMENT_FAILURE
- DEPLOYMENT_STOP_ON_ALARM
- DEPLOYMENT_STOP_ON_REQUEST
InvalidDeploymentIdException:
type: object
properties:
message:
type: string
GetDeploymentResponse:
type: object
properties:
deploymentInfo:
type: object
properties:
deploymentId:
type: string
applicationName:
type: string
deploymentGroupName:
type: string
status:
type: string
enum:
- Created
- Queued
- InProgress
- Baking
- Succeeded
- Failed
- Stopped
- Ready
createTime:
type: string
format: date-time
startTime:
type: string
format: date-time
completeTime:
type: string
format: date-time
description:
type: string
creator:
type: string
computePlatform:
type: string
InternalServerException:
type: object
properties:
message:
type: string
InvalidDeploymentGroupNameException:
type: object
properties:
message:
type: string
CreateDeploymentResponse:
type: object
properties:
deploymentId:
type: string
DeploymentDoesNotExistException:
type: object
properties:
message:
type: string
ListDeploymentsResponse:
type: object
properties:
deployments:
type: array
items:
type: string
nextToken:
type: string
InvalidApplicationNameException:
type: object
properties:
message:
type: string
externalDocs:
description: Amazon CodeDeploy API Reference
url: https://docs.aws.amazon.com/codedeploy/latest/APIReference/