openapi: 3.0.0 info: version: '2014-10-06' x-release: v4 title: AWS CodeDeploy description: '
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.
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.
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.
CodeDeploy Components
Use the information in this guide to help you work with the following CodeDeploy components:
Application: 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.
Deployment group: 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.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
Deployment: 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.
Application revisions: 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.
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.
CodeDeploy Information Resources
This method works, but is deprecated. Use BatchGetDeploymentTargets instead.
Returns an array of one or more instances associated with a deployment.
This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be
returned is 25.
Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances.
The maximum number of targets that can be returned is 25.
The type of targets returned depends on the deployment''s compute platform or deployment method:
EC2/On-premises: Information about Amazon EC2 instance targets.
Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
Gets information about a deployment.
The content property of the appSpecContent object in the returned revision is always null. Use
GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.
The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception
if it is used with a compute platform other than EC2/On-premises or Lambda.
Lists the instance for a deployment associated with the IAM user or Amazon Web Services account.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDeploymentInstancesOutput' examples: ListDeploymentInstances200Example: summary: Default ListDeploymentInstances 200 response x-microcks-default: true value: instancesList: example-value nextToken: example-value '480': description: DeploymentIdRequiredException content: application/json: schema: $ref: '#/components/schemas/DeploymentIdRequiredException' examples: ListDeploymentInstances480Example: summary: Default ListDeploymentInstances 480 response x-microcks-default: true value: example-value '481': description: DeploymentDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DeploymentDoesNotExistException' examples: ListDeploymentInstances481Example: summary: Default ListDeploymentInstances 481 response x-microcks-default: true value: example-value '482': description: DeploymentNotStartedException content: application/json: schema: $ref: '#/components/schemas/DeploymentNotStartedException' examples: ListDeploymentInstances482Example: summary: Default ListDeploymentInstances 482 response x-microcks-default: true value: example-value '483': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListDeploymentInstances483Example: summary: Default ListDeploymentInstances 483 response x-microcks-default: true value: example-value '484': description: InvalidDeploymentIdException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentIdException' examples: ListDeploymentInstances484Example: summary: Default ListDeploymentInstances 484 response x-microcks-default: true value: example-value '485': description: InvalidInstanceStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidInstanceStatusException' examples: ListDeploymentInstances485Example: summary: Default ListDeploymentInstances 485 response x-microcks-default: true value: example-value '486': description: InvalidInstanceTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidInstanceTypeException' examples: ListDeploymentInstances486Example: summary: Default ListDeploymentInstances 486 response x-microcks-default: true value: example-value '487': description: InvalidDeploymentInstanceTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentInstanceTypeException' examples: ListDeploymentInstances487Example: summary: Default ListDeploymentInstances 487 response x-microcks-default: true value: example-value '488': description: InvalidTargetFilterNameException content: application/json: schema: $ref: '#/components/schemas/InvalidTargetFilterNameException' examples: ListDeploymentInstances488Example: summary: Default ListDeploymentInstances 488 response x-microcks-default: true value: example-value '489': description: InvalidComputePlatformException content: application/json: schema: $ref: '#/components/schemas/InvalidComputePlatformException' examples: ListDeploymentInstances489Example: summary: Default ListDeploymentInstances 489 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDeploymentInstancesInput' examples: ListDeploymentInstancesRequestExample: summary: Default ListDeploymentInstances request x-microcks-default: true value: deploymentId: '500123' nextToken: example-value instanceStatusFilter: ACTIVE instanceTypeFilter: STANDARD parameters: - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.ListDeploymentInstances summary: Amazon CodeDeploy List Deployment Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeDeploy_20141006.ListDeploymentTargets: post: operationId: ListDeploymentTargets description: ' Returns an array of target IDs that are associated a deployment. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDeploymentTargetsOutput' examples: ListDeploymentTargets200Example: summary: Default ListDeploymentTargets 200 response x-microcks-default: true value: targetIds: '500123' nextToken: example-value '480': description: DeploymentIdRequiredException content: application/json: schema: $ref: '#/components/schemas/DeploymentIdRequiredException' examples: ListDeploymentTargets480Example: summary: Default ListDeploymentTargets 480 response x-microcks-default: true value: example-value '481': description: DeploymentDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DeploymentDoesNotExistException' examples: ListDeploymentTargets481Example: summary: Default ListDeploymentTargets 481 response x-microcks-default: true value: example-value '482': description: DeploymentNotStartedException content: application/json: schema: $ref: '#/components/schemas/DeploymentNotStartedException' examples: ListDeploymentTargets482Example: summary: Default ListDeploymentTargets 482 response x-microcks-default: true value: example-value '483': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListDeploymentTargets483Example: summary: Default ListDeploymentTargets 483 response x-microcks-default: true value: example-value '484': description: InvalidDeploymentIdException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentIdException' examples: ListDeploymentTargets484Example: summary: Default ListDeploymentTargets 484 response x-microcks-default: true value: example-value '485': description: InvalidInstanceStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidInstanceStatusException' examples: ListDeploymentTargets485Example: summary: Default ListDeploymentTargets 485 response x-microcks-default: true value: example-value '486': description: InvalidInstanceTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidInstanceTypeException' examples: ListDeploymentTargets486Example: summary: Default ListDeploymentTargets 486 response x-microcks-default: true value: example-value '487': description: InvalidDeploymentInstanceTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentInstanceTypeException' examples: ListDeploymentTargets487Example: summary: Default ListDeploymentTargets 487 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDeploymentTargetsInput' examples: ListDeploymentTargetsRequestExample: summary: Default ListDeploymentTargets request x-microcks-default: true value: deploymentId: '500123' nextToken: example-value targetFilters: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.ListDeploymentTargets summary: Amazon CodeDeploy List Deployment Targets x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeDeploy_20141006.ListDeployments: post: operationId: ListDeployments description: Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDeploymentsOutput' examples: ListDeployments200Example: summary: Default ListDeployments 200 response x-microcks-default: true value: deployments: example-value nextToken: example-value '480': description: ApplicationNameRequiredException content: application/json: schema: $ref: '#/components/schemas/ApplicationNameRequiredException' examples: ListDeployments480Example: summary: Default ListDeployments 480 response x-microcks-default: true value: example-value '481': description: InvalidApplicationNameException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationNameException' examples: ListDeployments481Example: summary: Default ListDeployments 481 response x-microcks-default: true value: example-value '482': description: ApplicationDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/ApplicationDoesNotExistException' examples: ListDeployments482Example: summary: Default ListDeployments 482 response x-microcks-default: true value: example-value '483': description: InvalidDeploymentGroupNameException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentGroupNameException' examples: ListDeployments483Example: summary: Default ListDeployments 483 response x-microcks-default: true value: example-value '484': description: DeploymentGroupDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DeploymentGroupDoesNotExistException' examples: ListDeployments484Example: summary: Default ListDeployments 484 response x-microcks-default: true value: example-value '485': description: DeploymentGroupNameRequiredException content: application/json: schema: $ref: '#/components/schemas/DeploymentGroupNameRequiredException' examples: ListDeployments485Example: summary: Default ListDeployments 485 response x-microcks-default: true value: example-value '486': description: InvalidTimeRangeException content: application/json: schema: $ref: '#/components/schemas/InvalidTimeRangeException' examples: ListDeployments486Example: summary: Default ListDeployments 486 response x-microcks-default: true value: example-value '487': description: InvalidDeploymentStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentStatusException' examples: ListDeployments487Example: summary: Default ListDeployments 487 response x-microcks-default: true value: example-value '488': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListDeployments488Example: summary: Default ListDeployments 488 response x-microcks-default: true value: example-value '489': description: InvalidExternalIdException content: application/json: schema: $ref: '#/components/schemas/InvalidExternalIdException' examples: ListDeployments489Example: summary: Default ListDeployments 489 response x-microcks-default: true value: example-value '490': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: ListDeployments490Example: summary: Default ListDeployments 490 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDeploymentsInput' examples: ListDeploymentsRequestExample: summary: Default ListDeployments request x-microcks-default: true value: applicationName: example-resource deploymentGroupName: example-resource externalId: '500123' includeOnlyStatuses: ACTIVE createTimeRange: example-value nextToken: example-value parameters: - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.ListDeployments summary: Amazon CodeDeploy List Deployments x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeDeploy_20141006.ListGitHubAccountTokenNames: post: operationId: ListGitHubAccountTokenNames description: Lists the names of stored connections to GitHub accounts. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListGitHubAccountTokenNamesOutput' examples: ListGitHubAccountTokenNames200Example: summary: Default ListGitHubAccountTokenNames 200 response x-microcks-default: true value: tokenNameList: example-resource nextToken: example-value '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListGitHubAccountTokenNames480Example: summary: Default ListGitHubAccountTokenNames 480 response x-microcks-default: true value: example-resource '481': description: ResourceValidationException content: application/json: schema: $ref: '#/components/schemas/ResourceValidationException' examples: ListGitHubAccountTokenNames481Example: summary: Default ListGitHubAccountTokenNames 481 response x-microcks-default: true value: example-resource '482': description: OperationNotSupportedException content: application/json: schema: $ref: '#/components/schemas/OperationNotSupportedException' examples: ListGitHubAccountTokenNames482Example: summary: Default ListGitHubAccountTokenNames 482 response x-microcks-default: true value: example-resource requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListGitHubAccountTokenNamesInput' examples: ListGitHubAccountTokenNamesRequestExample: summary: Default ListGitHubAccountTokenNames request x-microcks-default: true value: nextToken: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.ListGitHubAccountTokenNames summary: Amazon CodeDeploy List Git Hub Account Token Names x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeDeploy_20141006.ListOnPremisesInstances: post: operationId: ListOnPremisesInstances description: 'Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListOnPremisesInstancesOutput' examples: ListOnPremisesInstances200Example: summary: Default ListOnPremisesInstances 200 response x-microcks-default: true value: instanceNames: example-resource nextToken: example-value '480': description: InvalidRegistrationStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidRegistrationStatusException' examples: ListOnPremisesInstances480Example: summary: Default ListOnPremisesInstances 480 response x-microcks-default: true value: example-value '481': description: InvalidTagFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidTagFilterException' examples: ListOnPremisesInstances481Example: summary: Default ListOnPremisesInstances 481 response x-microcks-default: true value: example-value '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListOnPremisesInstances482Example: summary: Default ListOnPremisesInstances 482 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListOnPremisesInstancesInput' examples: ListOnPremisesInstancesRequestExample: summary: Default ListOnPremisesInstances request x-microcks-default: true value: registrationStatus: ACTIVE tagFilters: example-value nextToken: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.ListOnPremisesInstances summary: Amazon CodeDeploy List on Premises Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeDeploy_20141006.ListTagsForResource: post: operationId: ListTagsForResource description: ' Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceOutput' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: Tags: example-value NextToken: example-value '480': description: ArnNotSupportedException content: application/json: schema: $ref: '#/components/schemas/ArnNotSupportedException' examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: example-value '481': description: InvalidArnException content: application/json: schema: $ref: '#/components/schemas/InvalidArnException' examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: example-value '482': description: ResourceArnRequiredException content: application/json: schema: $ref: '#/components/schemas/ResourceArnRequiredException' examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceInput' examples: ListTagsForResourceRequestExample: summary: Default ListTagsForResource request x-microcks-default: true value: ResourceArn: arn:aws:service:us-east-1:123456789012:resource/example NextToken: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.ListTagsForResource summary: Amazon CodeDeploy List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeDeploy_20141006.PutLifecycleEventHookExecutionStatus: post: operationId: PutLifecycleEventHookExecutionStatus description: ' Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks areBeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall, AfterInstall,
AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more
information, see AppSpec ''hooks'' Section for an Lambda Deployment
and AppSpec ''hooks'' Section for an Amazon ECS Deployment.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutLifecycleEventHookExecutionStatusOutput'
examples:
PutLifecycleEventHookExecutionStatus200Example:
summary: Default PutLifecycleEventHookExecutionStatus 200 response
x-microcks-default: true
value:
lifecycleEventHookExecutionId: '500123'
'480':
description: InvalidLifecycleEventHookExecutionStatusException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidLifecycleEventHookExecutionStatusException'
examples:
PutLifecycleEventHookExecutionStatus480Example:
summary: Default PutLifecycleEventHookExecutionStatus 480 response
x-microcks-default: true
value: ACTIVE
'481':
description: InvalidLifecycleEventHookExecutionIdException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidLifecycleEventHookExecutionIdException'
examples:
PutLifecycleEventHookExecutionStatus481Example:
summary: Default PutLifecycleEventHookExecutionStatus 481 response
x-microcks-default: true
value: ACTIVE
'482':
description: LifecycleEventAlreadyCompletedException
content:
application/json:
schema:
$ref: '#/components/schemas/LifecycleEventAlreadyCompletedException'
examples:
PutLifecycleEventHookExecutionStatus482Example:
summary: Default PutLifecycleEventHookExecutionStatus 482 response
x-microcks-default: true
value: ACTIVE
'483':
description: DeploymentIdRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentIdRequiredException'
examples:
PutLifecycleEventHookExecutionStatus483Example:
summary: Default PutLifecycleEventHookExecutionStatus 483 response
x-microcks-default: true
value: ACTIVE
'484':
description: DeploymentDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentDoesNotExistException'
examples:
PutLifecycleEventHookExecutionStatus484Example:
summary: Default PutLifecycleEventHookExecutionStatus 484 response
x-microcks-default: true
value: ACTIVE
'485':
description: InvalidDeploymentIdException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentIdException'
examples:
PutLifecycleEventHookExecutionStatus485Example:
summary: Default PutLifecycleEventHookExecutionStatus 485 response
x-microcks-default: true
value: ACTIVE
'486':
description: UnsupportedActionForDeploymentTypeException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedActionForDeploymentTypeException'
examples:
PutLifecycleEventHookExecutionStatus486Example:
summary: Default PutLifecycleEventHookExecutionStatus 486 response
x-microcks-default: true
value: ACTIVE
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutLifecycleEventHookExecutionStatusInput'
examples:
PutLifecycleEventHookExecutionStatusRequestExample:
summary: Default PutLifecycleEventHookExecutionStatus request
x-microcks-default: true
value:
deploymentId: '500123'
lifecycleEventHookExecutionId: '500123'
status: ACTIVE
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.PutLifecycleEventHookExecutionStatus
summary: Amazon CodeDeploy Put Lifecycle Event Hook Execution Status
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeDeploy_20141006.RegisterApplicationRevision:
post:
operationId: RegisterApplicationRevision
description: Registers with CodeDeploy a revision for the specified application.
responses:
'200':
description: Success
'480':
description: ApplicationDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDoesNotExistException'
examples:
RegisterApplicationRevision480Example:
summary: Default RegisterApplicationRevision 480 response
x-microcks-default: true
value: example-value
'481':
description: ApplicationNameRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationNameRequiredException'
examples:
RegisterApplicationRevision481Example:
summary: Default RegisterApplicationRevision 481 response
x-microcks-default: true
value: example-value
'482':
description: InvalidApplicationNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidApplicationNameException'
examples:
RegisterApplicationRevision482Example:
summary: Default RegisterApplicationRevision 482 response
x-microcks-default: true
value: example-value
'483':
description: DescriptionTooLongException
content:
application/json:
schema:
$ref: '#/components/schemas/DescriptionTooLongException'
examples:
RegisterApplicationRevision483Example:
summary: Default RegisterApplicationRevision 483 response
x-microcks-default: true
value: example-value
'484':
description: RevisionRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/RevisionRequiredException'
examples:
RegisterApplicationRevision484Example:
summary: Default RegisterApplicationRevision 484 response
x-microcks-default: true
value: example-value
'485':
description: InvalidRevisionException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRevisionException'
examples:
RegisterApplicationRevision485Example:
summary: Default RegisterApplicationRevision 485 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterApplicationRevisionInput'
examples:
RegisterApplicationRevisionRequestExample:
summary: Default RegisterApplicationRevision request
x-microcks-default: true
value:
applicationName: example-resource
description: Example description
revision: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.RegisterApplicationRevision
summary: Amazon CodeDeploy Register Application Revision
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance:
post:
operationId: RegisterOnPremisesInstance
description: Registers an on-premises instance.
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
Tags parameter with the resource identified by the ResourceArn input parameter. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceOutput'
examples:
TagResource200Example:
summary: Default TagResource 200 response
x-microcks-default: true
value: {}
'480':
description: ResourceArnRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceArnRequiredException'
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ApplicationDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDoesNotExistException'
examples:
TagResource481Example:
summary: Default TagResource 481 response
x-microcks-default: true
value: example-value
'482':
description: DeploymentGroupDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGroupDoesNotExistException'
examples:
TagResource482Example:
summary: Default TagResource 482 response
x-microcks-default: true
value: example-value
'483':
description: DeploymentConfigDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentConfigDoesNotExistException'
examples:
TagResource483Example:
summary: Default TagResource 483 response
x-microcks-default: true
value: example-value
'484':
description: TagRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/TagRequiredException'
examples:
TagResource484Example:
summary: Default TagResource 484 response
x-microcks-default: true
value: example-value
'485':
description: InvalidTagsToAddException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagsToAddException'
examples:
TagResource485Example:
summary: Default TagResource 485 response
x-microcks-default: true
value: example-value
'486':
description: ArnNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/ArnNotSupportedException'
examples:
TagResource486Example:
summary: Default TagResource 486 response
x-microcks-default: true
value: example-value
'487':
description: InvalidArnException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArnException'
examples:
TagResource487Example:
summary: Default TagResource 487 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceInput'
examples:
TagResourceRequestExample:
summary: Default TagResource request
x-microcks-default: true
value:
ResourceArn: arn:aws:service:us-east-1:123456789012:resource/example
Tags: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.TagResource
summary: Amazon CodeDeploy Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeDeploy_20141006.UntagResource:
post:
operationId: UntagResource
description: ' Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identified by the list of keys in the TagKeys
input parameter. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceOutput'
examples:
UntagResource200Example:
summary: Default UntagResource 200 response
x-microcks-default: true
value: {}
'480':
description: ResourceArnRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceArnRequiredException'
examples:
UntagResource480Example:
summary: Default UntagResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ApplicationDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDoesNotExistException'
examples:
UntagResource481Example:
summary: Default UntagResource 481 response
x-microcks-default: true
value: example-value
'482':
description: DeploymentGroupDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGroupDoesNotExistException'
examples:
UntagResource482Example:
summary: Default UntagResource 482 response
x-microcks-default: true
value: example-value
'483':
description: DeploymentConfigDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentConfigDoesNotExistException'
examples:
UntagResource483Example:
summary: Default UntagResource 483 response
x-microcks-default: true
value: example-value
'484':
description: TagRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/TagRequiredException'
examples:
UntagResource484Example:
summary: Default UntagResource 484 response
x-microcks-default: true
value: example-value
'485':
description: InvalidTagsToAddException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagsToAddException'
examples:
UntagResource485Example:
summary: Default UntagResource 485 response
x-microcks-default: true
value: example-value
'486':
description: ArnNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/ArnNotSupportedException'
examples:
UntagResource486Example:
summary: Default UntagResource 486 response
x-microcks-default: true
value: example-value
'487':
description: InvalidArnException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArnException'
examples:
UntagResource487Example:
summary: Default UntagResource 487 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceInput'
examples:
UntagResourceRequestExample:
summary: Default UntagResource request
x-microcks-default: true
value:
ResourceArn: arn:aws:service:us-east-1:123456789012:resource/example
TagKeys: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.UntagResource
summary: Amazon CodeDeploy Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeDeploy_20141006.UpdateApplication:
post:
operationId: UpdateApplication
description: Changes the name of an application.
responses:
'200':
description: Success
'480':
description: ApplicationNameRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationNameRequiredException'
examples:
UpdateApplication480Example:
summary: Default UpdateApplication 480 response
x-microcks-default: true
value: example-value
'481':
description: InvalidApplicationNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidApplicationNameException'
examples:
UpdateApplication481Example:
summary: Default UpdateApplication 481 response
x-microcks-default: true
value: example-value
'482':
description: ApplicationAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAlreadyExistsException'
examples:
UpdateApplication482Example:
summary: Default UpdateApplication 482 response
x-microcks-default: true
value: example-value
'483':
description: ApplicationDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDoesNotExistException'
examples:
UpdateApplication483Example:
summary: Default UpdateApplication 483 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApplicationInput'
examples:
UpdateApplicationRequestExample:
summary: Default UpdateApplication request
x-microcks-default: true
value:
applicationName: example-resource
newApplicationName: example-resource
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.UpdateApplication
summary: Amazon CodeDeploy Update Application
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeDeploy_20141006.UpdateDeploymentGroup:
post:
operationId: UpdateDeploymentGroup
description: Changes information about a deployment group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDeploymentGroupOutput'
examples:
UpdateDeploymentGroup200Example:
summary: Default UpdateDeploymentGroup 200 response
x-microcks-default: true
value:
hooksNotCleanedUp: example-value
'480':
description: ApplicationNameRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationNameRequiredException'
examples:
UpdateDeploymentGroup480Example:
summary: Default UpdateDeploymentGroup 480 response
x-microcks-default: true
value: example-value
'481':
description: InvalidApplicationNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidApplicationNameException'
examples:
UpdateDeploymentGroup481Example:
summary: Default UpdateDeploymentGroup 481 response
x-microcks-default: true
value: example-value
'482':
description: ApplicationDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDoesNotExistException'
examples:
UpdateDeploymentGroup482Example:
summary: Default UpdateDeploymentGroup 482 response
x-microcks-default: true
value: example-value
'483':
description: InvalidDeploymentGroupNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentGroupNameException'
examples:
UpdateDeploymentGroup483Example:
summary: Default UpdateDeploymentGroup 483 response
x-microcks-default: true
value: example-value
'484':
description: DeploymentGroupAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGroupAlreadyExistsException'
examples:
UpdateDeploymentGroup484Example:
summary: Default UpdateDeploymentGroup 484 response
x-microcks-default: true
value: example-value
'485':
description: DeploymentGroupNameRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGroupNameRequiredException'
examples:
UpdateDeploymentGroup485Example:
summary: Default UpdateDeploymentGroup 485 response
x-microcks-default: true
value: example-value
'486':
description: DeploymentGroupDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGroupDoesNotExistException'
examples:
UpdateDeploymentGroup486Example:
summary: Default UpdateDeploymentGroup 486 response
x-microcks-default: true
value: example-value
'487':
description: InvalidEC2TagException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidEC2TagException'
examples:
UpdateDeploymentGroup487Example:
summary: Default UpdateDeploymentGroup 487 response
x-microcks-default: true
value: example-value
'488':
description: InvalidTagException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagException'
examples:
UpdateDeploymentGroup488Example:
summary: Default UpdateDeploymentGroup 488 response
x-microcks-default: true
value: example-value
'489':
description: InvalidAutoScalingGroupException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidAutoScalingGroupException'
examples:
UpdateDeploymentGroup489Example:
summary: Default UpdateDeploymentGroup 489 response
x-microcks-default: true
value: example-value
'490':
description: InvalidDeploymentConfigNameException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentConfigNameException'
examples:
UpdateDeploymentGroup490Example:
summary: Default UpdateDeploymentGroup 490 response
x-microcks-default: true
value: example-value
'491':
description: DeploymentConfigDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentConfigDoesNotExistException'
examples:
UpdateDeploymentGroup491Example:
summary: Default UpdateDeploymentGroup 491 response
x-microcks-default: true
value: example-value
'492':
description: InvalidRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRoleException'
examples:
UpdateDeploymentGroup492Example:
summary: Default UpdateDeploymentGroup 492 response
x-microcks-default: true
value: example-value
'493':
description: LifecycleHookLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LifecycleHookLimitExceededException'
examples:
UpdateDeploymentGroup493Example:
summary: Default UpdateDeploymentGroup 493 response
x-microcks-default: true
value: example-value
'494':
description: InvalidTriggerConfigException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTriggerConfigException'
examples:
UpdateDeploymentGroup494Example:
summary: Default UpdateDeploymentGroup 494 response
x-microcks-default: true
value: example-value
'495':
description: TriggerTargetsLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerTargetsLimitExceededException'
examples:
UpdateDeploymentGroup495Example:
summary: Default UpdateDeploymentGroup 495 response
x-microcks-default: true
value: example-value
'496':
description: InvalidAlarmConfigException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidAlarmConfigException'
examples:
UpdateDeploymentGroup496Example:
summary: Default UpdateDeploymentGroup 496 response
x-microcks-default: true
value: example-value
'497':
description: AlarmsLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/AlarmsLimitExceededException'
examples:
UpdateDeploymentGroup497Example:
summary: Default UpdateDeploymentGroup 497 response
x-microcks-default: true
value: example-value
'498':
description: InvalidAutoRollbackConfigException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidAutoRollbackConfigException'
examples:
UpdateDeploymentGroup498Example:
summary: Default UpdateDeploymentGroup 498 response
x-microcks-default: true
value: example-value
'499':
description: InvalidLoadBalancerInfoException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidLoadBalancerInfoException'
examples:
UpdateDeploymentGroup499Example:
summary: Default UpdateDeploymentGroup 499 response
x-microcks-default: true
value: example-value
'500':
description: InvalidDeploymentStyleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentStyleException'
examples:
UpdateDeploymentGroup500Example:
summary: Default UpdateDeploymentGroup 500 response
x-microcks-default: true
value: example-value
'501':
description: InvalidBlueGreenDeploymentConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidBlueGreenDeploymentConfigurationException'
examples:
UpdateDeploymentGroup501Example:
summary: Default UpdateDeploymentGroup 501 response
x-microcks-default: true
value: example-value
'502':
description: InvalidEC2TagCombinationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidEC2TagCombinationException'
examples:
UpdateDeploymentGroup502Example:
summary: Default UpdateDeploymentGroup 502 response
x-microcks-default: true
value: example-value
'503':
description: InvalidOnPremisesTagCombinationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidOnPremisesTagCombinationException'
examples:
UpdateDeploymentGroup503Example:
summary: Default UpdateDeploymentGroup 503 response
x-microcks-default: true
value: example-value
'504':
description: TagSetListLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/TagSetListLimitExceededException'
examples:
UpdateDeploymentGroup504Example:
summary: Default UpdateDeploymentGroup 504 response
x-microcks-default: true
value: example-value
'505':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateDeploymentGroup505Example:
summary: Default UpdateDeploymentGroup 505 response
x-microcks-default: true
value: example-value
'506':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
UpdateDeploymentGroup506Example:
summary: Default UpdateDeploymentGroup 506 response
x-microcks-default: true
value: example-value
'507':
description: InvalidECSServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidECSServiceException'
examples:
UpdateDeploymentGroup507Example:
summary: Default UpdateDeploymentGroup 507 response
x-microcks-default: true
value: example-value
'508':
description: InvalidTargetGroupPairException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTargetGroupPairException'
examples:
UpdateDeploymentGroup508Example:
summary: Default UpdateDeploymentGroup 508 response
x-microcks-default: true
value: example-value
'509':
description: ECSServiceMappingLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ECSServiceMappingLimitExceededException'
examples:
UpdateDeploymentGroup509Example:
summary: Default UpdateDeploymentGroup 509 response
x-microcks-default: true
value: example-value
'510':
description: InvalidTrafficRoutingConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTrafficRoutingConfigurationException'
examples:
UpdateDeploymentGroup510Example:
summary: Default UpdateDeploymentGroup 510 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDeploymentGroupInput'
examples:
UpdateDeploymentGroupRequestExample:
summary: Default UpdateDeploymentGroup request
x-microcks-default: true
value:
applicationName: example-resource
currentDeploymentGroupName: example-resource
newDeploymentGroupName: example-resource
deploymentConfigName: example-resource
ec2TagFilters: example-value
onPremisesInstanceTagFilters: example-value
autoScalingGroups: example-value
serviceRoleArn: arn:aws:service:us-east-1:123456789012:resource/example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.UpdateDeploymentGroup
summary: Amazon CodeDeploy Update Deployment Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
AddTagsToOnPremisesInstancesInput:
type: object
required:
- tags
- instanceNames
title: AddTagsToOnPremisesInstancesInput
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tag key-value pairs to add to the on-premises instances.
Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
instanceNames: allOf: - $ref: '#/components/schemas/InstanceNameList' - description: The names of the on-premises instances to which to add tags. description: 'Represents the input of, and adds tags to, an on-premises instance operation.' InstanceNameRequiredException: {} InvalidInstanceNameException: {} TagRequiredException: {} InvalidTagException: {} TagLimitExceededException: {} InstanceLimitExceededException: {} InstanceNotRegisteredException: {} BatchGetApplicationRevisionsOutput: type: object properties: applicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application that corresponds to the revisions. errorMessage: allOf: - $ref: '#/components/schemas/ErrorMessage' - description: Information about errors that might have occurred during the API call. revisions: allOf: - $ref: '#/components/schemas/RevisionInfoList' - description: 'Additional information about the revisions, including the type and location.' description: Represents the output of aBatchGetApplicationRevisions operation.
BatchGetApplicationRevisionsInput:
type: object
required:
- applicationName
- revisions
title: BatchGetApplicationRevisionsInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application about which to get revision information.
revisions:
allOf:
- $ref: '#/components/schemas/RevisionLocationList'
- description: 'An array of RevisionLocation objects that specify information to get about the application revisions, including type and location. The maximum number of RevisionLocation
objects you can specify is 25.'
description: Represents the input of a BatchGetApplicationRevisions operation.
ApplicationDoesNotExistException: {}
ApplicationNameRequiredException: {}
InvalidApplicationNameException: {}
RevisionRequiredException: {}
InvalidRevisionException: {}
BatchLimitExceededException: {}
BatchGetApplicationsOutput:
type: object
properties:
applicationsInfo:
allOf:
- $ref: '#/components/schemas/ApplicationsInfoList'
- description: Information about the applications.
description: Represents the output of a BatchGetApplications operation.
BatchGetApplicationsInput:
type: object
required:
- applicationNames
title: BatchGetApplicationsInput
properties:
applicationNames:
allOf:
- $ref: '#/components/schemas/ApplicationsList'
- description: A list of application names separated by spaces. The maximum number of application names you can specify is 100.
description: Represents the input of a BatchGetApplications operation.
BatchGetDeploymentGroupsOutput:
type: object
properties:
deploymentGroupsInfo:
allOf:
- $ref: '#/components/schemas/DeploymentGroupInfoList'
- description: Information about the deployment groups.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: Information about errors that might have occurred during the API call.
description: Represents the output of a BatchGetDeploymentGroups operation.
BatchGetDeploymentGroupsInput:
type: object
required:
- applicationName
- deploymentGroupNames
title: BatchGetDeploymentGroupsInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.
deploymentGroupNames:
allOf:
- $ref: '#/components/schemas/DeploymentGroupsList'
- description: The names of the deployment groups.
description: Represents the input of a BatchGetDeploymentGroups operation.
DeploymentGroupNameRequiredException: {}
InvalidDeploymentGroupNameException: {}
DeploymentConfigDoesNotExistException: {}
BatchGetDeploymentInstancesOutput:
type: object
properties:
instancesSummary:
allOf:
- $ref: '#/components/schemas/InstanceSummaryList'
- description: Information about the instance.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: Information about errors that might have occurred during the API call.
description: Represents the output of a BatchGetDeploymentInstances operation.
BatchGetDeploymentInstancesInput:
type: object
required:
- deploymentId
- instanceIds
title: BatchGetDeploymentInstancesInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
instanceIds:
allOf:
- $ref: '#/components/schemas/InstancesList'
- description: The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
description: ' Represents the input of a BatchGetDeploymentInstances operation. '
DeploymentIdRequiredException: {}
DeploymentDoesNotExistException: {}
InstanceIdRequiredException: {}
InvalidDeploymentIdException: {}
InvalidComputePlatformException: {}
BatchGetDeploymentTargetsOutput:
type: object
properties:
deploymentTargets:
allOf:
- $ref: '#/components/schemas/DeploymentTargetList'
- description: 'A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment'' compute platform.
EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance.
Lambda: The target object is a specific version of an Lambda function.
Amazon ECS: The target object is an Amazon ECS service.
CloudFormation: The target object is an CloudFormation blue/green deployment.
The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.
For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type
is instanceTarget.
For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>.
Their target type is ecsTarget.
For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.
BatchGetDeployments operation. '
BatchGetDeploymentsInput:
type: object
required:
- deploymentIds
title: BatchGetDeploymentsInput
properties:
deploymentIds:
allOf:
- $ref: '#/components/schemas/DeploymentsList'
- description: ' A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.'
description: ' Represents the input of a BatchGetDeployments operation. '
BatchGetOnPremisesInstancesOutput:
type: object
properties:
instanceInfos:
allOf:
- $ref: '#/components/schemas/InstanceInfoList'
- description: Information about the on-premises instances.
description: Represents the output of a BatchGetOnPremisesInstances operation.
BatchGetOnPremisesInstancesInput:
type: object
required:
- instanceNames
title: BatchGetOnPremisesInstancesInput
properties:
instanceNames:
allOf:
- $ref: '#/components/schemas/InstanceNameList'
- description: The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
description: Represents the input of a BatchGetOnPremisesInstances operation.
ContinueDeploymentInput:
type: object
title: ContinueDeploymentInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment. '
deploymentWaitType:
allOf:
- $ref: '#/components/schemas/DeploymentWaitType'
- description: ' The status of the deployment''s waiting period. READY_WAIT indicates that the deployment is ready to start shifting traffic. TERMINATION_WAIT indicates
that the traffic is shifted, but the original target is not terminated. '
DeploymentAlreadyCompletedException: {}
DeploymentIsNotInReadyStateException: {}
UnsupportedActionForDeploymentTypeException: {}
InvalidDeploymentWaitTypeException: {}
InvalidDeploymentStatusException: {}
CreateApplicationOutput:
type: object
properties:
applicationId:
allOf:
- $ref: '#/components/schemas/ApplicationId'
- description: A unique application ID.
description: Represents the output of a CreateApplication operation.
CreateApplicationInput:
type: object
required:
- applicationName
title: CreateApplicationInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.
computePlatform:
allOf:
- $ref: '#/components/schemas/ComputePlatform'
- description: ' The destination platform type for the deployment (Lambda, Server, or ECS).'
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: ' The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. '
description: Represents the input of a CreateApplication operation.
ApplicationAlreadyExistsException: {}
ApplicationLimitExceededException: {}
InvalidTagsToAddException: {}
CreateDeploymentOutput:
type: object
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
description: ' Represents the output of a CreateDeployment operation. '
CreateDeploymentInput:
type: object
required:
- applicationName
title: CreateDeploymentInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: The name of the deployment group.
revision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: ' The type and location of the revision to deploy. '
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: 'The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
If not specified, the value configured in the deployment group is
used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.
If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the
deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic
fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
During a deployment, the CodeDeploy agent runs the scripts specified
for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run
from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.
If the cause of the failure is
a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop,
BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
Information about how CodeDeploy handles files that already exist in a deployment target location but weren''t part of the previous successful deployment.
The fileExistsBehavior
parameter takes any of the following values:
DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment
group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment
to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that
the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.
If you specify an overrideAlarmConfiguration,
you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.
CreateDeployment operation.
DeploymentGroupDoesNotExistException: {}
RevisionDoesNotExistException: {}
InvalidDeploymentConfigNameException: {}
DescriptionTooLongException: {}
DeploymentLimitExceededException: {}
InvalidTargetInstancesException: {}
InvalidAlarmConfigException: {}
AlarmsLimitExceededException: {}
InvalidAutoRollbackConfigException: {}
InvalidLoadBalancerInfoException: {}
InvalidFileExistsBehaviorException: {}
InvalidRoleException: {}
InvalidAutoScalingGroupException: {}
ThrottlingException: {}
InvalidUpdateOutdatedInstancesOnlyValueException: {}
InvalidIgnoreApplicationStopFailuresValueException: {}
InvalidGitHubAccountTokenException: {}
InvalidTrafficRoutingConfigurationException: {}
CreateDeploymentConfigOutput:
type: object
properties:
deploymentConfigId:
allOf:
- $ref: '#/components/schemas/DeploymentConfigId'
- description: A unique deployment configuration ID.
description: Represents the output of a CreateDeploymentConfig operation.
CreateDeploymentConfigInput:
type: object
required:
- deploymentConfigName
title: CreateDeploymentConfigInput
properties:
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: The name of the deployment configuration to create.
minimumHealthyHosts:
allOf:
- $ref: '#/components/schemas/MinimumHealthyHosts'
- description: 'The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
' trafficRoutingConfig: allOf: - $ref: '#/components/schemas/TrafficRoutingConfig' - description: The configuration that specifies how the deployment traffic is routed. computePlatform: allOf: - $ref: '#/components/schemas/ComputePlatform' - description: 'The destination platform type for the deployment (Lambda, Server, or ECS).'
description: Represents the input of a CreateDeploymentConfig operation.
DeploymentConfigNameRequiredException: {}
DeploymentConfigAlreadyExistsException: {}
InvalidMinimumHealthyHostValueException: {}
DeploymentConfigLimitExceededException: {}
CreateDeploymentGroupOutput:
type: object
properties:
deploymentGroupId:
allOf:
- $ref: '#/components/schemas/DeploymentGroupId'
- description: A unique deployment group ID.
description: Represents the output of a CreateDeploymentGroup operation.
CreateDeploymentGroupInput:
type: object
required:
- applicationName
- deploymentGroupName
- serviceRoleArn
title: CreateDeploymentGroupInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: The name of a new deployment group for the specified application.
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: 'If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn''t specified
for the deployment or deployment group.
For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
' ec2TagFilters: allOf: - $ref: '#/components/schemas/EC2TagFilterList' - description: The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet. 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. Cannot be used in the same call asOnPremisesTagSet.
autoScalingGroups:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupNameList'
- description: A list of associated Amazon EC2 Auto Scaling groups.
serviceRoleArn:
allOf:
- $ref: '#/components/schemas/Role'
- description: A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
triggerConfigurations:
allOf:
- $ref: '#/components/schemas/TriggerConfigList'
- description: 'Information about triggers to create when the deployment group is created. For examples, see Create
a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.'
alarmConfiguration:
allOf:
- $ref: '#/components/schemas/AlarmConfiguration'
- description: Information to add about Amazon CloudWatch alarms when the deployment group is created.
autoRollbackConfiguration:
allOf:
- $ref: '#/components/schemas/AutoRollbackConfiguration'
- description: Configuration information for an automatic rollback that is added when a deployment group is created.
outdatedInstancesStrategy:
allOf:
- $ref: '#/components/schemas/OutdatedInstancesStrategy'
- description: 'Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
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.
If this
option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
ec2TagFilters.
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 <clustername>:<servicename>. '
onPremisesTagSet:
allOf:
- $ref: '#/components/schemas/OnPremisesTagSet'
- description: Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used
in the same call as onPremisesInstanceTagFilters.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: ' The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. '
description: Represents the input of a CreateDeploymentGroup operation.
DeploymentGroupAlreadyExistsException: {}
InvalidEC2TagException: {}
RoleRequiredException: {}
DeploymentGroupLimitExceededException: {}
LifecycleHookLimitExceededException: {}
InvalidTriggerConfigException: {}
TriggerTargetsLimitExceededException: {}
InvalidDeploymentStyleException: {}
InvalidBlueGreenDeploymentConfigurationException: {}
InvalidEC2TagCombinationException: {}
InvalidOnPremisesTagCombinationException: {}
TagSetListLimitExceededException: {}
InvalidInputException: {}
InvalidECSServiceException: {}
InvalidTargetGroupPairException: {}
ECSServiceMappingLimitExceededException: {}
DeleteApplicationInput:
type: object
required:
- applicationName
title: DeleteApplicationInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
description: Represents the input of a DeleteApplication operation.
DeleteDeploymentConfigInput:
type: object
required:
- deploymentConfigName
title: DeleteDeploymentConfigInput
properties:
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
description: Represents the input of a DeleteDeploymentConfig operation.
DeploymentConfigInUseException: {}
InvalidOperationException: {}
DeleteDeploymentGroupOutput:
type: object
properties:
hooksNotCleanedUp:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupList'
- description: 'If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling
lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon
EC2 instances in the Auto Scaling group.'
description: Represents the output of a DeleteDeploymentGroup operation.
DeleteDeploymentGroupInput:
type: object
required:
- applicationName
- deploymentGroupName
title: DeleteDeploymentGroupInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: The name of a deployment group for the specified application.
description: Represents the input of a DeleteDeploymentGroup operation.
DeleteGitHubAccountTokenOutput:
type: object
properties:
tokenName:
allOf:
- $ref: '#/components/schemas/GitHubAccountTokenName'
- description: The name of the GitHub account connection that was deleted.
description: Represents the output of a DeleteGitHubAccountToken operation.
DeleteGitHubAccountTokenInput:
type: object
title: DeleteGitHubAccountTokenInput
properties:
tokenName:
allOf:
- $ref: '#/components/schemas/GitHubAccountTokenName'
- description: The name of the GitHub account connection to delete.
description: Represents the input of a DeleteGitHubAccount operation.
GitHubAccountTokenNameRequiredException: {}
GitHubAccountTokenDoesNotExistException: {}
InvalidGitHubAccountTokenNameException: {}
ResourceValidationException: {}
OperationNotSupportedException: {}
DeleteResourcesByExternalIdOutput:
type: object
properties: {}
DeleteResourcesByExternalIdInput:
type: object
title: DeleteResourcesByExternalIdInput
properties:
externalId:
allOf:
- $ref: '#/components/schemas/ExternalId'
- description: 'The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.'
DeregisterOnPremisesInstanceInput:
type: object
required:
- instanceName
title: DeregisterOnPremisesInstanceInput
properties:
instanceName:
allOf:
- $ref: '#/components/schemas/InstanceName'
- description: The name of the on-premises instance to deregister.
description: Represents the input of a DeregisterOnPremisesInstance operation.
GetApplicationOutput:
type: object
properties:
application:
allOf:
- $ref: '#/components/schemas/ApplicationInfo'
- description: Information about the application.
description: Represents the output of a GetApplication operation.
GetApplicationInput:
type: object
required:
- applicationName
title: GetApplicationInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
description: Represents the input of a GetApplication operation.
GetApplicationRevisionOutput:
type: object
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of the application that corresponds to the revision.
revision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: 'Additional information about the revision, including type and location.'
revisionInfo:
allOf:
- $ref: '#/components/schemas/GenericRevisionInfo'
- description: General information about the revision.
description: Represents the output of a GetApplicationRevision operation.
GetApplicationRevisionInput:
type: object
required:
- applicationName
- revision
title: GetApplicationRevisionInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of the application that corresponds to the revision.
revision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: 'Information about the application revision to get, including type and location.'
description: Represents the input of a GetApplicationRevision operation.
GetDeploymentOutput:
type: object
properties:
deploymentInfo:
allOf:
- $ref: '#/components/schemas/DeploymentInfo'
- description: Information about the deployment.
description: Represents the output of a GetDeployment operation.
GetDeploymentInput:
type: object
required:
- deploymentId
title: GetDeploymentInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment associated with the IAM user or Amazon Web Services account. '
description: Represents the input of a GetDeployment operation.
GetDeploymentConfigOutput:
type: object
properties:
deploymentConfigInfo:
allOf:
- $ref: '#/components/schemas/DeploymentConfigInfo'
- description: Information about the deployment configuration.
description: Represents the output of a GetDeploymentConfig operation.
GetDeploymentConfigInput:
type: object
required:
- deploymentConfigName
title: GetDeploymentConfigInput
properties:
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
description: Represents the input of a GetDeploymentConfig operation.
GetDeploymentGroupOutput:
type: object
properties:
deploymentGroupInfo:
allOf:
- $ref: '#/components/schemas/DeploymentGroupInfo'
- description: Information about the deployment group.
description: Represents the output of a GetDeploymentGroup operation.
GetDeploymentGroupInput:
type: object
required:
- applicationName
- deploymentGroupName
title: GetDeploymentGroupInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: The name of a deployment group for the specified application.
description: Represents the input of a GetDeploymentGroup operation.
GetDeploymentInstanceOutput:
type: object
properties:
instanceSummary:
allOf:
- $ref: '#/components/schemas/InstanceSummary'
- description: ' Information about the instance. '
description: ' Represents the output of a GetDeploymentInstance operation. '
GetDeploymentInstanceInput:
type: object
required:
- deploymentId
- instanceId
title: GetDeploymentInstanceInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
instanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: ' The unique ID of an instance in the deployment group. '
description: ' Represents the input of a GetDeploymentInstance operation. '
GetDeploymentTargetOutput:
type: object
properties:
deploymentTarget:
allOf:
- $ref: '#/components/schemas/DeploymentTarget'
- description: ' A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment
target. The deployment target metadata depends on the deployment target''s type (instanceTarget, lambdaTarget, or ecsTarget). '
GetDeploymentTargetInput:
type: object
title: GetDeploymentTargetInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
targetId:
allOf:
- $ref: '#/components/schemas/TargetId'
- description: ' The unique ID of a deployment target. '
GetOnPremisesInstanceOutput:
type: object
properties:
instanceInfo:
allOf:
- $ref: '#/components/schemas/InstanceInfo'
- description: ' Information about the on-premises instance. '
description: ' Represents the output of a GetOnPremisesInstance operation. '
GetOnPremisesInstanceInput:
type: object
required:
- instanceName
title: GetOnPremisesInstanceInput
properties:
instanceName:
allOf:
- $ref: '#/components/schemas/InstanceName'
- description: ' The name of the on-premises instance about which to get information. '
description: ' Represents the input of a GetOnPremisesInstance operation. '
ListApplicationRevisionsOutput:
type: object
properties:
revisions:
allOf:
- $ref: '#/components/schemas/RevisionLocationList'
- description: A list of locations that contain the matching revisions.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application
revisions in the list.'
description: Represents the output of a ListApplicationRevisions operation.
ListApplicationRevisionsInput:
type: object
required:
- applicationName
title: ListApplicationRevisionsInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: ' The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account. '
sortBy:
allOf:
- $ref: '#/components/schemas/ApplicationRevisionSortBy'
- description: 'The column name to use to sort the list results:
registerTime: Sort by the time the revisions were registered with CodeDeploy.
firstUsedTime: Sort by the time the revisions were first used in a deployment.
lastUsedTime: Sort by the time the revisions were last used
in a deployment.
If not specified or set to null, the results are returned in an arbitrary order.
' sortOrder: allOf: - $ref: '#/components/schemas/SortOrder' - description: 'The order in which to sort the list results:
ascending: ascending order.
descending: descending order.
If not specified, the results are sorted in ascending order.
If set to null, the results are sorted in an arbitrary order.
' s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: 'An Amazon S3 bucket name to limit the search for revisions.
If set to null, all of the user''s buckets are searched.
' s3KeyPrefix: allOf: - $ref: '#/components/schemas/S3Key' - description: ' A key prefix for the set of Amazon S3 objects to limit the search for revisions. ' deployed: allOf: - $ref: '#/components/schemas/ListStateFilterAction' - description: 'Whether to list revisions based on whether the revision is the target revision of a deployment group:
include: List revisions that are target
revisions of a deployment group.
exclude: Do not list revisions that are target revisions of a deployment group.
ignore: List
all revisions.
ListApplicationRevisions call. It can be used to return the next set of applications in the list.
description: ' Represents the input of a ListApplicationRevisions operation. '
InvalidSortByException: {}
InvalidSortOrderException: {}
InvalidBucketNameFilterException: {}
InvalidKeyPrefixFilterException: {}
BucketNameFilterRequiredException: {}
InvalidDeployedStateFilterException: {}
InvalidNextTokenException: {}
ListApplicationsOutput:
type: object
properties:
applications:
allOf:
- $ref: '#/components/schemas/ApplicationsList'
- description: A list of application names.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the
list.'
description: Represents the output of a ListApplications operation.
ListApplicationsInput:
type: object
title: ListApplicationsInput
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
description: Represents the input of a ListApplications operation.
ListDeploymentConfigsOutput:
type: object
properties:
deploymentConfigsList:
allOf:
- $ref: '#/components/schemas/DeploymentConfigsList'
- description: 'A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.'
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment
configurations in the list.'
description: Represents the output of a ListDeploymentConfigs operation.
ListDeploymentConfigsInput:
type: object
title: ListDeploymentConfigsInput
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list. '
description: Represents the input of a ListDeploymentConfigs operation.
ListDeploymentGroupsOutput:
type: object
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The application name.
deploymentGroups:
allOf:
- $ref: '#/components/schemas/DeploymentGroupsList'
- description: A list of deployment group names.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups
in the list.'
description: Represents the output of a ListDeploymentGroups operation.
ListDeploymentGroupsInput:
type: object
required:
- applicationName
title: ListDeploymentGroupsInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
description: Represents the input of a ListDeploymentGroups operation.
ListDeploymentInstancesOutput:
type: object
properties:
instancesList:
allOf:
- $ref: '#/components/schemas/InstancesList'
- description: A list of instance IDs.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment
instances in the list.'
description: Represents the output of a ListDeploymentInstances operation.
ListDeploymentInstancesInput:
type: object
required:
- deploymentId
title: ListDeploymentInstancesInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
instanceStatusFilter:
allOf:
- $ref: '#/components/schemas/InstanceStatusList'
- description: 'A subset of instances to list by status:
Pending: Include those instances with pending deployments.
InProgress:
Include those instances where deployments are still in progress.
Succeeded: Include those instances with successful deployments.
Failed:
Include those instances with failed deployments.
Skipped: Include those instances with skipped deployments.
Unknown: Include
those instances with deployments in an unknown state.
ListDeploymentInstances operation. '
InvalidInstanceStatusException: {}
InvalidInstanceTypeException: {}
InvalidDeploymentInstanceTypeException: {}
InvalidTargetFilterNameException: {}
ListDeploymentTargetsOutput:
type: object
properties:
targetIds:
allOf:
- $ref: '#/components/schemas/TargetIdList'
- description: ' The unique IDs of deployment targets. '
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set
of deployment targets in the list. '
ListDeploymentTargetsInput:
type: object
title: ListDeploymentTargetsInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list. '
targetFilters:
allOf:
- $ref: '#/components/schemas/TargetFilters'
- description: 'A key used to filter the returned targets. The two valid values are:
TargetStatus - A TargetStatus filter string can be Failed,
InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.
ServerInstanceLabel
- A ServerInstanceLabel filter string can be Blue or Green.
ListDeployments operation.
ListDeploymentsInput:
type: object
title: ListDeploymentsInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: 'The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
If applicationName is specified, then deploymentGroupName
must be specified. If it is not specified, then deploymentGroupName must not be specified.
The name of a deployment group for the specified application.
If deploymentGroupName is specified, then applicationName must be specified.
If it is not specified, then applicationName must not be specified.
A subset of deployments to list by status:
Created: Include created deployments in the resulting list.
Queued:
Include queued deployments in the resulting list.
In Progress: Include in-progress deployments in the resulting list.
Succeeded:
Include successful deployments in the resulting list.
Failed: Include failed deployments in the resulting list.
Stopped: Include
stopped deployments in the resulting list.
ListDeployments operation.
InvalidTimeRangeException: {}
InvalidExternalIdException: {}
ListGitHubAccountTokenNamesOutput:
type: object
properties:
tokenNameList:
allOf:
- $ref: '#/components/schemas/GitHubAccountTokenNameList'
- description: A list of names of connections to GitHub accounts.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set
of names in the list. '
description: Represents the output of a ListGitHubAccountTokenNames operation.
ListGitHubAccountTokenNamesInput:
type: object
title: ListGitHubAccountTokenNamesInput
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list. '
description: Represents the input of a ListGitHubAccountTokenNames operation.
ListOnPremisesInstancesOutput:
type: object
properties:
instanceNames:
allOf:
- $ref: '#/components/schemas/InstanceNameList'
- description: The list of matching on-premises instance names.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises
instances in the list.'
description: Represents the output of the list on-premises instances operation.
ListOnPremisesInstancesInput:
type: object
title: ListOnPremisesInstancesInput
properties:
registrationStatus:
allOf:
- $ref: '#/components/schemas/RegistrationStatus'
- description: 'The registration status of the on-premises instances:
Deregistered: Include deregistered on-premises instances in the resulting list.
Registered: Include registered on-premises instances in the resulting list.
ListOnPremisesInstances operation.
InvalidRegistrationStatusException: {}
InvalidTagFilterException: {}
ListTagsForResourceOutput:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: ' A list of tags returned by ListTagsForResource. The tags are associated with the resource identified by the input ResourceArn parameter. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application
revisions in the list.'
ListTagsForResourceInput:
type: object
required:
- ResourceArn
title: ListTagsForResourceInput
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.
ArnNotSupportedException: {}
InvalidArnException: {}
ResourceArnRequiredException: {}
PutLifecycleEventHookExecutionStatusOutput:
type: object
properties:
lifecycleEventHookExecutionId:
allOf:
- $ref: '#/components/schemas/LifecycleEventHookExecutionId'
- description: The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.
PutLifecycleEventHookExecutionStatusInput:
type: object
title: PutLifecycleEventHookExecutionStatusInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event. '
lifecycleEventHookExecutionId:
allOf:
- $ref: '#/components/schemas/LifecycleEventHookExecutionId'
- description: ' The execution ID of a deployment''s lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file. '
status:
allOf:
- $ref: '#/components/schemas/LifecycleEventStatus'
- description: 'The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only
Succeeded and Failed can be passed successfully in your API call.'
InvalidLifecycleEventHookExecutionStatusException: {}
InvalidLifecycleEventHookExecutionIdException: {}
LifecycleEventAlreadyCompletedException: {}
RegisterApplicationRevisionInput:
type: object
required:
- applicationName
- revision
title: RegisterApplicationRevisionInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A comment about the revision.
revision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: 'Information about the application revision to register, including type and location.'
description: Represents the input of a RegisterApplicationRevision operation.
RegisterOnPremisesInstanceInput:
type: object
required:
- instanceName
title: RegisterOnPremisesInstanceInput
properties:
instanceName:
allOf:
- $ref: '#/components/schemas/InstanceName'
- description: The name of the on-premises instance to register.
iamSessionArn:
allOf:
- $ref: '#/components/schemas/IamSessionArn'
- description: The ARN of the IAM session to associate with the on-premises instance.
iamUserArn:
allOf:
- $ref: '#/components/schemas/IamUserArn'
- description: The ARN of the IAM user to associate with the on-premises instance.
description: Represents the input of the register on-premises instance operation.
InstanceNameAlreadyRegisteredException: {}
IamArnRequiredException: {}
IamSessionArnAlreadyRegisteredException: {}
IamUserArnAlreadyRegisteredException: {}
IamUserArnRequiredException: {}
InvalidIamSessionArnException: {}
InvalidIamUserArnException: {}
MultipleIamArnsProvidedException: {}
RemoveTagsFromOnPremisesInstancesInput:
type: object
required:
- tags
- instanceNames
title: RemoveTagsFromOnPremisesInstancesInput
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tag key-value pairs to remove from the on-premises instances.
instanceNames:
allOf:
- $ref: '#/components/schemas/InstanceNameList'
- description: The names of the on-premises instances from which to remove tags.
description: Represents the input of a RemoveTagsFromOnPremisesInstances operation.
SkipWaitTimeForInstanceTerminationInput:
type: object
title: SkipWaitTimeForInstanceTerminationInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a blue/green deployment for which you want to skip the instance termination wait time. '
StopDeploymentOutput:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StopStatus'
- description: 'The status of the stop deployment operation:
Pending: The stop operation is pending.
Succeeded: The stop operation was successful.
StopDeployment operation. '
StopDeploymentInput:
type: object
required:
- deploymentId
title: StopDeploymentInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
autoRollbackEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: ' Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision. '
description: ' Represents the input of a StopDeployment operation. '
TagResourceOutput:
type: object
properties: {}
TagResourceInput:
type: object
required:
- ResourceArn
- Tags
title: TagResourceInput
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The ARN of a resource, such as a CodeDeploy application or deployment group. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: ' A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter. '
UntagResourceOutput:
type: object
properties: {}
UntagResourceInput:
type: object
required:
- ResourceArn
- TagKeys
title: UntagResourceInput
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys input parameter. '
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: ' A list of keys of Tag objects. The Tag objects identified by the keys are disassociated from the resource specified by the ResourceArn input
parameter. '
UpdateApplicationInput:
type: object
title: UpdateApplicationInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The current name of the application you want to change.
newApplicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The new name to give the application.
description: Represents the input of an UpdateApplication operation.
UpdateDeploymentGroupOutput:
type: object
properties:
hooksNotCleanedUp:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupList'
- description: 'If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling
lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.'
description: Represents the output of an UpdateDeploymentGroup operation.
UpdateDeploymentGroupInput:
type: object
required:
- applicationName
- currentDeploymentGroupName
title: UpdateDeploymentGroupInput
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The application name that corresponds to the deployment group to update.
currentDeploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: The current name of the deployment group.
newDeploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: 'The new name of the deployment group, if you want to change it.'
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: 'The replacement deployment configuration name to use, if you want to change it.'
ec2TagFilters:
allOf:
- $ref: '#/components/schemas/EC2TagFilterList'
- description: 'The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.'
onPremisesInstanceTagFilters:
allOf:
- $ref: '#/components/schemas/TagFilterList'
- description: 'The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any
tag names.'
autoScalingGroups:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupNameList'
- description: 'The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
To keep the Auto Scaling groups, enter their names or do not specify this parameter.
To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
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.
If this
option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
<clustername>:<servicename>. '
onPremisesTagSet:
allOf:
- $ref: '#/components/schemas/OnPremisesTagSet'
- description: Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
description: Represents the input of an UpdateDeploymentGroup operation.
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
InstanceNameList:
type: array
items:
$ref: '#/components/schemas/InstanceName'
AdditionalDeploymentStatusInfo:
type: string
deprecated: true
description: 'AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead.'
AlarmName:
type: string
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.
Boolean:
type: boolean
AlarmList:
type: array
items:
$ref: '#/components/schemas/Alarm'
AlarmConfiguration:
type: object
properties:
enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true: The deployment proceeds even if alarm status information can''t be retrieved from Amazon CloudWatch.
false: The deployment stops
if alarm status information can''t be retrieved from Amazon CloudWatch.
The YAML-formatted or JSON-formatted revision string.
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.
For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more.
For both types of deployments, the content can specify Lambda functions
that run at specified hooks, such as BeforeInstall, during a deployment.
RawString data type. '
ApplicationId:
type: string
ApplicationName:
type: string
minLength: 1
maxLength: 100
Timestamp:
type: string
format: date-time
GitHubAccountTokenName:
type: string
ComputePlatform:
type: string
enum:
- Server
- Lambda
- ECS
ApplicationInfo:
type: object
properties:
applicationId:
allOf:
- $ref: '#/components/schemas/ApplicationId'
- description: The application ID.
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The application name.
createTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the application was created.
linkedToGitHub:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'True if the user has authenticated with GitHub for the specified application. Otherwise, false.'
gitHubAccountName:
allOf:
- $ref: '#/components/schemas/GitHubAccountTokenName'
- description: The name for a connection to a GitHub account.
computePlatform:
allOf:
- $ref: '#/components/schemas/ComputePlatform'
- description: The destination platform type for deployment of the application (Lambda or Server).
description: Information about an application.
ApplicationRevisionSortBy:
type: string
enum:
- registerTime
- firstUsedTime
- lastUsedTime
ApplicationsInfoList:
type: array
items:
$ref: '#/components/schemas/ApplicationInfo'
ApplicationsList:
type: array
items:
$ref: '#/components/schemas/ApplicationName'
Arn:
type: string
minLength: 1
maxLength: 1011
AutoRollbackEventsList:
type: array
items:
$ref: '#/components/schemas/AutoRollbackEvent'
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.
AutoRollbackEvent:
type: string
enum:
- DEPLOYMENT_FAILURE
- DEPLOYMENT_STOP_ON_ALARM
- DEPLOYMENT_STOP_ON_REQUEST
AutoScalingGroupName:
type: string
AutoScalingGroupHook:
type: string
AutoScalingGroup:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupName'
- description: The Auto Scaling group name.
hook:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupHook'
- description: An Auto Scaling lifecycle event hook name.
description: Information about an Auto Scaling group.
AutoScalingGroupList:
type: array
items:
$ref: '#/components/schemas/AutoScalingGroup'
AutoScalingGroupNameList:
type: array
items:
$ref: '#/components/schemas/AutoScalingGroupName'
RevisionLocationList:
type: array
items:
$ref: '#/components/schemas/RevisionLocation'
ErrorMessage:
type: string
RevisionInfoList:
type: array
items:
$ref: '#/components/schemas/RevisionInfo'
DeploymentGroupsList:
type: array
items:
$ref: '#/components/schemas/DeploymentGroupName'
DeploymentGroupInfoList:
type: array
items:
$ref: '#/components/schemas/DeploymentGroupInfo'
DeploymentId:
type: string
InstancesList:
type: array
items:
$ref: '#/components/schemas/InstanceId'
InstanceSummaryList:
type: array
items:
$ref: '#/components/schemas/InstanceSummary'
TargetIdList:
type: array
items:
$ref: '#/components/schemas/TargetId'
DeploymentTargetList:
type: array
items:
$ref: '#/components/schemas/DeploymentTarget'
DeploymentsList:
type: array
items:
$ref: '#/components/schemas/DeploymentId'
DeploymentsInfoList:
type: array
items:
$ref: '#/components/schemas/DeploymentInfo'
InstanceInfoList:
type: array
items:
$ref: '#/components/schemas/InstanceInfo'
BlueInstanceTerminationOption:
type: object
properties:
action:
allOf:
- $ref: '#/components/schemas/InstanceAction'
- description: 'The action to take on instances in the original environment after a successful blue/green deployment.
TERMINATE: Instances are terminated after
a specified wait time.
KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.
For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.
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.
The maximum setting is 2880 minutes (2 days).
' description: 'Information about whether instances in the original environment are terminated when a blue/green deployment is successful.BlueInstanceTerminationOption does not apply to
Lambda deployments. '
DeploymentReadyOption:
type: object
properties:
actionOnTimeout:
allOf:
- $ref: '#/components/schemas/DeploymentReadyAction'
- description: 'Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
STOP_DEPLOYMENT option for actionOnTimeout.
description: Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
GreenFleetProvisioningOption:
type: object
properties:
action:
allOf:
- $ref: '#/components/schemas/GreenFleetProvisioningAction'
- description: 'The method used to add instances to a replacement environment.
DISCOVER_EXISTING: Use instances that already exist or will be created manually.
COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.
CloudFormationTarget. "
lastUpdatedAt:
allOf:
- $ref: '#/components/schemas/Time'
- description: ' The date and time when the target application was updated by an CloudFormation blue/green deployment. '
lifecycleEvents:
allOf:
- $ref: '#/components/schemas/LifecycleEventList'
- description: ' The lifecycle events of the CloudFormation blue/green deployment to this target application. '
status:
allOf:
- $ref: '#/components/schemas/TargetStatus'
- description: ' The status of an CloudFormation blue/green deployment''s target application. '
resourceType:
allOf:
- $ref: '#/components/schemas/CloudFormationResourceType'
- description: The resource type for the CloudFormation blue/green deployment.
targetVersionWeight:
allOf:
- $ref: '#/components/schemas/TrafficWeight'
- description: The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.
description: ' Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.'
CommitId:
type: string
DeploymentWaitType:
type: string
enum:
- READY_WAIT
- TERMINATION_WAIT
DeploymentConfigName:
type: string
minLength: 1
maxLength: 100
MinimumHealthyHosts:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/MinimumHealthyHostsType'
- description: 'The minimum healthy instance type:
HOST_COUNT: The minimum number of healthy instances as an absolute value.
FLEET_PERCENT:
The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
In
a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one
instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all
instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment
to the last instance fails, the overall deployment is still successful.
For more information, see CodeDeploy Instance Health in the CodeDeploy User Guide.
' value: allOf: - $ref: '#/components/schemas/MinimumHealthyHostsValue' - description: The minimum healthy instance value. description: Information about minimum healthy instance. TrafficRoutingConfig: type: object properties: type: allOf: - $ref: '#/components/schemas/TrafficRoutingType' - description: The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.
timeBasedCanary:
allOf:
- $ref: '#/components/schemas/TimeBasedCanary'
- description: A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS
task sets are specified in the deployment's AppSpec file.
timeBasedLinear:
allOf:
- $ref: '#/components/schemas/TimeBasedLinear'
- description: 'A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment.
The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment''s AppSpec file.'
description: 'The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another
during an Amazon ECS deployment.'
DeploymentConfigId:
type: string
DeploymentGroupName:
type: string
minLength: 1
maxLength: 100
EC2TagFilterList:
type: array
items:
$ref: '#/components/schemas/EC2TagFilter'
TagFilterList:
type: array
items:
$ref: '#/components/schemas/TagFilter'
Role:
type: string
TriggerConfigList:
type: array
items:
$ref: '#/components/schemas/TriggerConfig'
OutdatedInstancesStrategy:
type: string
enum:
- UPDATE
- IGNORE
DeploymentStyle:
type: object
properties:
deploymentType:
allOf:
- $ref: '#/components/schemas/DeploymentType'
- description: Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption:
allOf:
- $ref: '#/components/schemas/DeploymentOption'
- description: Indicates whether to route deployment traffic behind a load balancer.
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.'
LoadBalancerInfo:
type: object
properties:
elbInfoList:
allOf:
- $ref: '#/components/schemas/ELBInfoList'
- description: '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.
Adding more than one load balancer to the array is not supported.
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.
Adding more than one target group to the array is not supported.
TargeGroupPairInfo objects with a maximum size of one. '
description: Information about the Elastic Load Balancing load balancer or target group used in a deployment.
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.
ECSServiceList:
type: array
items:
$ref: '#/components/schemas/ECSService'
OnPremisesTagSet:
type: object
properties:
onPremisesTagSetList:
allOf:
- $ref: '#/components/schemas/OnPremisesTagSetList'
- description: 'A list that contains other lists of on-premises 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 on-premises instance tags.
DeploymentGroupId:
type: string
RevisionLocation:
type: object
properties:
revisionType:
allOf:
- $ref: '#/components/schemas/RevisionLocationType'
- description: 'The type of application revision:
S3: An application revision stored in Amazon S3.
GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
String: A YAML-formatted or JSON-formatted string (Lambda deployments only).
AppSpecContent: An AppSpecContent 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.
ec2TagSet.'
autoScalingGroups:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupNameList'
- description: The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
ec2TagSet:
allOf:
- $ref: '#/components/schemas/EC2TagSet'
- description: Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green
deployment. Cannot be used in the same call as tagFilters.
description: Information about the instances to be used in the replacement environment in a blue/green deployment.
FileExistsBehavior:
type: string
enum:
- DISALLOW
- OVERWRITE
- RETAIN
ExternalId:
type: string
DeploymentConfigInfo:
type: object
properties:
deploymentConfigId:
allOf:
- $ref: '#/components/schemas/DeploymentConfigId'
- description: The deployment configuration ID.
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: The deployment configuration name.
minimumHealthyHosts:
allOf:
- $ref: '#/components/schemas/MinimumHealthyHosts'
- description: Information about the number or percentage of minimum healthy instance.
createTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the deployment configuration was created.
computePlatform:
allOf:
- $ref: '#/components/schemas/ComputePlatform'
- description: 'The destination platform type for the deployment (Lambda, Server, or ECS).'
trafficRoutingConfig:
allOf:
- $ref: '#/components/schemas/TrafficRoutingConfig'
- description: The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.
description: Information about a deployment configuration.
DeploymentConfigsList:
type: array
items:
$ref: '#/components/schemas/DeploymentConfigName'
DeploymentCreator:
type: string
enum:
- user
- autoscaling
- codeDeployRollback
- CodeDeploy
- CodeDeployAutoUpdate
- CloudFormation
- CloudFormationRollback
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 group was complete.
createTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that indicates when the most recent deployment to the deployment group started.
description: Information about the most recent attempted or successful deployment to a deployment group.
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 Create
a Service Role for CodeDeploy in the CodeDeploy User Guide.'
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: 'Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
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.
If this
option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
Lambda, Server, or ECS).'
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 <clustername>:<servicename>. '
description: Information about a deployment group.
DeploymentStatus:
type: string
enum:
- Created
- Queued
- InProgress
- Baking
- Succeeded
- Failed
- Stopped
- Ready
ErrorInformation:
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
- description: 'For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide.
The error code:
APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
IAM_ROLE_MISSING: The service role cannot be accessed.
IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
INTERNAL_ERROR: There was an internal error.
NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
NO_INSTANCES: No instances were specified, or no instances can be found.
OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.
TIMEOUT: The deployment has timed out.
REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
A timestamp that indicates when the deployment was deployed to the deployment group.
In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.
' completeTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp that indicates when the deployment was complete. deploymentOverview: allOf: - $ref: '#/components/schemas/DeploymentOverview' - description: A summary of the deployment status of the instances in the deployment. description: allOf: - $ref: '#/components/schemas/Description' - description: A comment about the deployment. creator: allOf: - $ref: '#/components/schemas/DeploymentCreator' - description: 'The means by which the deployment was created:
user: A user created the deployment.
autoscaling: Amazon EC2 Auto
Scaling created the deployment.
codeDeployRollback: A rollback process created the deployment.
CodeDeployAutoUpdate: An auto-update
process created the deployment when it detected outdated Amazon EC2 instances.
If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the
deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic
fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
During a deployment, the CodeDeploy agent runs the scripts specified
for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run
from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.
If the cause of the failure is
a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop,
BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
Information about how CodeDeploy handles files that already exist in a deployment target location but weren''t part of the previous successful deployment.
DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
OVERWRITE: The version of the file from the application
revision currently being deployed replaces the version already on the instance.
RETAIN: The version of the file already on the instance is kept and used as
part of the new deployment.
Lambda, Server, or ECS).'
externalId:
allOf:
- $ref: '#/components/schemas/ExternalId'
- description: 'The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.'
relatedDeployments:
$ref: '#/components/schemas/RelatedDeployments'
overrideAlarmConfiguration:
$ref: '#/components/schemas/AlarmConfiguration'
description: Information about a deployment.
DeploymentOption:
type: string
enum:
- WITH_TRAFFIC_CONTROL
- WITHOUT_TRAFFIC_CONTROL
InstanceCount:
type: integer
DeploymentReadyAction:
type: string
enum:
- CONTINUE_DEPLOYMENT
- STOP_DEPLOYMENT
DeploymentStatusList:
type: array
items:
$ref: '#/components/schemas/DeploymentStatus'
DeploymentType:
type: string
enum:
- IN_PLACE
- BLUE_GREEN
DeploymentTargetType:
type: string
enum:
- InstanceTarget
- LambdaTarget
- ECSTarget
- CloudFormationTarget
InstanceTarget:
type: object
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
targetId:
allOf:
- $ref: '#/components/schemas/TargetId'
- description: ' The unique ID of a deployment target that has a type of instanceTarget. '
targetArn:
allOf:
- $ref: '#/components/schemas/TargetArn'
- description: ' The Amazon Resource Name (ARN) of the target. '
status:
allOf:
- $ref: '#/components/schemas/TargetStatus'
- description: ' The status an EC2/On-premises deployment''s target instance. '
lastUpdatedAt:
allOf:
- $ref: '#/components/schemas/Time'
- description: ' The date and time when the target instance was updated by a deployment. '
lifecycleEvents:
allOf:
- $ref: '#/components/schemas/LifecycleEventList'
- description: ' The lifecycle events of the deployment to this target instance. '
instanceLabel:
allOf:
- $ref: '#/components/schemas/TargetLabel'
- description: ' A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN). '
description: ' A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform. '
LambdaTarget:
type: object
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
targetId:
allOf:
- $ref: '#/components/schemas/TargetId'
- description: ' The unique ID of a deployment target that has a type of lambdaTarget. '
targetArn:
allOf:
- $ref: '#/components/schemas/TargetArn'
- description: ' The Amazon Resource Name (ARN) of the target. '
status:
allOf:
- $ref: '#/components/schemas/TargetStatus'
- description: ' The status an Lambda deployment''s target Lambda function. '
lastUpdatedAt:
allOf:
- $ref: '#/components/schemas/Time'
- description: ' The date and time when the target Lambda function was updated by a deployment. '
lifecycleEvents:
allOf:
- $ref: '#/components/schemas/LifecycleEventList'
- description: ' The lifecycle events of the deployment to this target Lambda function. '
lambdaFunctionInfo:
allOf:
- $ref: '#/components/schemas/LambdaFunctionInfo'
- description: ' A LambdaFunctionInfo object that describes a target Lambda function. '
description: ' Information about the target Lambda function during an Lambda deployment. '
ECSTarget:
type: object
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
targetId:
allOf:
- $ref: '#/components/schemas/TargetId'
- description: ' The unique ID of a deployment target that has a type of ecsTarget. '
targetArn:
allOf:
- $ref: '#/components/schemas/TargetArn'
- description: ' The Amazon Resource Name (ARN) of the target. '
lastUpdatedAt:
allOf:
- $ref: '#/components/schemas/Time'
- description: ' The date and time when the target Amazon ECS application was updated by a deployment. '
lifecycleEvents:
allOf:
- $ref: '#/components/schemas/LifecycleEventList'
- description: ' The lifecycle events of the deployment to this target Amazon ECS application. '
status:
allOf:
- $ref: '#/components/schemas/TargetStatus'
- description: ' The status an Amazon ECS deployment''s target ECS application. '
taskSetsInfo:
allOf:
- $ref: '#/components/schemas/ECSTaskSetList'
- description: ' The ECSTaskSet objects associated with the ECS target. '
description: ' Information about the target of an Amazon ECS deployment. '
DeploymentTarget:
type: object
properties:
deploymentTargetType:
allOf:
- $ref: '#/components/schemas/DeploymentTargetType'
- description: The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.
instanceTarget:
allOf:
- $ref: '#/components/schemas/InstanceTarget'
- description: ' Information about the target for a deployment that uses the EC2/On-premises compute platform. '
lambdaTarget:
allOf:
- $ref: '#/components/schemas/LambdaTarget'
- description: ' Information about the target for a deployment that uses the Lambda compute platform. '
ecsTarget:
allOf:
- $ref: '#/components/schemas/ECSTarget'
- description: ' Information about the target for a deployment that uses the Amazon ECS compute platform. '
cloudFormationTarget:
$ref: '#/components/schemas/CloudFormationTarget'
description: ' Information about the deployment target. '
InstanceName:
type: string
LifecycleErrorCode:
type: string
enum:
- Success
- ScriptMissing
- ScriptNotExecutable
- ScriptTimedOut
- ScriptFailed
- UnknownError
ScriptName:
type: string
LifecycleMessage:
type: string
LogTail:
type: string
Diagnostics:
type: object
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/LifecycleErrorCode'
- description: 'The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
' description: Diagnostic information about executable scripts that are part of a deployment. Key: type: string Value: type: string EC2TagFilterType: type: string enum: - KEY_ONLY - VALUE_ONLY - KEY_AND_VALUE 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: 'The tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE:
Key and value.
ECSTaskSet. '
desiredCount:
allOf:
- $ref: '#/components/schemas/ECSTaskSetCount'
- description: ' The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine
how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. '
pendingCount:
allOf:
- $ref: '#/components/schemas/ECSTaskSetCount'
- description: ' The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter
the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state. '
runningCount:
allOf:
- $ref: '#/components/schemas/ECSTaskSetCount'
- description: ' The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready
for use. '
status:
allOf:
- $ref: '#/components/schemas/ECSTaskSetStatus'
- description: 'The status of the task set. There are three valid task set statuses:
PRIMARY: Indicates the task set is serving production traffic.
ACTIVE: Indicates the task set is not serving production traffic.
DRAINING: Indicates the tasks in the task set are being stopped and
their corresponding targets are being deregistered from their target group.
BLUE) or a replacement target (GREEN). '
description: ' Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and
whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set. '
ELBName:
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.'
ELBInfoList:
type: array
items:
$ref: '#/components/schemas/ELBInfo'
ETag:
type: string
ErrorCode:
type: string
enum:
- AGENT_ISSUE
- ALARM_ACTIVE
- APPLICATION_MISSING
- AUTOSCALING_VALIDATION_ERROR
- AUTO_SCALING_CONFIGURATION
- AUTO_SCALING_IAM_ROLE_PERMISSIONS
- CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND
- CUSTOMER_APPLICATION_UNHEALTHY
- DEPLOYMENT_GROUP_MISSING
- ECS_UPDATE_ERROR
- ELASTIC_LOAD_BALANCING_INVALID
- ELB_INVALID_INSTANCE
- HEALTH_CONSTRAINTS
- HEALTH_CONSTRAINTS_INVALID
- HOOK_EXECUTION_FAILURE
- IAM_ROLE_MISSING
- IAM_ROLE_PERMISSIONS
- INTERNAL_ERROR
- INVALID_ECS_SERVICE
- INVALID_LAMBDA_CONFIGURATION
- INVALID_LAMBDA_FUNCTION
- INVALID_REVISION
- MANUAL_STOP
- MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION
- MISSING_ELB_INFORMATION
- MISSING_GITHUB_TOKEN
- NO_EC2_SUBSCRIPTION
- NO_INSTANCES
- OVER_MAX_INSTANCES
- RESOURCE_LIMIT_EXCEEDED
- REVISION_MISSING
- THROTTLED
- TIMEOUT
- CLOUDFORMATION_STACK_FAILURE
FilterValue:
type: string
FilterValueList:
type: array
items:
$ref: '#/components/schemas/FilterValue'
GenericRevisionInfo:
type: object
properties:
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A comment about the revision.
deploymentGroups:
allOf:
- $ref: '#/components/schemas/DeploymentGroupsList'
- description: The deployment groups for which this is the current target revision.
firstUsedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the revision was first used by CodeDeploy.
lastUsedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the revision was last used by CodeDeploy.
registerTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the revision was registered with CodeDeploy.
description: Information about an application revision.
InstanceId:
type: string
InstanceSummary:
type: object
deprecated: true
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
instanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The instance ID.
status:
allOf:
- $ref: '#/components/schemas/InstanceStatus'
- description: 'The deployment status for this instance:
Pending: The deployment is pending for this instance.
In Progress: The
deployment is in progress for this instance.
Succeeded: The deployment has succeeded for this instance.
Failed: The deployment
has failed for this instance.
Skipped: The deployment has been skipped for this instance.
Unknown: The deployment status is
unknown for this instance.
Information about which environment an instance belongs to in a blue/green deployment.
BLUE: The instance is part of the original environment.
GREEN: The instance is part of the replacement environment.
The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.
Specified as account/repository.
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. GreenFleetProvisioningAction: type: string enum: - DISCOVER_EXISTING - COPY_AUTO_SCALING_GROUP IamSessionArn: type: string IamUserArn: type: string InstanceArn: type: string InstanceStatus: type: string deprecated: true enum: - Pending - InProgress - Succeeded - Failed - Skipped - Unknown - Ready description: 'InstanceStatus is deprecated, use TargetStatus instead.' InstanceStatusList: type: array items: $ref: '#/components/schemas/InstanceStatus' InstanceType: type: string enum: - Blue - Green InstanceTypeList: type: array items: $ref: '#/components/schemas/InstanceType' LambdaFunctionAlias: type: string LambdaFunctionName: type: string Version: type: string LambdaFunctionInfo: type: object properties: functionName: allOf: - $ref: '#/components/schemas/LambdaFunctionName' - description: ' The name of a Lambda function. ' functionAlias: allOf: - $ref: '#/components/schemas/LambdaFunctionAlias' - description: ' The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide.' currentVersion: allOf: - $ref: '#/components/schemas/Version' - description: ' The version of a Lambda function that production traffic points to. ' targetVersion: allOf: - $ref: '#/components/schemas/Version' - description: ' The version of a Lambda function that production traffic points to after the Lambda function is deployed. ' targetVersionWeight: allOf: - $ref: '#/components/schemas/TrafficWeight' - description: ' The percentage of production traffic that the target version of a Lambda function receives. ' description: ' Information about a Lambda function specified in a deployment. ' LifecycleEventName: type: string LifecycleEventStatus: type: string enum: - Pending - InProgress - Succeeded - Failed - Skipped - Unknown LifecycleEvent: type: object properties: lifecycleEventName: allOf: - $ref: '#/components/schemas/LifecycleEventName' - description: 'The deployment lifecycle event name, such asApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.'
diagnostics:
allOf:
- $ref: '#/components/schemas/Diagnostics'
- description: Diagnostic information about the deployment lifecycle event.
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that indicates when the deployment lifecycle event started.
endTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that indicates when the deployment lifecycle event ended.
status:
allOf:
- $ref: '#/components/schemas/LifecycleEventStatus'
- description: 'The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
The start time of the time range.
Specify null to leave the start time open-ended.
The end time of the time range.
Specify null to leave the end time open-ended.
The file type of the application revision. Must be one of the following:
tar: A tar archive file.
tgz: A compressed
tar archive file.
zip: A zip archive file.
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the version is not specified, the system uses the most recent version by default.
' eTag: allOf: - $ref: '#/components/schemas/ETag' - description: 'The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the ETag is not specified as an input parameter, ETag validation of the object is skipped.
' description: Information about the location of application artifacts stored in Amazon S3. VersionId: type: string StopStatus: type: string enum: - Pending - Succeeded Tag: type: object properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The tag's key. Value: allOf: - $ref: '#/components/schemas/Value' - description: The tag's value. description: Information about a tag. TagFilterType: type: string enum: - KEY_ONLY - VALUE_ONLY - KEY_AND_VALUE 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: 'The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
TimeBasedCanary deployment.
canaryInterval:
allOf:
- $ref: '#/components/schemas/WaitTimeInMins'
- description: The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
description: A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments. The original and target Lambda function versions or
ECS task sets are specified in the deployment's AppSpec file.
TimeBasedLinear:
type: object
properties:
linearPercentage:
allOf:
- $ref: '#/components/schemas/Percentage'
- description: The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
linearInterval:
allOf:
- $ref: '#/components/schemas/WaitTimeInMins'
- description: The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
description: 'A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment. The
original and target Lambda function versions or ECS task sets are specified in the deployment''s AppSpec file.'
TrafficRoutingType:
type: string
enum:
- TimeBasedCanary
- TimeBasedLinear
- AllAtOnce
TriggerName:
type: string
TriggerTargetArn:
type: string
TriggerEventTypeList:
type: array
items:
$ref: '#/components/schemas/TriggerEventType'
TriggerConfig:
type: object
properties:
triggerName:
allOf:
- $ref: '#/components/schemas/TriggerName'
- description: The name of the notification trigger.
triggerTargetArn:
allOf:
- $ref: '#/components/schemas/TriggerTargetArn'
- description: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
triggerEvents:
allOf:
- $ref: '#/components/schemas/TriggerEventTypeList'
- description: The event type or types for which notifications are triggered.
description: Information about notification triggers for the deployment group.
TriggerEventType:
type: string
enum:
- DeploymentStart
- DeploymentSuccess
- DeploymentFailure
- DeploymentStop
- DeploymentRollback
- DeploymentReady
- InstanceStart
- InstanceSuccess
- InstanceFailure
- InstanceReady
security:
- hmac: []