How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API

The #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API from Amazon CodeDeploy — 1 operation(s) for #x amz target=codedeploy 20141006.batchgetdeploymentgroups.

Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API is one of 49 APIs that Amazon CodeDeploy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://codedeploy.{region}.amazonaws.com, https://codedeploy.{region}.amazonaws.com, http://codedeploy.{region}.amazonaws.com.cn, https://codedeploy.{region}.amazonaws.com.cn.

1 operations 1 paths 96 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://codedeploy.us-east-1.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups 1
POST
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentGroups
Amazon CodeDeploy Batch Get Deployment Groups
BatchGetDeploymentGroups 8 params body → 200480481482483484485486

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are DeploymentGroupInfo (22 properties), S3Location (5 properties), RevisionLocation (5 properties), LastDeploymentInfo (4 properties). Each schema is shown below with its type and property counts.

DeploymentStatus
string
Alarm
object
Information about an alarm.
1 property
TagFilter
object
Information about an on-premises instance tag filter.
3 properties
TriggerEventTypeList
array
EC2TagSetList
array
TriggerEventType
string
TargetGroupName
string
DeploymentGroupInfo
object
Information about a deployment group.
22 properties
Timestamp
string
TagFilterList
array
ELBInfoList
array
RevisionLocationType
string
ApplicationNameRequiredException
TagFilterType
string
ListenerArn
string
AutoRollbackEventsList
array
LoadBalancerInfo
object
Information about the Elastic Load Balancing load balancer or target group used in a deployment.
3 properties
AutoScalingGroupName
string
InstanceAction
string
EC2TagFilter
object
Information about an EC2 tag filter.
3 properties
Key
string
ELBName
string
TriggerName
string
Repository
string
TrafficRoute
object
Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group.
1 property
S3Location
object
Information about the location of application artifacts stored in Amazon S3.
5 properties
S3Bucket
string
AlarmName
string
DeploymentReadyOption
object
Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
2 properties
TriggerConfigList
array
BundleType
string
S3Key
string
ApplicationDoesNotExistException
DeploymentGroupInfoList
array
Role
string
GreenFleetProvisioningOption
object
Information about the instances that belong to the replacement environment in a blue/green deployment.
1 property
DeploymentId
string
RevisionLocation
object
Information about the location of an application revision.
5 properties
BlueGreenDeploymentConfiguration
object
Information about blue/green deployment options for a deployment group.
3 properties
DeploymentStyle
object
Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
2 properties
OutdatedInstancesStrategy
string
InvalidApplicationNameException
AutoRollbackConfiguration
object
Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successful…
2 properties
BatchLimitExceededException
DeploymentConfigName
string
GreenFleetProvisioningAction
string
ListenerArnList
array
DeploymentGroupName
string
ETag
string
DeploymentConfigDoesNotExistException
CommitId
string
AutoRollbackEvent
string
ComputePlatform
string
ELBInfo
object
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is rout…
1 property
RawStringSha256
string
AutoScalingGroup
object
Information about an Auto Scaling group.
2 properties
TriggerTargetArn
string
AutoScalingGroupList
array
DeploymentGroupsList
array
EC2TagFilterType
string
EC2TagSet
object
Information about groups of Amazon EC2 instance tags.
1 property
GitHubLocation
object
Information about the location of application artifacts stored in GitHub.
2 properties
ECSServiceList
array
ErrorMessage
string
EC2TagFilterList
array
InvalidDeploymentGroupNameException
TargetGroupPairInfo
object
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
3 properties
OnPremisesTagSetList
array
TargetGroupInfo
object
Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed…
1 property
AppSpecContent
object
A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the…
2 properties
VersionId
string
Value
string
DeploymentGroupId
string
AutoScalingGroupHook
string
AlarmList
array
DeploymentGroupNameRequiredException
LastDeploymentInfo
object
Information about the most recent attempted or successful deployment to a deployment group.
4 properties
RawStringContent
string
DeploymentOption
string
Boolean
boolean
ApplicationName
string
ECSClusterName
string
DeploymentType
string
Duration
integer
BatchGetDeploymentGroupsInput
object
Represents the input of a BatchGetDeploymentGroups operation.
2 properties 2 required
BlueInstanceTerminationOption
object
Information about whether instances in the original environment are terminated when a blue/green deployment is successful. BlueInstanceTerminationOption does n…
2 properties
TargetGroupPairInfoList
array
ECSServiceName
string
DeploymentReadyAction
string
OnPremisesTagSet
object
Information about groups of on-premises instance tags.
1 property
AlarmConfiguration
object
Information about alarms associated with a deployment or deployment group.
3 properties
ECSService
object
Contains the service and cluster names used to identify an Amazon ECS deployment's target.
2 properties
TargetGroupInfoList
array
RawString
object
A revision for an Lambda deployment that is a YAML-formatted or JSON-formatted string. For Lambda deployments, the revision is the same as the AppSpec file.Raw…
2 properties
BatchGetDeploymentGroupsOutput
object
Represents the output of a BatchGetDeploymentGroups operation.
2 properties
TriggerConfig
object
Information about notification triggers for the deployment group.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-codedeploy-x-amz-target-codedeploy-20141006-batchgetdeploymentgroups-api-openapi.yml Raw ↑

Other APIs Amazon CodeDeploy publishes across the network.

Amazon CodeDeploy Applications API
Amazon CodeDeploy Deployments API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.AddTagsToOnPremisesInstances API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetApplicationRevisions API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetApplications API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentInstances API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeployments API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentTargets API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetOnPremisesInstances API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.ContinueDeployment API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.CreateApplication API
Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.CreateDeployment API
Where this information came from

This is an independent, third-party profile of Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.