The #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API from Amazon CodeDeploy — 1 operation(s) for #x amz target=codedeploy 20141006.batchgetdeploymentgroups.
openapi: 3.0.0
info:
version: '2014-10-06'
x-release: v4
title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups API'
description: '<p>CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.</p> <p>CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.</p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.</p> <p> <b>CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a> </p> </li> <li> <p> <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">CodeDeploy Developer Forum</a> </p> </li> </ul>'
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codedeploy
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codedeploy-2014-10-06.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codedeploy.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeDeploy multi-region endpoint
- url: https://codedeploy.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeDeploy multi-region endpoint
- url: http://codedeploy.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia)
- url: https://codedeploy.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups'
paths:
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentGroups:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: BatchGetDeploymentGroups
description: Gets information about one or more deployment groups.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDeploymentGroupsOutput'
examples:
BatchGetDeploymentGroups200Example:
summary: Default BatchGetDeploymentGroups 200 response
x-microcks-default: true
value:
deploymentGroupsInfo: example-value
errorMessage: example-value
'480':
description: ApplicationNameRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationNameRequiredException'
examples:
BatchGetDeploymentGroups480Example:
summary: Default BatchGetDeploymentGroups 480 response
x-microcks-default: true
value: example-value
'481':
description: InvalidApplicationNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidApplicationNameException'
examples:
BatchGetDeploymentGroups481Example:
summary: Default BatchGetDeploymentGroups 481 response
x-microcks-default: true
value: example-value
'482':
description: ApplicationDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDoesNotExistException'
examples:
BatchGetDeploymentGroups482Example:
summary: Default BatchGetDeploymentGroups 482 response
x-microcks-default: true
value: example-value
'483':
description: DeploymentGroupNameRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGroupNameRequiredException'
examples:
BatchGetDeploymentGroups483Example:
summary: Default BatchGetDeploymentGroups 483 response
x-microcks-default: true
value: example-value
'484':
description: InvalidDeploymentGroupNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentGroupNameException'
examples:
BatchGetDeploymentGroups484Example:
summary: Default BatchGetDeploymentGroups 484 response
x-microcks-default: true
value: example-value
'485':
description: BatchLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/BatchLimitExceededException'
examples:
BatchGetDeploymentGroups485Example:
summary: Default BatchGetDeploymentGroups 485 response
x-microcks-default: true
value: example-value
'486':
description: DeploymentConfigDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentConfigDoesNotExistException'
examples:
BatchGetDeploymentGroups486Example:
summary: Default BatchGetDeploymentGroups 486 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDeploymentGroupsInput'
examples:
BatchGetDeploymentGroupsRequestExample:
summary: Default BatchGetDeploymentGroups request
x-microcks-default: true
value:
applicationName: example-resource
deploymentGroupNames: example-resource
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.BatchGetDeploymentGroups
summary: Amazon CodeDeploy Batch Get Deployment Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeDeploy 20141006.BatchGetDeploymentGroups'
components:
schemas:
OutdatedInstancesStrategy:
type: string
enum:
- UPDATE
- IGNORE
EC2TagFilter:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/Key'
- description: The tag filter key.
Value:
allOf:
- $ref: '#/components/schemas/Value'
- description: The tag filter value.
Type:
allOf:
- $ref: '#/components/schemas/EC2TagFilterType'
- description: '<p>The tag filter type:</p> <ul> <li> <p> <code>KEY_ONLY</code>: Key only.</p> </li> <li> <p> <code>VALUE_ONLY</code>: Value only.</p> </li> <li> <p> <code>KEY_AND_VALUE</code>: Key and value.</p> </li> </ul>'
description: Information about an EC2 tag filter.
Alarm:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/AlarmName'
- description: The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
description: Information about an alarm.
TargetGroupInfo:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/TargetGroupName'
- description: 'For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. '
description: 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 to the target group.
OnPremisesTagSetList:
type: array
items:
$ref: '#/components/schemas/TagFilterList'
AutoRollbackEventsList:
type: array
items:
$ref: '#/components/schemas/AutoRollbackEvent'
AppSpecContent:
type: object
properties:
content:
allOf:
- $ref: '#/components/schemas/RawStringContent'
- description: <p> The YAML-formatted or JSON-formatted revision string. </p> <p> For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. </p> <p> For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. </p> <p> For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as <code>BeforeInstall</code>, during a deployment. </p>
sha256:
allOf:
- $ref: '#/components/schemas/RawStringSha256'
- description: ' The SHA256 hash value of the revision content. '
description: ' 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 same as the AppSpec file. This method replaces the deprecated <code>RawString</code> data type. '
GitHubLocation:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/Repository'
- description: <p>The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. </p> <p>Specified as account/repository.</p>
commitId:
allOf:
- $ref: '#/components/schemas/CommitId'
- description: The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
description: Information about the location of application artifacts stored in GitHub.
RevisionLocation:
type: object
properties:
revisionType:
allOf:
- $ref: '#/components/schemas/RevisionLocationType'
- description: '<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (Lambda deployments only).</p> </li> <li> <p>AppSpecContent: An <code>AppSpecContent</code> object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.</p> </li> </ul>'
s3Location:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: 'Information about the location of a revision stored in Amazon S3. '
gitHubLocation:
allOf:
- $ref: '#/components/schemas/GitHubLocation'
- description: Information about the location of application artifacts stored in GitHub.
string:
allOf:
- $ref: '#/components/schemas/RawString'
- description: Information about the location of an Lambda deployment revision stored as a RawString.
appSpecContent:
allOf:
- $ref: '#/components/schemas/AppSpecContent'
- description: ' The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString. '
description: Information about the location of an application revision.
ListenerArnList:
type: array
items:
$ref: '#/components/schemas/ListenerArn'
RawString:
type: object
deprecated: true
properties:
content:
allOf:
- $ref: '#/components/schemas/RawStringContent'
- description: The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.
sha256:
allOf:
- $ref: '#/components/schemas/RawStringSha256'
- description: The SHA256 hash value of the revision content.
description: 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.RawString and String revision type are deprecated, use AppSpecContent type instead.
S3Key:
type: string
AutoRollbackConfiguration:
type: object
properties:
enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether a defined automatic rollback configuration is currently enabled.
events:
allOf:
- $ref: '#/components/schemas/AutoRollbackEventsList'
- description: The event type or types that trigger a rollback.
description: Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.
Value:
type: string
LoadBalancerInfo:
type: object
properties:
elbInfoList:
allOf:
- $ref: '#/components/schemas/ELBInfoList'
- description: <p>An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p> <note> <p> Adding more than one load balancer to the array is not supported. </p> </note>
targetGroupInfoList:
allOf:
- $ref: '#/components/schemas/TargetGroupInfoList'
- description: <p>An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.</p> <note> <p> Adding more than one target group to the array is not supported. </p> </note>
targetGroupPairInfoList:
allOf:
- $ref: '#/components/schemas/TargetGroupPairInfoList'
- description: ' The target group pair information. This is an array of <code>TargeGroupPairInfo</code> objects with a maximum size of one. '
description: Information about the Elastic Load Balancing load balancer or target group used in a deployment.
AutoScalingGroupName:
type: string
AutoRollbackEvent:
type: string
enum:
- DEPLOYMENT_FAILURE
- DEPLOYMENT_STOP_ON_ALARM
- DEPLOYMENT_STOP_ON_REQUEST
EC2TagSetList:
type: array
items:
$ref: '#/components/schemas/EC2TagFilterList'
TargetGroupInfoList:
type: array
items:
$ref: '#/components/schemas/TargetGroupInfo'
BundleType:
type: string
enum:
- tar
- tgz
- zip
- YAML
- JSON
AutoScalingGroupList:
type: array
items:
$ref: '#/components/schemas/AutoScalingGroup'
BlueInstanceTerminationOption:
type: object
properties:
action:
allOf:
- $ref: '#/components/schemas/InstanceAction'
- description: '<p>The action to take on instances in the original environment after a successful blue/green deployment.</p> <ul> <li> <p> <code>TERMINATE</code>: Instances are terminated after a specified wait time.</p> </li> <li> <p> <code>KEEP_ALIVE</code>: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.</p> </li> </ul>'
terminationWaitTimeInMinutes:
allOf:
- $ref: '#/components/schemas/Duration'
- description: <p>For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.</p> <p> For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. </p> <p> The maximum setting is 2880 minutes (2 days). </p>
description: 'Information about whether instances in the original environment are terminated when a blue/green deployment is successful. <code>BlueInstanceTerminationOption</code> does not apply to Lambda deployments. '
EC2TagFilterList:
type: array
items:
$ref: '#/components/schemas/EC2TagFilter'
Timestamp:
type: string
format: date-time
EC2TagSet:
type: object
properties:
ec2TagSetList:
allOf:
- $ref: '#/components/schemas/EC2TagSetList'
- description: A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
description: Information about groups of Amazon EC2 instance tags.
ECSClusterName:
type: string
ELBInfo:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ELBName'
- description: For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
description: 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 routed to the load balancer.
DeploymentReadyAction:
type: string
enum:
- CONTINUE_DEPLOYMENT
- STOP_DEPLOYMENT
TriggerTargetArn:
type: string
ELBInfoList:
type: array
items:
$ref: '#/components/schemas/ELBInfo'
GreenFleetProvisioningOption:
type: object
properties:
action:
allOf:
- $ref: '#/components/schemas/GreenFleetProvisioningAction'
- description: '<p>The method used to add instances to a replacement environment.</p> <ul> <li> <p> <code>DISCOVER_EXISTING</code>: Use instances that already exist or will be created manually.</p> </li> <li> <p> <code>COPY_AUTO_SCALING_GROUP</code>: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.</p> </li> </ul>'
description: Information about the instances that belong to the replacement environment in a blue/green deployment.
DeploymentGroupId:
type: string
DeploymentGroupInfo:
type: object
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The application name.
deploymentGroupId:
allOf:
- $ref: '#/components/schemas/DeploymentGroupId'
- description: The deployment group ID.
deploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: The deployment group name.
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: The deployment configuration name.
ec2TagFilters:
allOf:
- $ref: '#/components/schemas/EC2TagFilterList'
- description: The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
onPremisesInstanceTagFilters:
allOf:
- $ref: '#/components/schemas/TagFilterList'
- description: The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
autoScalingGroups:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupList'
- description: A list of associated Auto Scaling groups.
serviceRoleArn:
allOf:
- $ref: '#/components/schemas/Role'
- description: A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html">Create a Service Role for CodeDeploy</a> in the <i>CodeDeploy User Guide</i>.
targetRevision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: Information about the deployment group's target revision, including type and location.
triggerConfigurations:
allOf:
- $ref: '#/components/schemas/TriggerConfigList'
- description: Information about triggers associated with the deployment group.
alarmConfiguration:
allOf:
- $ref: '#/components/schemas/AlarmConfiguration'
- description: A list of alarms associated with the deployment group.
autoRollbackConfiguration:
allOf:
- $ref: '#/components/schemas/AutoRollbackConfiguration'
- description: Information about the automatic rollback configuration associated with the deployment group.
deploymentStyle:
allOf:
- $ref: '#/components/schemas/DeploymentStyle'
- description: 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.
outdatedInstancesStrategy:
allOf:
- $ref: '#/components/schemas/OutdatedInstancesStrategy'
- description: <p>Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.</p> <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.</p> <p>If this option is set to <code>IGNORE</code>, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.</p>
blueGreenDeploymentConfiguration:
allOf:
- $ref: '#/components/schemas/BlueGreenDeploymentConfiguration'
- description: Information about blue/green deployment options for a deployment group.
loadBalancerInfo:
allOf:
- $ref: '#/components/schemas/LoadBalancerInfo'
- description: Information about the load balancer to use in a deployment.
lastSuccessfulDeployment:
allOf:
- $ref: '#/components/schemas/LastDeploymentInfo'
- description: Information about the most recent successful deployment to the deployment group.
lastAttemptedDeployment:
allOf:
- $ref: '#/components/schemas/LastDeploymentInfo'
- description: Information about the most recent attempted deployment to the deployment group.
ec2TagSet:
allOf:
- $ref: '#/components/schemas/EC2TagSet'
- description: Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
onPremisesTagSet:
allOf:
- $ref: '#/components/schemas/OnPremisesTagSet'
- description: Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
computePlatform:
allOf:
- $ref: '#/components/schemas/ComputePlatform'
- description: The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).
ecsServices:
allOf:
- $ref: '#/components/schemas/ECSServiceList'
- description: ' The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code><clustername>:<servicename></code>. '
description: Information about a deployment group.
DeploymentGroupNameRequiredException: {}
InvalidDeploymentGroupNameException: {}
DeploymentGroupName:
type: string
minLength: 1
maxLength: 100
InstanceAction:
type: string
enum:
- TERMINATE
- KEEP_ALIVE
Key:
type: string
TagFilter:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/Key'
- description: The on-premises instance tag filter key.
Value:
allOf:
- $ref: '#/components/schemas/Value'
- description: The on-premises instance tag filter value.
Type:
allOf:
- $ref: '#/components/schemas/TagFilterType'
- description: '<p>The on-premises instance tag filter type:</p> <ul> <li> <p>KEY_ONLY: Key only.</p> </li> <li> <p>VALUE_ONLY: Value only.</p> </li> <li> <p>KEY_AND_VALUE: Key and value.</p> </li> </ul>'
description: Information about an on-premises instance tag filter.
Role:
type: string
GreenFleetProvisioningAction:
type: string
enum:
- DISCOVER_EXISTING
- COPY_AUTO_SCALING_GROUP
LastDeploymentInfo:
type: object
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
status:
allOf:
- $ref: '#/components/schemas/DeploymentStatus'
- description: The status of the most recent deployment.
endTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that indicates when the most recent deployment to the deployment g
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/openapi/amazon-codedeploy-x-amz-target-codedeploy-20141006-batchgetdeploymentgroups-api-openapi.yml