{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-codedeploy","description":"AWS CodeDeploy","version":"2014-10-06","base_url":"","endpoints":47,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS CodeDeploy\n@version 2014-10-06\n@auth AWS SigV4\n@endpoints 47\n@hint download_for_search\n@toc root(47)\n\n@endpoint POST /\n@desc Adds tags to on-premises instances.\n@required {tags: [Tag], instanceNames: [str]}\n\n@endpoint POST /\n@desc Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.\n@required {applicationName: str, revisions: [RevisionLocation]}\n@returns(200) {applicationName: str?, errorMessage: str?, revisions: [RevisionInfo]?}\n\n@endpoint POST /\n@desc Gets information about one or more applications. The maximum number of applications that can be returned is 100.\n@required {applicationNames: [str]}\n@returns(200) {applicationsInfo: [ApplicationInfo]?}\n\n@endpoint POST /\n@desc Gets information about one or more deployment groups.\n@required {applicationName: str, deploymentGroupNames: [str]}\n@returns(200) {deploymentGroupsInfo: [DeploymentGroupInfo]?, errorMessage: str?}\n\n@endpoint POST /\n@desc 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.\n@required {deploymentId: str, instanceIds: [str]}\n@returns(200) {instancesSummary: [InstanceSummary]?, errorMessage: str?}\n\n@endpoint POST /\n@desc 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.\n@required {deploymentId: str, targetIds: [str]}\n@returns(200) {deploymentTargets: [DeploymentTarget]?}\n\n@endpoint POST /\n@desc Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.\n@required {deploymentIds: [str]}\n@returns(200) {deploymentsInfo: [DeploymentInfo]?}\n\n@endpoint POST /\n@desc Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.\n@required {instanceNames: [str]}\n@returns(200) {instanceInfos: [InstanceInfo]?}\n\n@endpoint POST /\n@desc For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)\n@optional {deploymentId: str, deploymentWaitType: str}\n\n@endpoint POST /\n@desc Creates an application.\n@required {applicationName: str}\n@optional {computePlatform: str, tags: [Tag]}\n@returns(200) {applicationId: str?}\n\n@endpoint POST /\n@desc Deploys an application revision through the specified deployment group.\n@required {applicationName: str}\n@optional {deploymentGroupName: str, revision: RevisionLocation, deploymentConfigName: str, description: str, ignoreApplicationStopFailures: bool, targetInstances: TargetInstances, autoRollbackConfiguration: AutoRollbackConfiguration, updateOutdatedInstancesOnly: bool, fileExistsBehavior: str, overrideAlarmConfiguration: AlarmConfiguration}\n@returns(200) {deploymentId: str?}\n\n@endpoint POST /\n@desc Creates a deployment configuration.\n@required {deploymentConfigName: str}\n@optional {minimumHealthyHosts: MinimumHealthyHosts, trafficRoutingConfig: TrafficRoutingConfig, computePlatform: str, zonalConfig: ZonalConfig}\n@returns(200) {deploymentConfigId: str?}\n\n@endpoint POST /\n@desc Creates a deployment group to which application revisions are deployed.\n@required {applicationName: str, deploymentGroupName: str, serviceRoleArn: str}\n@optional {deploymentConfigName: str, ec2TagFilters: [EC2TagFilter], onPremisesInstanceTagFilters: [TagFilter], autoScalingGroups: [str], triggerConfigurations: [TriggerConfig], alarmConfiguration: AlarmConfiguration, autoRollbackConfiguration: AutoRollbackConfiguration, outdatedInstancesStrategy: str, deploymentStyle: DeploymentStyle, blueGreenDeploymentConfiguration: BlueGreenDeploymentConfiguration, loadBalancerInfo: LoadBalancerInfo, ec2TagSet: EC2TagSet, ecsServices: [ECSService], onPremisesTagSet: OnPremisesTagSet, tags: [Tag], terminationHookEnabled: bool}\n@returns(200) {deploymentGroupId: str?}\n\n@endpoint POST /\n@desc Deletes an application.\n@required {applicationName: str}\n\n@endpoint POST /\n@desc Deletes a deployment configuration.  A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.\n@required {deploymentConfigName: str}\n\n@endpoint POST /\n@desc Deletes a deployment group.\n@required {applicationName: str, deploymentGroupName: str}\n@returns(200) {hooksNotCleanedUp: [AutoScalingGroup]?}\n\n@endpoint POST /\n@desc Deletes a GitHub account connection.\n@optional {tokenName: str}\n@returns(200) {tokenName: str?}\n\n@endpoint POST /\n@desc Deletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation.   It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation (GDPR) requirements.\n@optional {externalId: str}\n\n@endpoint POST /\n@desc Deregisters an on-premises instance.\n@required {instanceName: str}\n\n@endpoint POST /\n@desc Gets information about an application.\n@required {applicationName: str}\n@returns(200) {application: ApplicationInfo?{applicationId: str?, applicationName: str?, createTime: str(timestamp)?, linkedToGitHub: bool?, gitHubAccountName: str?, computePlatform: str?}}\n\n@endpoint POST /\n@desc Gets information about an application revision.\n@required {applicationName: str, revision: RevisionLocation}\n@returns(200) {applicationName: str?, revision: RevisionLocation?{revisionType: str?, s3Location: S3Location?{bucket: str?, key: str?, bundleType: str?, version: str?, eTag: str?}, gitHubLocation: GitHubLocation?{repository: str?, commitId: str?}, string: RawString?{content: str?, sha256: str?}, appSpecContent: AppSpecContent?{content: str?, sha256: str?}}, revisionInfo: GenericRevisionInfo?{description: str?, deploymentGroups: [str]?, firstUsedTime: str(timestamp)?, lastUsedTime: str(timestamp)?, registerTime: str(timestamp)?}}\n\n@endpoint POST /\n@desc 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.\n@required {deploymentId: str}\n@returns(200) {deploymentInfo: DeploymentInfo?{applicationName: str?, deploymentGroupName: str?, deploymentConfigName: str?, deploymentId: str?, previousRevision: RevisionLocation?{revisionType: str?, s3Location: S3Location?{bucket: str?, key: str?, bundleType: str?, version: str?, eTag: str?}, gitHubLocation: GitHubLocation?{repository: str?, commitId: str?}, string: RawString?{content: str?, sha256: str?}, appSpecContent: AppSpecContent?{content: str?, sha256: str?}}, revision: RevisionLocation?{revisionType: str?, s3Location: S3Location?{bucket: str?, key: str?, bundleType: str?, version: str?, eTag: str?}, gitHubLocation: GitHubLocation?{repository: str?, commitId: str?}, string: RawString?{content: str?, sha256: str?}, appSpecContent: AppSpecContent?{content: str?, sha256: str?}}, status: str?, errorInformation: ErrorInformation?{code: str?, message: str?}, createTime: str(timestamp)?, startTime: str(timestamp)?, completeTime: str(timestamp)?, deploymentOverview: DeploymentOverview?{Pending: int(i64)?, InProgress: int(i64)?, Succeeded: int(i64)?, Failed: int(i64)?, Skipped: int(i64)?, Ready: int(i64)?}, description: str?, creator: str?, ignoreApplicationStopFailures: bool?, autoRollbackConfiguration: AutoRollbackConfiguration?{enabled: bool?, events: [str]?}, updateOutdatedInstancesOnly: bool?, rollbackInfo: RollbackInfo?{rollbackDeploymentId: str?, rollbackTriggeringDeploymentId: str?, rollbackMessage: str?}, deploymentStyle: DeploymentStyle?{deploymentType: str?, deploymentOption: str?}, targetInstances: TargetInstances?{tagFilters: [EC2TagFilter]?, autoScalingGroups: [str]?, ec2TagSet: EC2TagSet?{ec2TagSetList: [[EC2TagFilter]]?}}, instanceTerminationWaitTimeStarted: bool?, blueGreenDeploymentConfiguration: BlueGreenDeploymentConfiguration?{terminateBlueInstancesOnDeploymentSuccess: BlueInstanceTerminationOption?{action: str?, terminationWaitTimeInMinutes: int?}, deploymentReadyOption: DeploymentReadyOption?{actionOnTimeout: str?, waitTimeInMinutes: int?}, greenFleetProvisioningOption: GreenFleetProvisioningOption?{action: str?}}, loadBalancerInfo: LoadBalancerInfo?{elbInfoList: [ELBInfo]?, targetGroupInfoList: [TargetGroupInfo]?, targetGroupPairInfoList: [TargetGroupPairInfo]?}, additionalDeploymentStatusInfo: str?, fileExistsBehavior: str?, deploymentStatusMessages: [str]?, computePlatform: str?, externalId: str?, relatedDeployments: RelatedDeployments?{autoUpdateOutdatedInstancesRootDeploymentId: str?, autoUpdateOutdatedInstancesDeploymentIds: [str]?}, overrideAlarmConfiguration: AlarmConfiguration?{enabled: bool?, ignorePollAlarmFailure: bool?, alarms: [Alarm]?}}}\n\n@endpoint POST /\n@desc Gets information about a deployment configuration.\n@required {deploymentConfigName: str}\n@returns(200) {deploymentConfigInfo: DeploymentConfigInfo?{deploymentConfigId: str?, deploymentConfigName: str?, minimumHealthyHosts: MinimumHealthyHosts?{type: str?, value: int?}, createTime: str(timestamp)?, computePlatform: str?, trafficRoutingConfig: TrafficRoutingConfig?{type: str?, timeBasedCanary: TimeBasedCanary?{canaryPercentage: int?, canaryInterval: int?}, timeBasedLinear: TimeBasedLinear?{linearPercentage: int?, linearInterval: int?}}, zonalConfig: ZonalConfig?{firstZoneMonitorDurationInSeconds: int(i64)?, monitorDurationInSeconds: int(i64)?, minimumHealthyHostsPerZone: MinimumHealthyHostsPerZone?{type: str?, value: int?}}}}\n\n@endpoint POST /\n@desc Gets information about a deployment group.\n@required {applicationName: str, deploymentGroupName: str}\n@returns(200) {deploymentGroupInfo: DeploymentGroupInfo?{applicationName: str?, deploymentGroupId: str?, deploymentGroupName: str?, deploymentConfigName: str?, ec2TagFilters: [EC2TagFilter]?, onPremisesInstanceTagFilters: [TagFilter]?, autoScalingGroups: [AutoScalingGroup]?, serviceRoleArn: str?, targetRevision: RevisionLocation?{revisionType: str?, s3Location: S3Location?{bucket: str?, key: str?, bundleType: str?, version: str?, eTag: str?}, gitHubLocation: GitHubLocation?{repository: str?, commitId: str?}, string: RawString?{content: str?, sha256: str?}, appSpecContent: AppSpecContent?{content: str?, sha256: str?}}, triggerConfigurations: [TriggerConfig]?, alarmConfiguration: AlarmConfiguration?{enabled: bool?, ignorePollAlarmFailure: bool?, alarms: [Alarm]?}, autoRollbackConfiguration: AutoRollbackConfiguration?{enabled: bool?, events: [str]?}, deploymentStyle: DeploymentStyle?{deploymentType: str?, deploymentOption: str?}, outdatedInstancesStrategy: str?, blueGreenDeploymentConfiguration: BlueGreenDeploymentConfiguration?{terminateBlueInstancesOnDeploymentSuccess: BlueInstanceTerminationOption?{action: str?, terminationWaitTimeInMinutes: int?}, deploymentReadyOption: DeploymentReadyOption?{actionOnTimeout: str?, waitTimeInMinutes: int?}, greenFleetProvisioningOption: GreenFleetProvisioningOption?{action: str?}}, loadBalancerInfo: LoadBalancerInfo?{elbInfoList: [ELBInfo]?, targetGroupInfoList: [TargetGroupInfo]?, targetGroupPairInfoList: [TargetGroupPairInfo]?}, lastSuccessfulDeployment: LastDeploymentInfo?{deploymentId: str?, status: str?, endTime: str(timestamp)?, createTime: str(timestamp)?}, lastAttemptedDeployment: LastDeploymentInfo?{deploymentId: str?, status: str?, endTime: str(timestamp)?, createTime: str(timestamp)?}, ec2TagSet: EC2TagSet?{ec2TagSetList: [[EC2TagFilter]]?}, onPremisesTagSet: OnPremisesTagSet?{onPremisesTagSetList: [[TagFilter]]?}, computePlatform: str?, ecsServices: [ECSService]?, terminationHookEnabled: bool?}}\n\n@endpoint POST /\n@desc Gets information about an instance as part of a deployment.\n@required {deploymentId: str, instanceId: str}\n@returns(200) {instanceSummary: InstanceSummary?{deploymentId: str?, instanceId: str?, status: str?, lastUpdatedAt: str(timestamp)?, lifecycleEvents: [LifecycleEvent]?, instanceType: str?}}\n\n@endpoint POST /\n@desc Returns information about a deployment target.\n@required {deploymentId: str, targetId: str}\n@returns(200) {deploymentTarget: DeploymentTarget?{deploymentTargetType: str?, instanceTarget: InstanceTarget?{deploymentId: str?, targetId: str?, targetArn: str?, status: str?, lastUpdatedAt: str(timestamp)?, lifecycleEvents: [LifecycleEvent]?, instanceLabel: str?}, lambdaTarget: LambdaTarget?{deploymentId: str?, targetId: str?, targetArn: str?, status: str?, lastUpdatedAt: str(timestamp)?, lifecycleEvents: [LifecycleEvent]?, lambdaFunctionInfo: LambdaFunctionInfo?{functionName: str?, functionAlias: str?, currentVersion: str?, targetVersion: str?, targetVersionWeight: num(f64)?}}, ecsTarget: ECSTarget?{deploymentId: str?, targetId: str?, targetArn: str?, lastUpdatedAt: str(timestamp)?, lifecycleEvents: [LifecycleEvent]?, status: str?, taskSetsInfo: [ECSTaskSet]?}, cloudFormationTarget: CloudFormationTarget?{deploymentId: str?, targetId: str?, lastUpdatedAt: str(timestamp)?, lifecycleEvents: [LifecycleEvent]?, status: str?, resourceType: str?, targetVersionWeight: num(f64)?}}}\n\n@endpoint POST /\n@desc Gets information about an on-premises instance.\n@required {instanceName: str}\n@returns(200) {instanceInfo: InstanceInfo?{instanceName: str?, iamSessionArn: str?, iamUserArn: str?, instanceArn: str?, registerTime: str(timestamp)?, deregisterTime: str(timestamp)?, tags: [Tag]?}}\n\n@endpoint POST /\n@desc Lists information about revisions for an application.\n@required {applicationName: str}\n@optional {sortBy: str, sortOrder: str, s3Bucket: str, s3KeyPrefix: str, deployed: str, nextToken: str}\n@returns(200) {revisions: [RevisionLocation]?, nextToken: str?}\n\n@endpoint POST /\n@desc Lists the applications registered with the user or Amazon Web Services account.\n@optional {nextToken: str}\n@returns(200) {applications: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc Lists the deployment configurations with the user or Amazon Web Services account.\n@optional {nextToken: str}\n@returns(200) {deploymentConfigsList: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.\n@required {applicationName: str}\n@optional {nextToken: str}\n@returns(200) {applicationName: str?, deploymentGroups: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc 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 user or Amazon Web Services account.\n@required {deploymentId: str}\n@optional {nextToken: str, instanceStatusFilter: [str], instanceTypeFilter: [str]}\n@returns(200) {instancesList: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc Returns an array of target IDs that are associated a deployment.\n@required {deploymentId: str}\n@optional {nextToken: str, targetFilters: map<str,[str]>}\n@returns(200) {targetIds: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.\n@optional {applicationName: str, deploymentGroupName: str, externalId: str, includeOnlyStatuses: [str], createTimeRange: TimeRange, nextToken: str}\n@returns(200) {deployments: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc Lists the names of stored connections to GitHub accounts.\n@optional {nextToken: str}\n@returns(200) {tokenNameList: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc 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.\n@optional {registrationStatus: str, tagFilters: [TagFilter], nextToken: str}\n@returns(200) {instanceNames: [str]?, nextToken: str?}\n\n@endpoint POST /\n@desc 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.\n@required {ResourceArn: str}\n@optional {NextToken: str}\n@returns(200) {Tags: [Tag]?, NextToken: str?}\n\n@endpoint POST /\n@desc 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 are BeforeAllowTraffic 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.\n@optional {deploymentId: str, lifecycleEventHookExecutionId: str, status: str}\n@returns(200) {lifecycleEventHookExecutionId: str?}\n\n@endpoint POST /\n@desc Registers with CodeDeploy a revision for the specified application.\n@required {applicationName: str, revision: RevisionLocation}\n@optional {description: str}\n\n@endpoint POST /\n@desc 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.\n@required {instanceName: str}\n@optional {iamSessionArn: str, iamUserArn: str}\n\n@endpoint POST /\n@desc Removes one or more tags from one or more on-premises instances.\n@required {tags: [Tag], instanceNames: [str]}\n\n@endpoint POST /\n@desc In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.\n@optional {deploymentId: str}\n\n@endpoint POST /\n@desc Attempts to stop an ongoing deployment.\n@required {deploymentId: str}\n@optional {autoRollbackEnabled: bool}\n@returns(200) {status: str?, statusMessage: str?}\n\n@endpoint POST /\n@desc Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.\n@required {ResourceArn: str, Tags: [Tag]}\n\n@endpoint POST /\n@desc 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.\n@required {ResourceArn: str, TagKeys: [str]}\n\n@endpoint POST /\n@desc Changes the name of an application.\n@optional {applicationName: str, newApplicationName: str}\n\n@endpoint POST /\n@desc Changes information about a deployment group.\n@required {applicationName: str, currentDeploymentGroupName: str}\n@optional {newDeploymentGroupName: str, deploymentConfigName: str, ec2TagFilters: [EC2TagFilter], onPremisesInstanceTagFilters: [TagFilter], autoScalingGroups: [str], serviceRoleArn: str, triggerConfigurations: [TriggerConfig], alarmConfiguration: AlarmConfiguration, autoRollbackConfiguration: AutoRollbackConfiguration, outdatedInstancesStrategy: str, deploymentStyle: DeploymentStyle, blueGreenDeploymentConfiguration: BlueGreenDeploymentConfiguration, loadBalancerInfo: LoadBalancerInfo, ec2TagSet: EC2TagSet, ecsServices: [ECSService], onPremisesTagSet: OnPremisesTagSet, terminationHookEnabled: bool}\n@returns(200) {hooksNotCleanedUp: [AutoScalingGroup]?}\n\n@end\n"}