openapi: 3.0.0 info: version: '2014-10-06' x-release: v4 title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.BatchGetApplications API' 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:

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

' 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.BatchGetApplications' paths: /#X-Amz-Target=CodeDeploy_20141006.BatchGetApplications: 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: BatchGetApplications description: Gets information about one or more applications. The maximum number of applications that can be returned is 100. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetApplicationsOutput' examples: BatchGetApplications200Example: summary: Default BatchGetApplications 200 response x-microcks-default: true value: applicationsInfo: example-value '480': description: ApplicationNameRequiredException content: application/json: schema: $ref: '#/components/schemas/ApplicationNameRequiredException' examples: BatchGetApplications480Example: summary: Default BatchGetApplications 480 response x-microcks-default: true value: example-value '481': description: InvalidApplicationNameException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationNameException' examples: BatchGetApplications481Example: summary: Default BatchGetApplications 481 response x-microcks-default: true value: example-value '482': description: ApplicationDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/ApplicationDoesNotExistException' examples: BatchGetApplications482Example: summary: Default BatchGetApplications 482 response x-microcks-default: true value: example-value '483': description: BatchLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchLimitExceededException' examples: BatchGetApplications483Example: summary: Default BatchGetApplications 483 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchGetApplicationsInput' examples: BatchGetApplicationsRequestExample: summary: Default BatchGetApplications request x-microcks-default: true value: applicationNames: example-resource parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.BatchGetApplications summary: Amazon CodeDeploy Batch Get Applications x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=CodeDeploy 20141006.BatchGetApplications' components: schemas: 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. ApplicationsList: type: array items: $ref: '#/components/schemas/ApplicationName' ComputePlatform: type: string enum: - Server - Lambda - ECS ApplicationName: type: string minLength: 1 maxLength: 100 Boolean: type: boolean ApplicationId: type: string 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. BatchLimitExceededException: {} ApplicationsInfoList: type: array items: $ref: '#/components/schemas/ApplicationInfo' ApplicationNameRequiredException: {} ApplicationDoesNotExistException: {} Timestamp: type: string format: date-time InvalidApplicationNameException: {} GitHubAccountTokenName: type: string BatchGetApplicationsOutput: type: object properties: applicationsInfo: allOf: - $ref: '#/components/schemas/ApplicationsInfoList' - description: Information about the applications. description: Represents the output of a BatchGetApplications operation. 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 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