The #X Amz Target=CodeDeploy 20141006.RegisterApplicationRevision API from Amazon CodeDeploy — 1 operation(s) for #x amz target=codedeploy 20141006.registerapplicationrevision.
openapi: 3.0.0
info:
version: '2014-10-06'
x-release: v4
title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.RegisterApplicationRevision API'
description: '<p>CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.</p> <p>CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.</p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.</p> <p> <b>CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a> </p> </li> <li> <p> <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">CodeDeploy Developer Forum</a> </p> </li> </ul>'
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codedeploy
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codedeploy-2014-10-06.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codedeploy.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeDeploy multi-region endpoint
- url: https://codedeploy.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeDeploy multi-region endpoint
- url: http://codedeploy.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia)
- url: https://codedeploy.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeDeploy 20141006.RegisterApplicationRevision'
paths:
/#X-Amz-Target=CodeDeploy_20141006.RegisterApplicationRevision:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: 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
tags:
- '#X Amz Target=CodeDeploy 20141006.RegisterApplicationRevision'
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
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-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
schemas:
InvalidRevisionException: {}
VersionId:
type: string
RawStringSha256:
type: string
ApplicationName:
type: string
minLength: 1
maxLength: 100
AppSpecContent:
type: object
properties:
content:
allOf:
- $ref: '#/components/schemas/RawStringContent'
- description: <p> The YAML-formatted or JSON-formatted revision string. </p> <p> For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. </p> <p> For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. </p> <p> For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as <code>BeforeInstall</code>, during a deployment. </p>
sha256:
allOf:
- $ref: '#/components/schemas/RawStringSha256'
- description: ' The SHA256 hash value of the revision content. '
description: ' A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated <code>RawString</code> data type. '
RevisionRequiredException: {}
GitHubLocation:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/Repository'
- description: <p>The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. </p> <p>Specified as account/repository.</p>
commitId:
allOf:
- $ref: '#/components/schemas/CommitId'
- description: The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
description: Information about the location of application artifacts stored in GitHub.
Repository:
type: string
RawStringContent:
type: string
S3Location:
type: object
properties:
bucket:
allOf:
- $ref: '#/components/schemas/S3Bucket'
- description: The name of the Amazon S3 bucket where the application revision is stored.
key:
allOf:
- $ref: '#/components/schemas/S3Key'
- description: The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType:
allOf:
- $ref: '#/components/schemas/BundleType'
- description: '<p>The file type of the application revision. Must be one of the following:</p> <ul> <li> <p> <code>tar</code>: A tar archive file.</p> </li> <li> <p> <code>tgz</code>: A compressed tar archive file.</p> </li> <li> <p> <code>zip</code>: A zip archive file.</p> </li> </ul>'
version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: <p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system uses the most recent version by default.</p>
eTag:
allOf:
- $ref: '#/components/schemas/ETag'
- description: <p>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the ETag is not specified as an input parameter, ETag validation of the object is skipped.</p>
description: Information about the location of application artifacts stored in Amazon S3.
RevisionLocation:
type: object
properties:
revisionType:
allOf:
- $ref: '#/components/schemas/RevisionLocationType'
- description: '<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (Lambda deployments only).</p> </li> <li> <p>AppSpecContent: An <code>AppSpecContent</code> object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.</p> </li> </ul>'
s3Location:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: 'Information about the location of a revision stored in Amazon S3. '
gitHubLocation:
allOf:
- $ref: '#/components/schemas/GitHubLocation'
- description: Information about the location of application artifacts stored in GitHub.
string:
allOf:
- $ref: '#/components/schemas/RawString'
- description: Information about the location of an Lambda deployment revision stored as a RawString.
appSpecContent:
allOf:
- $ref: '#/components/schemas/AppSpecContent'
- description: ' The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString. '
description: Information about the location of an application revision.
ETag:
type: string
RawString:
type: object
deprecated: true
properties:
content:
allOf:
- $ref: '#/components/schemas/RawStringContent'
- description: The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.
sha256:
allOf:
- $ref: '#/components/schemas/RawStringSha256'
- description: The SHA256 hash value of the revision content.
description: A revision for an Lambda deployment that is a YAML-formatted or JSON-formatted string. For Lambda deployments, the revision is the same as the AppSpec file.RawString and String revision type are deprecated, use AppSpecContent type instead.
ApplicationNameRequiredException: {}
S3Key:
type: string
RevisionLocationType:
type: string
enum:
- S3
- GitHub
- String
- AppSpecContent
S3Bucket:
type: string
ApplicationDoesNotExistException: {}
CommitId:
type: string
BundleType:
type: string
enum:
- tar
- tgz
- zip
- YAML
- JSON
Description:
type: string
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.
InvalidApplicationNameException: {}
DescriptionTooLongException: {}
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codedeploy/
x-hasEquivalentPaths: true