{ "version": "2.0", "metadata": { "apiVersion": "2014-10-06", "endpointPrefix": "codedeploy", "jsonVersion": "1.1", "protocol": "json", "protocols": [ "json" ], "serviceAbbreviation": "CodeDeploy", "serviceFullName": "AWS CodeDeploy", "serviceId": "CodeDeploy", "signatureVersion": "v4", "targetPrefix": "CodeDeploy_20141006", "uid": "codedeploy-2014-10-06", "auth": [ "aws.auth#sigv4" ] }, "operations": { "AddTagsToOnPremisesInstances": { "name": "AddTagsToOnPremisesInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AddTagsToOnPremisesInstancesInput" }, "errors": [ { "shape": "InstanceNameRequiredException" }, { "shape": "InvalidInstanceNameException" }, { "shape": "TagRequiredException" }, { "shape": "InvalidTagException" }, { "shape": "TagLimitExceededException" }, { "shape": "InstanceLimitExceededException" }, { "shape": "InstanceNotRegisteredException" } ], "documentation": "

Adds tags to on-premises instances.

" }, "BatchGetApplicationRevisions": { "name": "BatchGetApplicationRevisions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetApplicationRevisionsInput" }, "output": { "shape": "BatchGetApplicationRevisionsOutput" }, "errors": [ { "shape": "ApplicationDoesNotExistException" }, { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "RevisionRequiredException" }, { "shape": "InvalidRevisionException" }, { "shape": "BatchLimitExceededException" } ], "documentation": "

Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.

" }, "BatchGetApplications": { "name": "BatchGetApplications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetApplicationsInput" }, "output": { "shape": "BatchGetApplicationsOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "BatchLimitExceededException" } ], "documentation": "

Gets information about one or more applications. The maximum number of applications that can be returned is 100.

" }, "BatchGetDeploymentGroups": { "name": "BatchGetDeploymentGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetDeploymentGroupsInput" }, "output": { "shape": "BatchGetDeploymentGroupsOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "BatchLimitExceededException" }, { "shape": "DeploymentConfigDoesNotExistException" } ], "documentation": "

Gets information about one or more deployment groups.

" }, "BatchGetDeploymentInstances": { "name": "BatchGetDeploymentInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetDeploymentInstancesInput" }, "output": { "shape": "BatchGetDeploymentInstancesOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "InstanceIdRequiredException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "InvalidInstanceNameException" }, { "shape": "BatchLimitExceededException" }, { "shape": "InvalidComputePlatformException" } ], "documentation": "

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.

", "deprecated": true, "deprecatedMessage": "This operation is deprecated, use BatchGetDeploymentTargets instead." }, "BatchGetDeploymentTargets": { "name": "BatchGetDeploymentTargets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetDeploymentTargetsInput" }, "output": { "shape": "BatchGetDeploymentTargetsOutput" }, "errors": [ { "shape": "InvalidDeploymentIdException" }, { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentNotStartedException" }, { "shape": "DeploymentTargetIdRequiredException" }, { "shape": "InvalidDeploymentTargetIdException" }, { "shape": "DeploymentTargetDoesNotExistException" }, { "shape": "DeploymentTargetListSizeExceededException" }, { "shape": "InstanceDoesNotExistException" } ], "documentation": "

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:

" }, "BatchGetDeployments": { "name": "BatchGetDeployments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetDeploymentsInput" }, "output": { "shape": "BatchGetDeploymentsOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "BatchLimitExceededException" } ], "documentation": "

Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.

" }, "BatchGetOnPremisesInstances": { "name": "BatchGetOnPremisesInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchGetOnPremisesInstancesInput" }, "output": { "shape": "BatchGetOnPremisesInstancesOutput" }, "errors": [ { "shape": "InstanceNameRequiredException" }, { "shape": "InvalidInstanceNameException" }, { "shape": "BatchLimitExceededException" } ], "documentation": "

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

" }, "ContinueDeployment": { "name": "ContinueDeployment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ContinueDeploymentInput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentAlreadyCompletedException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "DeploymentIsNotInReadyStateException" }, { "shape": "UnsupportedActionForDeploymentTypeException" }, { "shape": "InvalidDeploymentWaitTypeException" }, { "shape": "InvalidDeploymentStatusException" } ], "documentation": "

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.)

" }, "CreateApplication": { "name": "CreateApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateApplicationInput" }, "output": { "shape": "CreateApplicationOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationAlreadyExistsException" }, { "shape": "ApplicationLimitExceededException" }, { "shape": "InvalidComputePlatformException" }, { "shape": "InvalidTagsToAddException" } ], "documentation": "

Creates an application.

" }, "CreateDeployment": { "name": "CreateDeployment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDeploymentInput" }, "output": { "shape": "CreateDeploymentOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "RevisionRequiredException" }, { "shape": "RevisionDoesNotExistException" }, { "shape": "InvalidRevisionException" }, { "shape": "InvalidDeploymentConfigNameException" }, { "shape": "DeploymentConfigDoesNotExistException" }, { "shape": "DescriptionTooLongException" }, { "shape": "DeploymentLimitExceededException" }, { "shape": "InvalidTargetInstancesException" }, { "shape": "InvalidAlarmConfigException" }, { "shape": "AlarmsLimitExceededException" }, { "shape": "InvalidAutoRollbackConfigException" }, { "shape": "InvalidLoadBalancerInfoException" }, { "shape": "InvalidFileExistsBehaviorException" }, { "shape": "InvalidRoleException" }, { "shape": "InvalidAutoScalingGroupException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidUpdateOutdatedInstancesOnlyValueException" }, { "shape": "InvalidIgnoreApplicationStopFailuresValueException" }, { "shape": "InvalidGitHubAccountTokenException" }, { "shape": "InvalidTrafficRoutingConfigurationException" } ], "documentation": "

Deploys an application revision through the specified deployment group.

" }, "CreateDeploymentConfig": { "name": "CreateDeploymentConfig", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDeploymentConfigInput" }, "output": { "shape": "CreateDeploymentConfigOutput" }, "errors": [ { "shape": "InvalidDeploymentConfigNameException" }, { "shape": "DeploymentConfigNameRequiredException" }, { "shape": "DeploymentConfigAlreadyExistsException" }, { "shape": "InvalidMinimumHealthyHostValueException" }, { "shape": "DeploymentConfigLimitExceededException" }, { "shape": "InvalidComputePlatformException" }, { "shape": "InvalidTrafficRoutingConfigurationException" }, { "shape": "InvalidZonalDeploymentConfigurationException" } ], "documentation": "

Creates a deployment configuration.

" }, "CreateDeploymentGroup": { "name": "CreateDeploymentGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDeploymentGroupInput" }, "output": { "shape": "CreateDeploymentGroupOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "DeploymentGroupAlreadyExistsException" }, { "shape": "InvalidEC2TagException" }, { "shape": "InvalidTagException" }, { "shape": "InvalidAutoScalingGroupException" }, { "shape": "InvalidDeploymentConfigNameException" }, { "shape": "DeploymentConfigDoesNotExistException" }, { "shape": "RoleRequiredException" }, { "shape": "InvalidRoleException" }, { "shape": "DeploymentGroupLimitExceededException" }, { "shape": "LifecycleHookLimitExceededException" }, { "shape": "InvalidTriggerConfigException" }, { "shape": "TriggerTargetsLimitExceededException" }, { "shape": "InvalidAlarmConfigException" }, { "shape": "AlarmsLimitExceededException" }, { "shape": "InvalidAutoRollbackConfigException" }, { "shape": "InvalidLoadBalancerInfoException" }, { "shape": "InvalidDeploymentStyleException" }, { "shape": "InvalidBlueGreenDeploymentConfigurationException" }, { "shape": "InvalidEC2TagCombinationException" }, { "shape": "InvalidOnPremisesTagCombinationException" }, { "shape": "TagSetListLimitExceededException" }, { "shape": "InvalidInputException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidECSServiceException" }, { "shape": "InvalidTargetGroupPairException" }, { "shape": "ECSServiceMappingLimitExceededException" }, { "shape": "InvalidTagsToAddException" }, { "shape": "InvalidTrafficRoutingConfigurationException" } ], "documentation": "

Creates a deployment group to which application revisions are deployed.

" }, "DeleteApplication": { "name": "DeleteApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteApplicationInput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "InvalidRoleException" } ], "documentation": "

Deletes an application.

" }, "DeleteDeploymentConfig": { "name": "DeleteDeploymentConfig", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteDeploymentConfigInput" }, "errors": [ { "shape": "InvalidDeploymentConfigNameException" }, { "shape": "DeploymentConfigNameRequiredException" }, { "shape": "DeploymentConfigInUseException" }, { "shape": "InvalidOperationException" } ], "documentation": "

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

" }, "DeleteDeploymentGroup": { "name": "DeleteDeploymentGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteDeploymentGroupInput" }, "output": { "shape": "DeleteDeploymentGroupOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "InvalidRoleException" } ], "documentation": "

Deletes a deployment group.

" }, "DeleteGitHubAccountToken": { "name": "DeleteGitHubAccountToken", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteGitHubAccountTokenInput" }, "output": { "shape": "DeleteGitHubAccountTokenOutput" }, "errors": [ { "shape": "GitHubAccountTokenNameRequiredException" }, { "shape": "GitHubAccountTokenDoesNotExistException" }, { "shape": "InvalidGitHubAccountTokenNameException" }, { "shape": "ResourceValidationException" }, { "shape": "OperationNotSupportedException" } ], "documentation": "

Deletes a GitHub account connection.

" }, "DeleteResourcesByExternalId": { "name": "DeleteResourcesByExternalId", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteResourcesByExternalIdInput" }, "output": { "shape": "DeleteResourcesByExternalIdOutput" }, "errors": [], "documentation": "

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.

" }, "DeregisterOnPremisesInstance": { "name": "DeregisterOnPremisesInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterOnPremisesInstanceInput" }, "errors": [ { "shape": "InstanceNameRequiredException" }, { "shape": "InvalidInstanceNameException" } ], "documentation": "

Deregisters an on-premises instance.

" }, "GetApplication": { "name": "GetApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetApplicationInput" }, "output": { "shape": "GetApplicationOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" } ], "documentation": "

Gets information about an application.

" }, "GetApplicationRevision": { "name": "GetApplicationRevision", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetApplicationRevisionInput" }, "output": { "shape": "GetApplicationRevisionOutput" }, "errors": [ { "shape": "ApplicationDoesNotExistException" }, { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "RevisionDoesNotExistException" }, { "shape": "RevisionRequiredException" }, { "shape": "InvalidRevisionException" } ], "documentation": "

Gets information about an application revision.

" }, "GetDeployment": { "name": "GetDeployment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeploymentInput" }, "output": { "shape": "GetDeploymentOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "DeploymentDoesNotExistException" } ], "documentation": "

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.

" }, "GetDeploymentConfig": { "name": "GetDeploymentConfig", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeploymentConfigInput" }, "output": { "shape": "GetDeploymentConfigOutput" }, "errors": [ { "shape": "InvalidDeploymentConfigNameException" }, { "shape": "DeploymentConfigNameRequiredException" }, { "shape": "DeploymentConfigDoesNotExistException" }, { "shape": "InvalidComputePlatformException" } ], "documentation": "

Gets information about a deployment configuration.

" }, "GetDeploymentGroup": { "name": "GetDeploymentGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeploymentGroupInput" }, "output": { "shape": "GetDeploymentGroupOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "DeploymentConfigDoesNotExistException" } ], "documentation": "

Gets information about a deployment group.

" }, "GetDeploymentInstance": { "name": "GetDeploymentInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeploymentInstanceInput" }, "output": { "shape": "GetDeploymentInstanceOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "InstanceIdRequiredException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "InstanceDoesNotExistException" }, { "shape": "InvalidInstanceNameException" }, { "shape": "InvalidComputePlatformException" } ], "documentation": "

Gets information about an instance as part of a deployment.

", "deprecated": true, "deprecatedMessage": "This operation is deprecated, use GetDeploymentTarget instead." }, "GetDeploymentTarget": { "name": "GetDeploymentTarget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeploymentTargetInput" }, "output": { "shape": "GetDeploymentTargetOutput" }, "errors": [ { "shape": "InvalidDeploymentIdException" }, { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentNotStartedException" }, { "shape": "DeploymentTargetIdRequiredException" }, { "shape": "InvalidDeploymentTargetIdException" }, { "shape": "DeploymentTargetDoesNotExistException" }, { "shape": "InvalidInstanceNameException" } ], "documentation": "

Returns information about a deployment target.

" }, "GetOnPremisesInstance": { "name": "GetOnPremisesInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetOnPremisesInstanceInput" }, "output": { "shape": "GetOnPremisesInstanceOutput" }, "errors": [ { "shape": "InstanceNameRequiredException" }, { "shape": "InstanceNotRegisteredException" }, { "shape": "InvalidInstanceNameException" } ], "documentation": "

Gets information about an on-premises instance.

" }, "ListApplicationRevisions": { "name": "ListApplicationRevisions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListApplicationRevisionsInput" }, "output": { "shape": "ListApplicationRevisionsOutput" }, "errors": [ { "shape": "ApplicationDoesNotExistException" }, { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "InvalidSortByException" }, { "shape": "InvalidSortOrderException" }, { "shape": "InvalidBucketNameFilterException" }, { "shape": "InvalidKeyPrefixFilterException" }, { "shape": "BucketNameFilterRequiredException" }, { "shape": "InvalidDeployedStateFilterException" }, { "shape": "InvalidNextTokenException" } ], "documentation": "

Lists information about revisions for an application.

" }, "ListApplications": { "name": "ListApplications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListApplicationsInput" }, "output": { "shape": "ListApplicationsOutput" }, "errors": [ { "shape": "InvalidNextTokenException" } ], "documentation": "

Lists the applications registered with the user or Amazon Web Services account.

" }, "ListDeploymentConfigs": { "name": "ListDeploymentConfigs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDeploymentConfigsInput" }, "output": { "shape": "ListDeploymentConfigsOutput" }, "errors": [ { "shape": "InvalidNextTokenException" } ], "documentation": "

Lists the deployment configurations with the user or Amazon Web Services account.

" }, "ListDeploymentGroups": { "name": "ListDeploymentGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDeploymentGroupsInput" }, "output": { "shape": "ListDeploymentGroupsOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "InvalidNextTokenException" } ], "documentation": "

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

" }, "ListDeploymentInstances": { "name": "ListDeploymentInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDeploymentInstancesInput" }, "output": { "shape": "ListDeploymentInstancesOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentNotStartedException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "InvalidInstanceStatusException" }, { "shape": "InvalidInstanceTypeException" }, { "shape": "InvalidDeploymentInstanceTypeException" }, { "shape": "InvalidTargetFilterNameException" }, { "shape": "InvalidComputePlatformException" } ], "documentation": "

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.

", "deprecated": true, "deprecatedMessage": "This operation is deprecated, use ListDeploymentTargets instead." }, "ListDeploymentTargets": { "name": "ListDeploymentTargets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDeploymentTargetsInput" }, "output": { "shape": "ListDeploymentTargetsOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentNotStartedException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "InvalidInstanceStatusException" }, { "shape": "InvalidInstanceTypeException" }, { "shape": "InvalidDeploymentInstanceTypeException" }, { "shape": "InvalidTargetFilterNameException" } ], "documentation": "

Returns an array of target IDs that are associated a deployment.

" }, "ListDeployments": { "name": "ListDeployments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDeploymentsInput" }, "output": { "shape": "ListDeploymentsOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "InvalidTimeRangeException" }, { "shape": "InvalidDeploymentStatusException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidExternalIdException" }, { "shape": "InvalidInputException" } ], "documentation": "

Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.

" }, "ListGitHubAccountTokenNames": { "name": "ListGitHubAccountTokenNames", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListGitHubAccountTokenNamesInput" }, "output": { "shape": "ListGitHubAccountTokenNamesOutput" }, "errors": [ { "shape": "InvalidNextTokenException" }, { "shape": "ResourceValidationException" }, { "shape": "OperationNotSupportedException" } ], "documentation": "

Lists the names of stored connections to GitHub accounts.

" }, "ListOnPremisesInstances": { "name": "ListOnPremisesInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListOnPremisesInstancesInput" }, "output": { "shape": "ListOnPremisesInstancesOutput" }, "errors": [ { "shape": "InvalidRegistrationStatusException" }, { "shape": "InvalidTagFilterException" }, { "shape": "InvalidNextTokenException" } ], "documentation": "

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.

" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceInput" }, "output": { "shape": "ListTagsForResourceOutput" }, "errors": [ { "shape": "ArnNotSupportedException" }, { "shape": "InvalidArnException" }, { "shape": "ResourceArnRequiredException" } ], "documentation": "

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.

" }, "PutLifecycleEventHookExecutionStatus": { "name": "PutLifecycleEventHookExecutionStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutLifecycleEventHookExecutionStatusInput" }, "output": { "shape": "PutLifecycleEventHookExecutionStatusOutput" }, "errors": [ { "shape": "InvalidLifecycleEventHookExecutionStatusException" }, { "shape": "InvalidLifecycleEventHookExecutionIdException" }, { "shape": "LifecycleEventAlreadyCompletedException" }, { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "UnsupportedActionForDeploymentTypeException" } ], "documentation": "

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.

" }, "RegisterApplicationRevision": { "name": "RegisterApplicationRevision", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterApplicationRevisionInput" }, "errors": [ { "shape": "ApplicationDoesNotExistException" }, { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "DescriptionTooLongException" }, { "shape": "RevisionRequiredException" }, { "shape": "InvalidRevisionException" } ], "documentation": "

Registers with CodeDeploy a revision for the specified application.

" }, "RegisterOnPremisesInstance": { "name": "RegisterOnPremisesInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterOnPremisesInstanceInput" }, "errors": [ { "shape": "InstanceNameAlreadyRegisteredException" }, { "shape": "IamArnRequiredException" }, { "shape": "IamSessionArnAlreadyRegisteredException" }, { "shape": "IamUserArnAlreadyRegisteredException" }, { "shape": "InstanceNameRequiredException" }, { "shape": "IamUserArnRequiredException" }, { "shape": "InvalidInstanceNameException" }, { "shape": "InvalidIamSessionArnException" }, { "shape": "InvalidIamUserArnException" }, { "shape": "MultipleIamArnsProvidedException" } ], "documentation": "

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.

" }, "RemoveTagsFromOnPremisesInstances": { "name": "RemoveTagsFromOnPremisesInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RemoveTagsFromOnPremisesInstancesInput" }, "errors": [ { "shape": "InstanceNameRequiredException" }, { "shape": "InvalidInstanceNameException" }, { "shape": "TagRequiredException" }, { "shape": "InvalidTagException" }, { "shape": "TagLimitExceededException" }, { "shape": "InstanceLimitExceededException" }, { "shape": "InstanceNotRegisteredException" } ], "documentation": "

Removes one or more tags from one or more on-premises instances.

" }, "SkipWaitTimeForInstanceTermination": { "name": "SkipWaitTimeForInstanceTermination", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SkipWaitTimeForInstanceTerminationInput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentAlreadyCompletedException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "DeploymentNotStartedException" }, { "shape": "UnsupportedActionForDeploymentTypeException" } ], "documentation": "

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.

", "deprecated": true, "deprecatedMessage": "This operation is deprecated, use ContinueDeployment with DeploymentWaitType instead." }, "StopDeployment": { "name": "StopDeployment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopDeploymentInput" }, "output": { "shape": "StopDeploymentOutput" }, "errors": [ { "shape": "DeploymentIdRequiredException" }, { "shape": "DeploymentDoesNotExistException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "DeploymentAlreadyCompletedException" }, { "shape": "InvalidDeploymentIdException" }, { "shape": "UnsupportedActionForDeploymentTypeException" } ], "documentation": "

Attempts to stop an ongoing deployment.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceInput" }, "output": { "shape": "TagResourceOutput" }, "errors": [ { "shape": "ResourceArnRequiredException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "DeploymentConfigDoesNotExistException" }, { "shape": "TagRequiredException" }, { "shape": "InvalidTagsToAddException" }, { "shape": "ArnNotSupportedException" }, { "shape": "InvalidArnException" } ], "documentation": "

Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.

" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceInput" }, "output": { "shape": "UntagResourceOutput" }, "errors": [ { "shape": "ResourceArnRequiredException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "DeploymentConfigDoesNotExistException" }, { "shape": "TagRequiredException" }, { "shape": "InvalidTagsToAddException" }, { "shape": "ArnNotSupportedException" }, { "shape": "InvalidArnException" } ], "documentation": "

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.

" }, "UpdateApplication": { "name": "UpdateApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateApplicationInput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationAlreadyExistsException" }, { "shape": "ApplicationDoesNotExistException" } ], "documentation": "

Changes the name of an application.

" }, "UpdateDeploymentGroup": { "name": "UpdateDeploymentGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateDeploymentGroupInput" }, "output": { "shape": "UpdateDeploymentGroupOutput" }, "errors": [ { "shape": "ApplicationNameRequiredException" }, { "shape": "InvalidApplicationNameException" }, { "shape": "ApplicationDoesNotExistException" }, { "shape": "InvalidDeploymentGroupNameException" }, { "shape": "DeploymentGroupAlreadyExistsException" }, { "shape": "DeploymentGroupNameRequiredException" }, { "shape": "DeploymentGroupDoesNotExistException" }, { "shape": "InvalidEC2TagException" }, { "shape": "InvalidTagException" }, { "shape": "InvalidAutoScalingGroupException" }, { "shape": "InvalidDeploymentConfigNameException" }, { "shape": "DeploymentConfigDoesNotExistException" }, { "shape": "InvalidRoleException" }, { "shape": "LifecycleHookLimitExceededException" }, { "shape": "InvalidTriggerConfigException" }, { "shape": "TriggerTargetsLimitExceededException" }, { "shape": "InvalidAlarmConfigException" }, { "shape": "AlarmsLimitExceededException" }, { "shape": "InvalidAutoRollbackConfigException" }, { "shape": "InvalidLoadBalancerInfoException" }, { "shape": "InvalidDeploymentStyleException" }, { "shape": "InvalidBlueGreenDeploymentConfigurationException" }, { "shape": "InvalidEC2TagCombinationException" }, { "shape": "InvalidOnPremisesTagCombinationException" }, { "shape": "TagSetListLimitExceededException" }, { "shape": "InvalidInputException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidECSServiceException" }, { "shape": "InvalidTargetGroupPairException" }, { "shape": "ECSServiceMappingLimitExceededException" }, { "shape": "InvalidTrafficRoutingConfigurationException" } ], "documentation": "

Changes information about a deployment group.

" } }, "shapes": { "AddTagsToOnPremisesInstancesInput": { "type": "structure", "required": [ "tags", "instanceNames" ], "members": { "tags": { "shape": "TagList", "documentation": "

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": { "shape": "InstanceNameList", "documentation": "

The names of the on-premises instances to which to add tags.

" } }, "documentation": "

Represents the input of, and adds tags to, an on-premises instance operation.

" }, "AdditionalDeploymentStatusInfo": { "type": "string", "deprecated": true, "deprecatedMessage": "AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead." }, "Alarm": { "type": "structure", "members": { "name": { "shape": "AlarmName", "documentation": "

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

" } }, "documentation": "

Information about an alarm.

" }, "AlarmConfiguration": { "type": "structure", "members": { "enabled": { "shape": "Boolean", "documentation": "

Indicates whether the alarm configuration is enabled.

" }, "ignorePollAlarmFailure": { "shape": "Boolean", "documentation": "

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.

" }, "alarms": { "shape": "AlarmList", "documentation": "

A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.

" } }, "documentation": "

Information about alarms associated with a deployment or deployment group.

" }, "AlarmList": { "type": "list", "member": { "shape": "Alarm" } }, "AlarmName": { "type": "string" }, "AppSpecContent": { "type": "structure", "members": { "content": { "shape": "RawStringContent", "documentation": "

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.

" }, "sha256": { "shape": "RawStringSha256", "documentation": "

The SHA256 hash value of the revision content.

" } }, "documentation": "

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 RawString data type.

" }, "ApplicationId": { "type": "string" }, "ApplicationInfo": { "type": "structure", "members": { "applicationId": { "shape": "ApplicationId", "documentation": "

The application ID.

" }, "applicationName": { "shape": "ApplicationName", "documentation": "

The application name.

" }, "createTime": { "shape": "Timestamp", "documentation": "

The time at which the application was created.

" }, "linkedToGitHub": { "shape": "Boolean", "documentation": "

True if the user has authenticated with GitHub for the specified application. Otherwise, false.

" }, "gitHubAccountName": { "shape": "GitHubAccountTokenName", "documentation": "

The name for a connection to a GitHub account.

" }, "computePlatform": { "shape": "ComputePlatform", "documentation": "

The destination platform type for deployment of the application (Lambda or Server).

" } }, "documentation": "

Information about an application.

" }, "ApplicationName": { "type": "string", "max": 100, "min": 1 }, "ApplicationRevisionSortBy": { "type": "string", "enum": [ "registerTime", "firstUsedTime", "lastUsedTime" ] }, "ApplicationsInfoList": { "type": "list", "member": { "shape": "ApplicationInfo" } }, "ApplicationsList": { "type": "list", "member": { "shape": "ApplicationName" } }, "Arn": { "type": "string", "max": 1011, "min": 1 }, "AutoRollbackConfiguration": { "type": "structure", "members": { "enabled": { "shape": "Boolean", "documentation": "

Indicates whether a defined automatic rollback configuration is currently enabled.

" }, "events": { "shape": "AutoRollbackEventsList", "documentation": "

The event type or types that trigger a rollback.

" } }, "documentation": "

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" ] }, "AutoRollbackEventsList": { "type": "list", "member": { "shape": "AutoRollbackEvent" } }, "AutoScalingGroup": { "type": "structure", "members": { "name": { "shape": "AutoScalingGroupName", "documentation": "

The Auto Scaling group name.

" }, "hook": { "shape": "AutoScalingGroupHook", "documentation": "

The name of the launch hook that CodeDeploy installed into the Auto Scaling group.

For more information about the launch hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.

" }, "terminationHook": { "shape": "AutoScalingGroupHook", "documentation": "

The name of the termination hook that CodeDeploy installed into the Auto Scaling group.

For more information about the termination hook, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

" } }, "documentation": "

Information about an Auto Scaling group.

" }, "AutoScalingGroupHook": { "type": "string" }, "AutoScalingGroupList": { "type": "list", "member": { "shape": "AutoScalingGroup" } }, "AutoScalingGroupName": { "type": "string" }, "AutoScalingGroupNameList": { "type": "list", "member": { "shape": "AutoScalingGroupName" } }, "BatchGetApplicationRevisionsInput": { "type": "structure", "required": [ "applicationName", "revisions" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application about which to get revision information.

" }, "revisions": { "shape": "RevisionLocationList", "documentation": "

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.

" } }, "documentation": "

Represents the input of a BatchGetApplicationRevisions operation.

" }, "BatchGetApplicationRevisionsOutput": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of the application that corresponds to the revisions.

" }, "errorMessage": { "shape": "ErrorMessage", "documentation": "

Information about errors that might have occurred during the API call.

" }, "revisions": { "shape": "RevisionInfoList", "documentation": "

Additional information about the revisions, including the type and location.

" } }, "documentation": "

Represents the output of a BatchGetApplicationRevisions operation.

" }, "BatchGetApplicationsInput": { "type": "structure", "required": [ "applicationNames" ], "members": { "applicationNames": { "shape": "ApplicationsList", "documentation": "

A list of application names separated by spaces. The maximum number of application names you can specify is 100.

" } }, "documentation": "

Represents the input of a BatchGetApplications operation.

" }, "BatchGetApplicationsOutput": { "type": "structure", "members": { "applicationsInfo": { "shape": "ApplicationsInfoList", "documentation": "

Information about the applications.

" } }, "documentation": "

Represents the output of a BatchGetApplications operation.

" }, "BatchGetDeploymentGroupsInput": { "type": "structure", "required": [ "applicationName", "deploymentGroupNames" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the applicable user or Amazon Web Services account.

" }, "deploymentGroupNames": { "shape": "DeploymentGroupsList", "documentation": "

The names of the deployment groups.

" } }, "documentation": "

Represents the input of a BatchGetDeploymentGroups operation.

" }, "BatchGetDeploymentGroupsOutput": { "type": "structure", "members": { "deploymentGroupsInfo": { "shape": "DeploymentGroupInfoList", "documentation": "

Information about the deployment groups.

" }, "errorMessage": { "shape": "ErrorMessage", "documentation": "

Information about errors that might have occurred during the API call.

" } }, "documentation": "

Represents the output of a BatchGetDeploymentGroups operation.

" }, "BatchGetDeploymentInstancesInput": { "type": "structure", "required": [ "deploymentId", "instanceIds" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "instanceIds": { "shape": "InstancesList", "documentation": "

The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.

" } }, "documentation": "

Represents the input of a BatchGetDeploymentInstances operation.

" }, "BatchGetDeploymentInstancesOutput": { "type": "structure", "members": { "instancesSummary": { "shape": "InstanceSummaryList", "documentation": "

Information about the instance.

" }, "errorMessage": { "shape": "ErrorMessage", "documentation": "

Information about errors that might have occurred during the API call.

" } }, "documentation": "

Represents the output of a BatchGetDeploymentInstances operation.

" }, "BatchGetDeploymentTargetsInput": { "type": "structure", "required": [ "deploymentId", "targetIds" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "targetIds": { "shape": "TargetIdList", "documentation": "

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.

" } } }, "BatchGetDeploymentTargetsOutput": { "type": "structure", "members": { "deploymentTargets": { "shape": "DeploymentTargetList", "documentation": "

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.

" } } }, "BatchGetDeploymentsInput": { "type": "structure", "required": [ "deploymentIds" ], "members": { "deploymentIds": { "shape": "DeploymentsList", "documentation": "

A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.

" } }, "documentation": "

Represents the input of a BatchGetDeployments operation.

" }, "BatchGetDeploymentsOutput": { "type": "structure", "members": { "deploymentsInfo": { "shape": "DeploymentsInfoList", "documentation": "

Information about the deployments.

" } }, "documentation": "

Represents the output of a BatchGetDeployments operation.

" }, "BatchGetOnPremisesInstancesInput": { "type": "structure", "required": [ "instanceNames" ], "members": { "instanceNames": { "shape": "InstanceNameList", "documentation": "

The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.

" } }, "documentation": "

Represents the input of a BatchGetOnPremisesInstances operation.

" }, "BatchGetOnPremisesInstancesOutput": { "type": "structure", "members": { "instanceInfos": { "shape": "InstanceInfoList", "documentation": "

Information about the on-premises instances.

" } }, "documentation": "

Represents the output of a BatchGetOnPremisesInstances operation.

" }, "BlueGreenDeploymentConfiguration": { "type": "structure", "members": { "terminateBlueInstancesOnDeploymentSuccess": { "shape": "BlueInstanceTerminationOption", "documentation": "

Information about whether to terminate instances in the original fleet during a blue/green deployment.

" }, "deploymentReadyOption": { "shape": "DeploymentReadyOption", "documentation": "

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

" }, "greenFleetProvisioningOption": { "shape": "GreenFleetProvisioningOption", "documentation": "

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

" } }, "documentation": "

Information about blue/green deployment options for a deployment group.

" }, "BlueInstanceTerminationOption": { "type": "structure", "members": { "action": { "shape": "InstanceAction", "documentation": "

The action to take on instances in the original environment after a successful blue/green deployment.

" }, "terminationWaitTimeInMinutes": { "shape": "Duration", "documentation": "

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).

" } }, "documentation": "

Information about whether instances in the original environment are terminated when a blue/green deployment is successful. BlueInstanceTerminationOption does not apply to Lambda deployments.

" }, "Boolean": { "type": "boolean" }, "BundleType": { "type": "string", "enum": [ "tar", "tgz", "zip", "YAML", "JSON" ] }, "CloudFormationResourceType": { "type": "string" }, "CloudFormationTarget": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of an CloudFormation blue/green deployment.

" }, "targetId": { "shape": "TargetId", "documentation": "

The unique ID of a deployment target that has a type of CloudFormationTarget.

" }, "lastUpdatedAt": { "shape": "Time", "documentation": "

The date and time when the target application was updated by an CloudFormation blue/green deployment.

" }, "lifecycleEvents": { "shape": "LifecycleEventList", "documentation": "

The lifecycle events of the CloudFormation blue/green deployment to this target application.

" }, "status": { "shape": "TargetStatus", "documentation": "

The status of an CloudFormation blue/green deployment's target application.

" }, "resourceType": { "shape": "CloudFormationResourceType", "documentation": "

The resource type for the CloudFormation blue/green deployment.

" }, "targetVersionWeight": { "shape": "TrafficWeight", "documentation": "

The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.

" } }, "documentation": "

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" }, "ComputePlatform": { "type": "string", "enum": [ "Server", "Lambda", "ECS" ] }, "ContinueDeploymentInput": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.

" }, "deploymentWaitType": { "shape": "DeploymentWaitType", "documentation": "

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.

" } } }, "CreateApplicationInput": { "type": "structure", "required": [ "applicationName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of the application. This name must be unique with the applicable user or Amazon Web Services account.

" }, "computePlatform": { "shape": "ComputePlatform", "documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" }, "tags": { "shape": "TagList", "documentation": "

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.

" } }, "documentation": "

Represents the input of a CreateApplication operation.

" }, "CreateApplicationOutput": { "type": "structure", "members": { "applicationId": { "shape": "ApplicationId", "documentation": "

A unique application ID.

" } }, "documentation": "

Represents the output of a CreateApplication operation.

" }, "CreateDeploymentConfigInput": { "type": "structure", "required": [ "deploymentConfigName" ], "members": { "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The name of the deployment configuration to create.

" }, "minimumHealthyHosts": { "shape": "MinimumHealthyHosts", "documentation": "

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:

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": { "shape": "TrafficRoutingConfig", "documentation": "

The configuration that specifies how the deployment traffic is routed.

" }, "computePlatform": { "shape": "ComputePlatform", "documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" }, "zonalConfig": { "shape": "ZonalConfig", "documentation": "

Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

" } }, "documentation": "

Represents the input of a CreateDeploymentConfig operation.

" }, "CreateDeploymentConfigOutput": { "type": "structure", "members": { "deploymentConfigId": { "shape": "DeploymentConfigId", "documentation": "

A unique deployment configuration ID.

" } }, "documentation": "

Represents the output of a CreateDeploymentConfig operation.

" }, "CreateDeploymentGroupInput": { "type": "structure", "required": [ "applicationName", "deploymentGroupName", "serviceRoleArn" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The name of a new deployment group for the specified application.

" }, "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

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": { "shape": "EC2TagFilterList", "documentation": "

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": { "shape": "TagFilterList", "documentation": "

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 as OnPremisesTagSet.

" }, "autoScalingGroups": { "shape": "AutoScalingGroupNameList", "documentation": "

A list of associated Amazon EC2 Auto Scaling groups.

" }, "serviceRoleArn": { "shape": "Role", "documentation": "

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": { "shape": "TriggerConfigList", "documentation": "

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": { "shape": "AlarmConfiguration", "documentation": "

Information to add about Amazon CloudWatch alarms when the deployment group is created.

" }, "autoRollbackConfiguration": { "shape": "AutoRollbackConfiguration", "documentation": "

Configuration information for an automatic rollback that is added when a deployment group is created.

" }, "outdatedInstancesStrategy": { "shape": "OutdatedInstancesStrategy", "documentation": "

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.

" }, "deploymentStyle": { "shape": "DeploymentStyle", "documentation": "

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

" }, "blueGreenDeploymentConfiguration": { "shape": "BlueGreenDeploymentConfiguration", "documentation": "

Information about blue/green deployment options for a deployment group.

" }, "loadBalancerInfo": { "shape": "LoadBalancerInfo", "documentation": "

Information about the load balancer used in a deployment.

" }, "ec2TagSet": { "shape": "EC2TagSet", "documentation": "

Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

" }, "ecsServices": { "shape": "ECSServiceList", "documentation": "

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": { "shape": "OnPremisesTagSet", "documentation": "

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": { "shape": "TagList", "documentation": "

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.

" }, "terminationHookEnabled": { "shape": "NullableBoolean", "documentation": "

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

" } }, "documentation": "

Represents the input of a CreateDeploymentGroup operation.

" }, "CreateDeploymentGroupOutput": { "type": "structure", "members": { "deploymentGroupId": { "shape": "DeploymentGroupId", "documentation": "

A unique deployment group ID.

" } }, "documentation": "

Represents the output of a CreateDeploymentGroup operation.

" }, "CreateDeploymentInput": { "type": "structure", "required": [ "applicationName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The name of the deployment group.

" }, "revision": { "shape": "RevisionLocation", "documentation": "

The type and location of the revision to deploy.

" }, "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The name of a deployment configuration associated with the 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.

" }, "description": { "shape": "Description", "documentation": "

A comment about the deployment.

" }, "ignoreApplicationStopFailures": { "shape": "Boolean", "documentation": "

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.

" }, "targetInstances": { "shape": "TargetInstances", "documentation": "

Information about the instances that belong to the replacement environment in a blue/green deployment.

" }, "autoRollbackConfiguration": { "shape": "AutoRollbackConfiguration", "documentation": "

Configuration information for an automatic rollback that is added when a deployment is created.

" }, "updateOutdatedInstancesOnly": { "shape": "Boolean", "documentation": "

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

" }, "fileExistsBehavior": { "shape": "FileExistsBehavior", "documentation": "

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:

" }, "overrideAlarmConfiguration": { "shape": "AlarmConfiguration", "documentation": "

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.

" } }, "documentation": "

Represents the input of a CreateDeployment operation.

" }, "CreateDeploymentOutput": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" } }, "documentation": "

Represents the output of a CreateDeployment operation.

" }, "DeleteApplicationInput": { "type": "structure", "required": [ "applicationName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" } }, "documentation": "

Represents the input of a DeleteApplication operation.

" }, "DeleteDeploymentConfigInput": { "type": "structure", "required": [ "deploymentConfigName" ], "members": { "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The name of a deployment configuration associated with the user or Amazon Web Services account.

" } }, "documentation": "

Represents the input of a DeleteDeploymentConfig operation.

" }, "DeleteDeploymentGroupInput": { "type": "structure", "required": [ "applicationName", "deploymentGroupName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The name of a deployment group for the specified application.

" } }, "documentation": "

Represents the input of a DeleteDeploymentGroup operation.

" }, "DeleteDeploymentGroupOutput": { "type": "structure", "members": { "hooksNotCleanedUp": { "shape": "AutoScalingGroupList", "documentation": "

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.

" } }, "documentation": "

Represents the output of a DeleteDeploymentGroup operation.

" }, "DeleteGitHubAccountTokenInput": { "type": "structure", "members": { "tokenName": { "shape": "GitHubAccountTokenName", "documentation": "

The name of the GitHub account connection to delete.

" } }, "documentation": "

Represents the input of a DeleteGitHubAccount operation.

" }, "DeleteGitHubAccountTokenOutput": { "type": "structure", "members": { "tokenName": { "shape": "GitHubAccountTokenName", "documentation": "

The name of the GitHub account connection that was deleted.

" } }, "documentation": "

Represents the output of a DeleteGitHubAccountToken operation.

" }, "DeleteResourcesByExternalIdInput": { "type": "structure", "members": { "externalId": { "shape": "ExternalId", "documentation": "

The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.

" } } }, "DeleteResourcesByExternalIdOutput": { "type": "structure", "members": {} }, "DeploymentConfigId": { "type": "string" }, "DeploymentConfigInfo": { "type": "structure", "members": { "deploymentConfigId": { "shape": "DeploymentConfigId", "documentation": "

The deployment configuration ID.

" }, "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The deployment configuration name.

" }, "minimumHealthyHosts": { "shape": "MinimumHealthyHosts", "documentation": "

Information about the number or percentage of minimum healthy instances.

" }, "createTime": { "shape": "Timestamp", "documentation": "

The time at which the deployment configuration was created.

" }, "computePlatform": { "shape": "ComputePlatform", "documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" }, "trafficRoutingConfig": { "shape": "TrafficRoutingConfig", "documentation": "

The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.

" }, "zonalConfig": { "shape": "ZonalConfig", "documentation": "

Information about a zonal configuration.

" } }, "documentation": "

Information about a deployment configuration.

" }, "DeploymentConfigName": { "type": "string", "max": 100, "min": 1 }, "DeploymentConfigsList": { "type": "list", "member": { "shape": "DeploymentConfigName" } }, "DeploymentCreator": { "type": "string", "enum": [ "user", "autoscaling", "codeDeployRollback", "CodeDeploy", "CodeDeployAutoUpdate", "CloudFormation", "CloudFormationRollback", "autoscalingTermination" ] }, "DeploymentGroupId": { "type": "string" }, "DeploymentGroupInfo": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The application name.

" }, "deploymentGroupId": { "shape": "DeploymentGroupId", "documentation": "

The deployment group ID.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The deployment group name.

" }, "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The deployment configuration name.

" }, "ec2TagFilters": { "shape": "EC2TagFilterList", "documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

" }, "onPremisesInstanceTagFilters": { "shape": "TagFilterList", "documentation": "

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.

" }, "autoScalingGroups": { "shape": "AutoScalingGroupList", "documentation": "

A list of associated Auto Scaling groups.

" }, "serviceRoleArn": { "shape": "Role", "documentation": "

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": { "shape": "RevisionLocation", "documentation": "

Information about the deployment group's target revision, including type and location.

" }, "triggerConfigurations": { "shape": "TriggerConfigList", "documentation": "

Information about triggers associated with the deployment group.

" }, "alarmConfiguration": { "shape": "AlarmConfiguration", "documentation": "

A list of alarms associated with the deployment group.

" }, "autoRollbackConfiguration": { "shape": "AutoRollbackConfiguration", "documentation": "

Information about the automatic rollback configuration associated with the deployment group.

" }, "deploymentStyle": { "shape": "DeploymentStyle", "documentation": "

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": { "shape": "OutdatedInstancesStrategy", "documentation": "

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.

" }, "blueGreenDeploymentConfiguration": { "shape": "BlueGreenDeploymentConfiguration", "documentation": "

Information about blue/green deployment options for a deployment group.

" }, "loadBalancerInfo": { "shape": "LoadBalancerInfo", "documentation": "

Information about the load balancer to use in a deployment.

" }, "lastSuccessfulDeployment": { "shape": "LastDeploymentInfo", "documentation": "

Information about the most recent successful deployment to the deployment group.

" }, "lastAttemptedDeployment": { "shape": "LastDeploymentInfo", "documentation": "

Information about the most recent attempted deployment to the deployment group.

" }, "ec2TagSet": { "shape": "EC2TagSet", "documentation": "

Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.

" }, "onPremisesTagSet": { "shape": "OnPremisesTagSet", "documentation": "

Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

" }, "computePlatform": { "shape": "ComputePlatform", "documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" }, "ecsServices": { "shape": "ECSServiceList", "documentation": "

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>.

" }, "terminationHookEnabled": { "shape": "Boolean", "documentation": "

Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.

" } }, "documentation": "

Information about a deployment group.

" }, "DeploymentGroupInfoList": { "type": "list", "member": { "shape": "DeploymentGroupInfo" } }, "DeploymentGroupName": { "type": "string", "max": 100, "min": 1 }, "DeploymentGroupsList": { "type": "list", "member": { "shape": "DeploymentGroupName" } }, "DeploymentId": { "type": "string" }, "DeploymentInfo": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The application name.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The deployment group name.

" }, "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The deployment configuration name.

" }, "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "previousRevision": { "shape": "RevisionLocation", "documentation": "

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

" }, "revision": { "shape": "RevisionLocation", "documentation": "

Information about the location of stored application artifacts and the service from which to retrieve them.

" }, "status": { "shape": "DeploymentStatus", "documentation": "

The current state of the deployment as a whole.

" }, "errorInformation": { "shape": "ErrorInformation", "documentation": "

Information about any error associated with this deployment.

" }, "createTime": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the deployment was created.

" }, "startTime": { "shape": "Timestamp", "documentation": "

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": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the deployment was complete.

" }, "deploymentOverview": { "shape": "DeploymentOverview", "documentation": "

A summary of the deployment status of the instances in the deployment.

" }, "description": { "shape": "Description", "documentation": "

A comment about the deployment.

" }, "creator": { "shape": "DeploymentCreator", "documentation": "

The means by which the deployment was created:

" }, "ignoreApplicationStopFailures": { "shape": "Boolean", "documentation": "

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.

" }, "autoRollbackConfiguration": { "shape": "AutoRollbackConfiguration", "documentation": "

Information about the automatic rollback configuration associated with the deployment.

" }, "updateOutdatedInstancesOnly": { "shape": "Boolean", "documentation": "

Indicates whether only instances that are not running the latest application revision are to be deployed to.

" }, "rollbackInfo": { "shape": "RollbackInfo", "documentation": "

Information about a deployment rollback.

" }, "deploymentStyle": { "shape": "DeploymentStyle", "documentation": "

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.

" }, "targetInstances": { "shape": "TargetInstances", "documentation": "

Information about the instances that belong to the replacement environment in a blue/green deployment.

" }, "instanceTerminationWaitTimeStarted": { "shape": "Boolean", "documentation": "

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

" }, "blueGreenDeploymentConfiguration": { "shape": "BlueGreenDeploymentConfiguration", "documentation": "

Information about blue/green deployment options for this deployment.

" }, "loadBalancerInfo": { "shape": "LoadBalancerInfo", "documentation": "

Information about the load balancer used in the deployment.

" }, "additionalDeploymentStatusInfo": { "shape": "AdditionalDeploymentStatusInfo", "documentation": "

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

" }, "fileExistsBehavior": { "shape": "FileExistsBehavior", "documentation": "

Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

" }, "deploymentStatusMessages": { "shape": "DeploymentStatusMessageList", "documentation": "

Messages that contain information about the status of a deployment.

" }, "computePlatform": { "shape": "ComputePlatform", "documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" }, "externalId": { "shape": "ExternalId", "documentation": "

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

" }, "relatedDeployments": { "shape": "RelatedDeployments" }, "overrideAlarmConfiguration": { "shape": "AlarmConfiguration" } }, "documentation": "

Information about a deployment.

" }, "DeploymentOption": { "type": "string", "enum": [ "WITH_TRAFFIC_CONTROL", "WITHOUT_TRAFFIC_CONTROL" ] }, "DeploymentOverview": { "type": "structure", "members": { "Pending": { "shape": "InstanceCount", "documentation": "

The number of instances in the deployment in a pending state.

" }, "InProgress": { "shape": "InstanceCount", "documentation": "

The number of instances in which the deployment is in progress.

" }, "Succeeded": { "shape": "InstanceCount", "documentation": "

The number of instances in the deployment to which revisions have been successfully deployed.

" }, "Failed": { "shape": "InstanceCount", "documentation": "

The number of instances in the deployment in a failed state.

" }, "Skipped": { "shape": "InstanceCount", "documentation": "

The number of instances in the deployment in a skipped state.

" }, "Ready": { "shape": "InstanceCount", "documentation": "

The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.

" } }, "documentation": "

Information about the deployment status of the instances in the deployment.

" }, "DeploymentReadyAction": { "type": "string", "enum": [ "CONTINUE_DEPLOYMENT", "STOP_DEPLOYMENT" ] }, "DeploymentReadyOption": { "type": "structure", "members": { "actionOnTimeout": { "shape": "DeploymentReadyAction", "documentation": "

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

" }, "waitTimeInMinutes": { "shape": "Duration", "documentation": "

The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout.

" } }, "documentation": "

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

" }, "DeploymentStatus": { "type": "string", "enum": [ "Created", "Queued", "InProgress", "Baking", "Succeeded", "Failed", "Stopped", "Ready" ] }, "DeploymentStatusList": { "type": "list", "member": { "shape": "DeploymentStatus" } }, "DeploymentStatusMessageList": { "type": "list", "member": { "shape": "ErrorMessage" } }, "DeploymentStyle": { "type": "structure", "members": { "deploymentType": { "shape": "DeploymentType", "documentation": "

Indicates whether to run an in-place deployment or a blue/green deployment.

" }, "deploymentOption": { "shape": "DeploymentOption", "documentation": "

Indicates whether to route deployment traffic behind a load balancer.

" } }, "documentation": "

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.

" }, "DeploymentTarget": { "type": "structure", "members": { "deploymentTargetType": { "shape": "DeploymentTargetType", "documentation": "

The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.

" }, "instanceTarget": { "shape": "InstanceTarget", "documentation": "

Information about the target for a deployment that uses the EC2/On-premises compute platform.

" }, "lambdaTarget": { "shape": "LambdaTarget", "documentation": "

Information about the target for a deployment that uses the Lambda compute platform.

" }, "ecsTarget": { "shape": "ECSTarget", "documentation": "

Information about the target for a deployment that uses the Amazon ECS compute platform.

" }, "cloudFormationTarget": { "shape": "CloudFormationTarget" } }, "documentation": "

Information about the deployment target.

" }, "DeploymentTargetList": { "type": "list", "member": { "shape": "DeploymentTarget" } }, "DeploymentTargetType": { "type": "string", "enum": [ "InstanceTarget", "LambdaTarget", "ECSTarget", "CloudFormationTarget" ] }, "DeploymentType": { "type": "string", "enum": [ "IN_PLACE", "BLUE_GREEN" ] }, "DeploymentWaitType": { "type": "string", "enum": [ "READY_WAIT", "TERMINATION_WAIT" ] }, "DeploymentsInfoList": { "type": "list", "member": { "shape": "DeploymentInfo" } }, "DeploymentsList": { "type": "list", "member": { "shape": "DeploymentId" } }, "DeregisterOnPremisesInstanceInput": { "type": "structure", "required": [ "instanceName" ], "members": { "instanceName": { "shape": "InstanceName", "documentation": "

The name of the on-premises instance to deregister.

" } }, "documentation": "

Represents the input of a DeregisterOnPremisesInstance operation.

" }, "Description": { "type": "string" }, "Diagnostics": { "type": "structure", "members": { "errorCode": { "shape": "LifecycleErrorCode", "documentation": "

The associated error code:

" }, "scriptName": { "shape": "ScriptName", "documentation": "

The name of the script.

" }, "message": { "shape": "LifecycleMessage", "documentation": "

The message associated with the error.

" }, "logTail": { "shape": "LogTail", "documentation": "

The last portion of the diagnostic log.

If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

" } }, "documentation": "

Diagnostic information about executable scripts that are part of a deployment.

" }, "Duration": { "type": "integer" }, "EC2TagFilter": { "type": "structure", "members": { "Key": { "shape": "Key", "documentation": "

The tag filter key.

" }, "Value": { "shape": "Value", "documentation": "

The tag filter value.

" }, "Type": { "shape": "EC2TagFilterType", "documentation": "

The tag filter type:

" } }, "documentation": "

Information about an EC2 tag filter.

" }, "EC2TagFilterList": { "type": "list", "member": { "shape": "EC2TagFilter" } }, "EC2TagFilterType": { "type": "string", "enum": [ "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE" ] }, "EC2TagSet": { "type": "structure", "members": { "ec2TagSetList": { "shape": "EC2TagSetList", "documentation": "

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.

" } }, "documentation": "

Information about groups of Amazon EC2 instance tags.

" }, "EC2TagSetList": { "type": "list", "member": { "shape": "EC2TagFilterList" } }, "ECSClusterName": { "type": "string" }, "ECSService": { "type": "structure", "members": { "serviceName": { "shape": "ECSServiceName", "documentation": "

The name of the target Amazon ECS service.

" }, "clusterName": { "shape": "ECSClusterName", "documentation": "

The name of the cluster that the Amazon ECS service is associated with.

" } }, "documentation": "

Contains the service and cluster names used to identify an Amazon ECS deployment's target.

" }, "ECSServiceList": { "type": "list", "member": { "shape": "ECSService" } }, "ECSServiceName": { "type": "string" }, "ECSTarget": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "targetId": { "shape": "TargetId", "documentation": "

The unique ID of a deployment target that has a type of ecsTarget.

" }, "targetArn": { "shape": "TargetArn", "documentation": "

The Amazon Resource Name (ARN) of the target.

" }, "lastUpdatedAt": { "shape": "Time", "documentation": "

The date and time when the target Amazon ECS application was updated by a deployment.

" }, "lifecycleEvents": { "shape": "LifecycleEventList", "documentation": "

The lifecycle events of the deployment to this target Amazon ECS application.

" }, "status": { "shape": "TargetStatus", "documentation": "

The status an Amazon ECS deployment's target ECS application.

" }, "taskSetsInfo": { "shape": "ECSTaskSetList", "documentation": "

The ECSTaskSet objects associated with the ECS target.

" } }, "documentation": "

Information about the target of an Amazon ECS deployment.

" }, "ECSTaskSet": { "type": "structure", "members": { "identifer": { "shape": "ECSTaskSetIdentifier", "documentation": "

A unique ID of an ECSTaskSet.

" }, "desiredCount": { "shape": "ECSTaskSetCount", "documentation": "

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": { "shape": "ECSTaskSetCount", "documentation": "

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": { "shape": "ECSTaskSetCount", "documentation": "

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": { "shape": "ECSTaskSetStatus", "documentation": "

The status of the task set. There are three valid task set statuses:

" }, "trafficWeight": { "shape": "TrafficWeight", "documentation": "

The percentage of traffic served by this task set.

" }, "targetGroup": { "shape": "TargetGroupInfo", "documentation": "

The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

" }, "taskSetLabel": { "shape": "TargetLabel", "documentation": "

A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

" } }, "documentation": "

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.

" }, "ECSTaskSetCount": { "type": "long" }, "ECSTaskSetIdentifier": { "type": "string" }, "ECSTaskSetList": { "type": "list", "member": { "shape": "ECSTaskSet" } }, "ECSTaskSetStatus": { "type": "string" }, "ELBInfo": { "type": "structure", "members": { "name": { "shape": "ELBName", "documentation": "

For blue/green deployments, the name of the Classic 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 Classic 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.

" } }, "documentation": "

Information about a Classic 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": "list", "member": { "shape": "ELBInfo" } }, "ELBName": { "type": "string" }, "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" ] }, "ErrorInformation": { "type": "structure", "members": { "code": { "shape": "ErrorCode", "documentation": "

For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide.

The error code:

" }, "message": { "shape": "ErrorMessage", "documentation": "

An accompanying error message.

" } }, "documentation": "

Information about a deployment error.

" }, "ErrorMessage": { "type": "string" }, "ExternalId": { "type": "string" }, "FileExistsBehavior": { "type": "string", "enum": [ "DISALLOW", "OVERWRITE", "RETAIN" ] }, "FilterValue": { "type": "string" }, "FilterValueList": { "type": "list", "member": { "shape": "FilterValue" } }, "GenericRevisionInfo": { "type": "structure", "members": { "description": { "shape": "Description", "documentation": "

A comment about the revision.

" }, "deploymentGroups": { "shape": "DeploymentGroupsList", "documentation": "

The deployment groups for which this is the current target revision.

" }, "firstUsedTime": { "shape": "Timestamp", "documentation": "

When the revision was first used by CodeDeploy.

" }, "lastUsedTime": { "shape": "Timestamp", "documentation": "

When the revision was last used by CodeDeploy.

" }, "registerTime": { "shape": "Timestamp", "documentation": "

When the revision was registered with CodeDeploy.

" } }, "documentation": "

Information about an application revision.

" }, "GetApplicationInput": { "type": "structure", "required": [ "applicationName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" } }, "documentation": "

Represents the input of a GetApplication operation.

" }, "GetApplicationOutput": { "type": "structure", "members": { "application": { "shape": "ApplicationInfo", "documentation": "

Information about the application.

" } }, "documentation": "

Represents the output of a GetApplication operation.

" }, "GetApplicationRevisionInput": { "type": "structure", "required": [ "applicationName", "revision" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of the application that corresponds to the revision.

" }, "revision": { "shape": "RevisionLocation", "documentation": "

Information about the application revision to get, including type and location.

" } }, "documentation": "

Represents the input of a GetApplicationRevision operation.

" }, "GetApplicationRevisionOutput": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of the application that corresponds to the revision.

" }, "revision": { "shape": "RevisionLocation", "documentation": "

Additional information about the revision, including type and location.

" }, "revisionInfo": { "shape": "GenericRevisionInfo", "documentation": "

General information about the revision.

" } }, "documentation": "

Represents the output of a GetApplicationRevision operation.

" }, "GetDeploymentConfigInput": { "type": "structure", "required": [ "deploymentConfigName" ], "members": { "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The name of a deployment configuration associated with the user or Amazon Web Services account.

" } }, "documentation": "

Represents the input of a GetDeploymentConfig operation.

" }, "GetDeploymentConfigOutput": { "type": "structure", "members": { "deploymentConfigInfo": { "shape": "DeploymentConfigInfo", "documentation": "

Information about the deployment configuration.

" } }, "documentation": "

Represents the output of a GetDeploymentConfig operation.

" }, "GetDeploymentGroupInput": { "type": "structure", "required": [ "applicationName", "deploymentGroupName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The name of a deployment group for the specified application.

" } }, "documentation": "

Represents the input of a GetDeploymentGroup operation.

" }, "GetDeploymentGroupOutput": { "type": "structure", "members": { "deploymentGroupInfo": { "shape": "DeploymentGroupInfo", "documentation": "

Information about the deployment group.

" } }, "documentation": "

Represents the output of a GetDeploymentGroup operation.

" }, "GetDeploymentInput": { "type": "structure", "required": [ "deploymentId" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment associated with the user or Amazon Web Services account.

" } }, "documentation": "

Represents the input of a GetDeployment operation.

" }, "GetDeploymentInstanceInput": { "type": "structure", "required": [ "deploymentId", "instanceId" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "instanceId": { "shape": "InstanceId", "documentation": "

The unique ID of an instance in the deployment group.

" } }, "documentation": "

Represents the input of a GetDeploymentInstance operation.

" }, "GetDeploymentInstanceOutput": { "type": "structure", "members": { "instanceSummary": { "shape": "InstanceSummary", "documentation": "

Information about the instance.

" } }, "documentation": "

Represents the output of a GetDeploymentInstance operation.

" }, "GetDeploymentOutput": { "type": "structure", "members": { "deploymentInfo": { "shape": "DeploymentInfo", "documentation": "

Information about the deployment.

" } }, "documentation": "

Represents the output of a GetDeployment operation.

" }, "GetDeploymentTargetInput": { "type": "structure", "required": [ "deploymentId", "targetId" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "targetId": { "shape": "TargetId", "documentation": "

The unique ID of a deployment target.

" } } }, "GetDeploymentTargetOutput": { "type": "structure", "members": { "deploymentTarget": { "shape": "DeploymentTarget", "documentation": "

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).

" } } }, "GetOnPremisesInstanceInput": { "type": "structure", "required": [ "instanceName" ], "members": { "instanceName": { "shape": "InstanceName", "documentation": "

The name of the on-premises instance about which to get information.

" } }, "documentation": "

Represents the input of a GetOnPremisesInstance operation.

" }, "GetOnPremisesInstanceOutput": { "type": "structure", "members": { "instanceInfo": { "shape": "InstanceInfo", "documentation": "

Information about the on-premises instance.

" } }, "documentation": "

Represents the output of a GetOnPremisesInstance operation.

" }, "GitHubAccountTokenName": { "type": "string" }, "GitHubAccountTokenNameList": { "type": "list", "member": { "shape": "GitHubAccountTokenName" } }, "GitHubLocation": { "type": "structure", "members": { "repository": { "shape": "Repository", "documentation": "

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": { "shape": "CommitId", "documentation": "

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

" } }, "documentation": "

Information about the location of application artifacts stored in GitHub.

" }, "GreenFleetProvisioningAction": { "type": "string", "enum": [ "DISCOVER_EXISTING", "COPY_AUTO_SCALING_GROUP" ] }, "GreenFleetProvisioningOption": { "type": "structure", "members": { "action": { "shape": "GreenFleetProvisioningAction", "documentation": "

The method used to add instances to a replacement environment.

" } }, "documentation": "

Information about the instances that belong to the replacement environment in a blue/green deployment.

" }, "IamSessionArn": { "type": "string" }, "IamUserArn": { "type": "string" }, "InstanceAction": { "type": "string", "enum": [ "TERMINATE", "KEEP_ALIVE" ] }, "InstanceArn": { "type": "string" }, "InstanceCount": { "type": "long" }, "InstanceId": { "type": "string" }, "InstanceInfo": { "type": "structure", "members": { "instanceName": { "shape": "InstanceName", "documentation": "

The name of the on-premises instance.

" }, "iamSessionArn": { "shape": "IamSessionArn", "documentation": "

The ARN of the IAM session associated with the on-premises instance.

" }, "iamUserArn": { "shape": "IamUserArn", "documentation": "

The user ARN associated with the on-premises instance.

" }, "instanceArn": { "shape": "InstanceArn", "documentation": "

The ARN of the on-premises instance.

" }, "registerTime": { "shape": "Timestamp", "documentation": "

The time at which the on-premises instance was registered.

" }, "deregisterTime": { "shape": "Timestamp", "documentation": "

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

" }, "tags": { "shape": "TagList", "documentation": "

The tags currently associated with the on-premises instance.

" } }, "documentation": "

Information about an on-premises instance.

" }, "InstanceInfoList": { "type": "list", "member": { "shape": "InstanceInfo" } }, "InstanceName": { "type": "string" }, "InstanceNameList": { "type": "list", "member": { "shape": "InstanceName" } }, "InstanceStatus": { "type": "string", "deprecated": true, "deprecatedMessage": "InstanceStatus is deprecated, use TargetStatus instead.", "enum": [ "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown", "Ready" ] }, "InstanceStatusList": { "type": "list", "member": { "shape": "InstanceStatus" } }, "InstanceSummary": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "instanceId": { "shape": "InstanceId", "documentation": "

The instance ID.

" }, "status": { "shape": "InstanceStatus", "documentation": "

The deployment status for this instance:

" }, "lastUpdatedAt": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the instance information was last updated.

" }, "lifecycleEvents": { "shape": "LifecycleEventList", "documentation": "

A list of lifecycle events for this instance.

" }, "instanceType": { "shape": "InstanceType", "documentation": "

Information about which environment an instance belongs to in a blue/green deployment.

" } }, "documentation": "

Information about an instance in a deployment.

", "deprecated": true, "deprecatedMessage": "InstanceSummary is deprecated, use DeploymentTarget instead." }, "InstanceSummaryList": { "type": "list", "member": { "shape": "InstanceSummary" } }, "InstanceTarget": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "targetId": { "shape": "TargetId", "documentation": "

The unique ID of a deployment target that has a type of instanceTarget.

" }, "targetArn": { "shape": "TargetArn", "documentation": "

The Amazon Resource Name (ARN) of the target.

" }, "status": { "shape": "TargetStatus", "documentation": "

The status an EC2/On-premises deployment's target instance.

" }, "lastUpdatedAt": { "shape": "Time", "documentation": "

The date and time when the target instance was updated by a deployment.

" }, "lifecycleEvents": { "shape": "LifecycleEventList", "documentation": "

The lifecycle events of the deployment to this target instance.

" }, "instanceLabel": { "shape": "TargetLabel", "documentation": "

A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).

" } }, "documentation": "

A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform.

" }, "InstanceType": { "type": "string", "enum": [ "Blue", "Green" ] }, "InstanceTypeList": { "type": "list", "member": { "shape": "InstanceType" } }, "InstancesList": { "type": "list", "member": { "shape": "InstanceId" } }, "Key": { "type": "string" }, "LambdaFunctionAlias": { "type": "string" }, "LambdaFunctionInfo": { "type": "structure", "members": { "functionName": { "shape": "LambdaFunctionName", "documentation": "

The name of a Lambda function.

" }, "functionAlias": { "shape": "LambdaFunctionAlias", "documentation": "

The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide.

" }, "currentVersion": { "shape": "Version", "documentation": "

The version of a Lambda function that production traffic points to.

" }, "targetVersion": { "shape": "Version", "documentation": "

The version of a Lambda function that production traffic points to after the Lambda function is deployed.

" }, "targetVersionWeight": { "shape": "TrafficWeight", "documentation": "

The percentage of production traffic that the target version of a Lambda function receives.

" } }, "documentation": "

Information about a Lambda function specified in a deployment.

" }, "LambdaFunctionName": { "type": "string" }, "LambdaTarget": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "targetId": { "shape": "TargetId", "documentation": "

The unique ID of a deployment target that has a type of lambdaTarget.

" }, "targetArn": { "shape": "TargetArn", "documentation": "

The Amazon Resource Name (ARN) of the target.

" }, "status": { "shape": "TargetStatus", "documentation": "

The status an Lambda deployment's target Lambda function.

" }, "lastUpdatedAt": { "shape": "Time", "documentation": "

The date and time when the target Lambda function was updated by a deployment.

" }, "lifecycleEvents": { "shape": "LifecycleEventList", "documentation": "

The lifecycle events of the deployment to this target Lambda function.

" }, "lambdaFunctionInfo": { "shape": "LambdaFunctionInfo", "documentation": "

A LambdaFunctionInfo object that describes a target Lambda function.

" } }, "documentation": "

Information about the target Lambda function during an Lambda deployment.

" }, "LastDeploymentInfo": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "status": { "shape": "DeploymentStatus", "documentation": "

The status of the most recent deployment.

" }, "endTime": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the most recent deployment to the deployment group was complete.

" }, "createTime": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the most recent deployment to the deployment group started.

" } }, "documentation": "

Information about the most recent attempted or successful deployment to a deployment group.

" }, "LifecycleErrorCode": { "type": "string", "enum": [ "Success", "ScriptMissing", "ScriptNotExecutable", "ScriptTimedOut", "ScriptFailed", "UnknownError" ] }, "LifecycleEvent": { "type": "structure", "members": { "lifecycleEventName": { "shape": "LifecycleEventName", "documentation": "

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

" }, "diagnostics": { "shape": "Diagnostics", "documentation": "

Diagnostic information about the deployment lifecycle event.

" }, "startTime": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the deployment lifecycle event started.

" }, "endTime": { "shape": "Timestamp", "documentation": "

A timestamp that indicates when the deployment lifecycle event ended.

" }, "status": { "shape": "LifecycleEventStatus", "documentation": "

The deployment lifecycle event status:

" } }, "documentation": "

Information about a deployment lifecycle event.

" }, "LifecycleEventHookExecutionId": { "type": "string" }, "LifecycleEventList": { "type": "list", "member": { "shape": "LifecycleEvent" } }, "LifecycleEventName": { "type": "string" }, "LifecycleEventStatus": { "type": "string", "enum": [ "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown" ] }, "LifecycleMessage": { "type": "string" }, "ListApplicationRevisionsInput": { "type": "structure", "required": [ "applicationName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "sortBy": { "shape": "ApplicationRevisionSortBy", "documentation": "

The column name to use to sort the list results:

If not specified or set to null, the results are returned in an arbitrary order.

" }, "sortOrder": { "shape": "SortOrder", "documentation": "

The order in which to sort the list results:

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

" }, "s3Bucket": { "shape": "S3Bucket", "documentation": "

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets are searched.

" }, "s3KeyPrefix": { "shape": "S3Key", "documentation": "

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

" }, "deployed": { "shape": "ListStateFilterAction", "documentation": "

Whether to list revisions based on whether the revision is the target revision of a deployment group:

" }, "nextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.

" } }, "documentation": "

Represents the input of a ListApplicationRevisions operation.

" }, "ListApplicationRevisionsOutput": { "type": "structure", "members": { "revisions": { "shape": "RevisionLocationList", "documentation": "

A list of locations that contain the matching revisions.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of a ListApplicationRevisions operation.

" }, "ListApplicationsInput": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.

" } }, "documentation": "

Represents the input of a ListApplications operation.

" }, "ListApplicationsOutput": { "type": "structure", "members": { "applications": { "shape": "ApplicationsList", "documentation": "

A list of application names.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of a ListApplications operation.

" }, "ListDeploymentConfigsInput": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.

" } }, "documentation": "

Represents the input of a ListDeploymentConfigs operation.

" }, "ListDeploymentConfigsOutput": { "type": "structure", "members": { "deploymentConfigsList": { "shape": "DeploymentConfigsList", "documentation": "

A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of a ListDeploymentConfigs operation.

" }, "ListDeploymentGroupsInput": { "type": "structure", "required": [ "applicationName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the input of a ListDeploymentGroups operation.

" }, "ListDeploymentGroupsOutput": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The application name.

" }, "deploymentGroups": { "shape": "DeploymentGroupsList", "documentation": "

A list of deployment group names.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of a ListDeploymentGroups operation.

" }, "ListDeploymentInstancesInput": { "type": "structure", "required": [ "deploymentId" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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": { "shape": "InstanceStatusList", "documentation": "

A subset of instances to list by status:

" }, "instanceTypeFilter": { "shape": "InstanceTypeList", "documentation": "

The set of instances in a blue/green deployment, either those in the original environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you want to view instance information.

" } }, "documentation": "

Represents the input of a ListDeploymentInstances operation.

" }, "ListDeploymentInstancesOutput": { "type": "structure", "members": { "instancesList": { "shape": "InstancesList", "documentation": "

A list of instance IDs.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of a ListDeploymentInstances operation.

" }, "ListDeploymentTargetsInput": { "type": "structure", "required": [ "deploymentId" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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": { "shape": "TargetFilters", "documentation": "

A key used to filter the returned targets. The two valid values are:

" } } }, "ListDeploymentTargetsOutput": { "type": "structure", "members": { "targetIds": { "shape": "TargetIdList", "documentation": "

The unique IDs of deployment targets.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } } }, "ListDeploymentsInput": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the 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.

" }, "deploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

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.

" }, "externalId": { "shape": "ExternalId", "documentation": "

The unique ID of an external resource for returning deployments linked to the external resource.

" }, "includeOnlyStatuses": { "shape": "DeploymentStatusList", "documentation": "

A subset of deployments to list by status:

" }, "createTimeRange": { "shape": "TimeRange", "documentation": "

A time range (start and end) for returning a subset of the list of deployments.

" }, "nextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

" } }, "documentation": "

Represents the input of a ListDeployments operation.

" }, "ListDeploymentsOutput": { "type": "structure", "members": { "deployments": { "shape": "DeploymentsList", "documentation": "

A list of deployment IDs.

" }, "nextToken": { "shape": "NextToken", "documentation": "

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.

" } }, "documentation": "

Represents the output of a ListDeployments operation.

" }, "ListGitHubAccountTokenNamesInput": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.

" } }, "documentation": "

Represents the input of a ListGitHubAccountTokenNames operation.

" }, "ListGitHubAccountTokenNamesOutput": { "type": "structure", "members": { "tokenNameList": { "shape": "GitHubAccountTokenNameList", "documentation": "

A list of names of connections to GitHub accounts.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of a ListGitHubAccountTokenNames operation.

" }, "ListOnPremisesInstancesInput": { "type": "structure", "members": { "registrationStatus": { "shape": "RegistrationStatus", "documentation": "

The registration status of the on-premises instances:

" }, "tagFilters": { "shape": "TagFilterList", "documentation": "

The on-premises instance tags that are used to restrict the on-premises instance names returned.

" }, "nextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

" } }, "documentation": "

Represents the input of a ListOnPremisesInstances operation.

" }, "ListOnPremisesInstancesOutput": { "type": "structure", "members": { "instanceNames": { "shape": "InstanceNameList", "documentation": "

The list of matching on-premises instance names.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } }, "documentation": "

Represents the output of the list on-premises instances operation.

" }, "ListStateFilterAction": { "type": "string", "enum": [ "include", "exclude", "ignore" ] }, "ListTagsForResourceInput": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "Arn", "documentation": "

The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn.

" }, "NextToken": { "shape": "NextToken", "documentation": "

An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.

" } } }, "ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "

A list of tags returned by ListTagsForResource. The tags are associated with the resource identified by the input ResourceArn parameter.

" }, "NextToken": { "shape": "NextToken", "documentation": "

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.

" } } }, "ListenerArn": { "type": "string" }, "ListenerArnList": { "type": "list", "member": { "shape": "ListenerArn" } }, "LoadBalancerInfo": { "type": "structure", "members": { "elbInfoList": { "shape": "ELBInfoList", "documentation": "

An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array.

You can add up to 10 load balancers to the array.

If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.

" }, "targetGroupInfoList": { "shape": "TargetGroupInfoList", "documentation": "

An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.

You can add up to 10 target groups to the array.

If you're using Classic Load Balancers, use the elbInfoList array instead of this one.

" }, "targetGroupPairInfoList": { "shape": "TargetGroupPairInfoList", "documentation": "

The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

" } }, "documentation": "

Information about the Elastic Load Balancing load balancer or target group used in a deployment.

You can use load balancers and target groups in combination. For example, if you have two Classic Load Balancers, and five target groups tied to an Application Load Balancer, you can specify the two Classic Load Balancers in elbInfoList, and the five target groups in targetGroupInfoList.

" }, "LogTail": { "type": "string" }, "Message": { "type": "string" }, "MinimumHealthyHosts": { "type": "structure", "members": { "type": { "shape": "MinimumHealthyHostsType", "documentation": "

The minimum healthy instance type:

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": { "shape": "MinimumHealthyHostsValue", "documentation": "

The minimum healthy instance value.

" } }, "documentation": "

Information about the minimum number of healthy instances.

" }, "MinimumHealthyHostsPerZone": { "type": "structure", "members": { "type": { "shape": "MinimumHealthyHostsPerZoneType", "documentation": "

The type associated with the MinimumHealthyHostsPerZone option.

" }, "value": { "shape": "MinimumHealthyHostsPerZoneValue", "documentation": "

The value associated with the MinimumHealthyHostsPerZone option.

" } }, "documentation": "

Information about the minimum number of healthy instances per Availability Zone.

" }, "MinimumHealthyHostsPerZoneType": { "type": "string", "enum": [ "HOST_COUNT", "FLEET_PERCENT" ] }, "MinimumHealthyHostsPerZoneValue": { "type": "integer" }, "MinimumHealthyHostsType": { "type": "string", "enum": [ "HOST_COUNT", "FLEET_PERCENT" ] }, "MinimumHealthyHostsValue": { "type": "integer" }, "NextToken": { "type": "string" }, "NullableBoolean": { "type": "boolean" }, "OnPremisesTagSet": { "type": "structure", "members": { "onPremisesTagSetList": { "shape": "OnPremisesTagSetList", "documentation": "

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.

" } }, "documentation": "

Information about groups of on-premises instance tags.

" }, "OnPremisesTagSetList": { "type": "list", "member": { "shape": "TagFilterList" } }, "OutdatedInstancesStrategy": { "type": "string", "enum": [ "UPDATE", "IGNORE" ] }, "Percentage": { "type": "integer" }, "PutLifecycleEventHookExecutionStatusInput": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

" }, "lifecycleEventHookExecutionId": { "shape": "LifecycleEventHookExecutionId", "documentation": "

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.

" }, "status": { "shape": "LifecycleEventStatus", "documentation": "

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.

" } } }, "PutLifecycleEventHookExecutionStatusOutput": { "type": "structure", "members": { "lifecycleEventHookExecutionId": { "shape": "LifecycleEventHookExecutionId", "documentation": "

The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.

" } } }, "RawString": { "type": "structure", "members": { "content": { "shape": "RawStringContent", "documentation": "

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": { "shape": "RawStringSha256", "documentation": "

The SHA256 hash value of the revision content.

" } }, "documentation": "

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.

", "deprecated": true, "deprecatedMessage": "RawString and String revision type are deprecated, use AppSpecContent type instead." }, "RawStringContent": { "type": "string" }, "RawStringSha256": { "type": "string" }, "RegisterApplicationRevisionInput": { "type": "structure", "required": [ "applicationName", "revision" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

" }, "description": { "shape": "Description", "documentation": "

A comment about the revision.

" }, "revision": { "shape": "RevisionLocation", "documentation": "

Information about the application revision to register, including type and location.

" } }, "documentation": "

Represents the input of a RegisterApplicationRevision operation.

" }, "RegisterOnPremisesInstanceInput": { "type": "structure", "required": [ "instanceName" ], "members": { "instanceName": { "shape": "InstanceName", "documentation": "

The name of the on-premises instance to register.

" }, "iamSessionArn": { "shape": "IamSessionArn", "documentation": "

The ARN of the IAM session to associate with the on-premises instance.

" }, "iamUserArn": { "shape": "IamUserArn", "documentation": "

The ARN of the user to associate with the on-premises instance.

" } }, "documentation": "

Represents the input of the register on-premises instance operation.

" }, "RegistrationStatus": { "type": "string", "enum": [ "Registered", "Deregistered" ] }, "RelatedDeployments": { "type": "structure", "members": { "autoUpdateOutdatedInstancesRootDeploymentId": { "shape": "DeploymentId", "documentation": "

The deployment ID of the root deployment that triggered this deployment.

" }, "autoUpdateOutdatedInstancesDeploymentIds": { "shape": "DeploymentsList", "documentation": "

The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.

" } }, "documentation": "

Information about deployments related to the specified deployment.

" }, "RemoveTagsFromOnPremisesInstancesInput": { "type": "structure", "required": [ "tags", "instanceNames" ], "members": { "tags": { "shape": "TagList", "documentation": "

The tag key-value pairs to remove from the on-premises instances.

" }, "instanceNames": { "shape": "InstanceNameList", "documentation": "

The names of the on-premises instances from which to remove tags.

" } }, "documentation": "

Represents the input of a RemoveTagsFromOnPremisesInstances operation.

" }, "Repository": { "type": "string" }, "RevisionInfo": { "type": "structure", "members": { "revisionLocation": { "shape": "RevisionLocation", "documentation": "

Information about the location and type of an application revision.

" }, "genericRevisionInfo": { "shape": "GenericRevisionInfo", "documentation": "

Information about an application revision, including usage details and associated deployment groups.

" } }, "documentation": "

Information about an application revision.

" }, "RevisionInfoList": { "type": "list", "member": { "shape": "RevisionInfo" } }, "RevisionLocation": { "type": "structure", "members": { "revisionType": { "shape": "RevisionLocationType", "documentation": "

The type of application revision:

" }, "s3Location": { "shape": "S3Location", "documentation": "

Information about the location of a revision stored in Amazon S3.

" }, "gitHubLocation": { "shape": "GitHubLocation", "documentation": "

Information about the location of application artifacts stored in GitHub.

" }, "string": { "shape": "RawString", "documentation": "

Information about the location of an Lambda deployment revision stored as a RawString.

" }, "appSpecContent": { "shape": "AppSpecContent", "documentation": "

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.

" } }, "documentation": "

Information about the location of an application revision.

" }, "RevisionLocationList": { "type": "list", "member": { "shape": "RevisionLocation" } }, "RevisionLocationType": { "type": "string", "enum": [ "S3", "GitHub", "String", "AppSpecContent" ] }, "Role": { "type": "string" }, "RollbackInfo": { "type": "structure", "members": { "rollbackDeploymentId": { "shape": "DeploymentId", "documentation": "

The ID of the deployment rollback.

" }, "rollbackTriggeringDeploymentId": { "shape": "DeploymentId", "documentation": "

The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.

" }, "rollbackMessage": { "shape": "Description", "documentation": "

Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded).

" } }, "documentation": "

Information about a deployment rollback.

" }, "S3Bucket": { "type": "string" }, "S3Key": { "type": "string" }, "S3Location": { "type": "structure", "members": { "bucket": { "shape": "S3Bucket", "documentation": "

The name of the Amazon S3 bucket where the application revision is stored.

" }, "key": { "shape": "S3Key", "documentation": "

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

" }, "bundleType": { "shape": "BundleType", "documentation": "

The file type of the application revision. Must be one of the following:

" }, "version": { "shape": "VersionId", "documentation": "

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": { "shape": "ETag", "documentation": "

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.

" } }, "documentation": "

Information about the location of application artifacts stored in Amazon S3.

" }, "ScriptName": { "type": "string" }, "SkipWaitTimeForInstanceTerminationInput": { "type": "structure", "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.

" } } }, "SortOrder": { "type": "string", "enum": [ "ascending", "descending" ] }, "StopDeploymentInput": { "type": "structure", "required": [ "deploymentId" ], "members": { "deploymentId": { "shape": "DeploymentId", "documentation": "

The unique ID of a deployment.

" }, "autoRollbackEnabled": { "shape": "NullableBoolean", "documentation": "

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

" } }, "documentation": "

Represents the input of a StopDeployment operation.

" }, "StopDeploymentOutput": { "type": "structure", "members": { "status": { "shape": "StopStatus", "documentation": "

The status of the stop deployment operation:

" }, "statusMessage": { "shape": "Message", "documentation": "

An accompanying status message.

" } }, "documentation": "

Represents the output of a StopDeployment operation.

" }, "StopStatus": { "type": "string", "enum": [ "Pending", "Succeeded" ] }, "Tag": { "type": "structure", "members": { "Key": { "shape": "Key", "documentation": "

The tag's key.

" }, "Value": { "shape": "Value", "documentation": "

The tag's value.

" } }, "documentation": "

Information about a tag.

" }, "TagFilter": { "type": "structure", "members": { "Key": { "shape": "Key", "documentation": "

The on-premises instance tag filter key.

" }, "Value": { "shape": "Value", "documentation": "

The on-premises instance tag filter value.

" }, "Type": { "shape": "TagFilterType", "documentation": "

The on-premises instance tag filter type:

" } }, "documentation": "

Information about an on-premises instance tag filter.

" }, "TagFilterList": { "type": "list", "member": { "shape": "TagFilter" } }, "TagFilterType": { "type": "string", "enum": [ "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE" ] }, "TagKeyList": { "type": "list", "member": { "shape": "Key" } }, "TagList": { "type": "list", "member": { "shape": "Tag" } }, "TagResourceInput": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "shape": "Arn", "documentation": "

The ARN of a resource, such as a CodeDeploy application or deployment group.

" }, "Tags": { "shape": "TagList", "documentation": "

A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.

" } } }, "TagResourceOutput": { "type": "structure", "members": {} }, "TargetArn": { "type": "string" }, "TargetFilterName": { "type": "string", "enum": [ "TargetStatus", "ServerInstanceLabel" ] }, "TargetFilters": { "type": "map", "key": { "shape": "TargetFilterName" }, "value": { "shape": "FilterValueList" } }, "TargetGroupInfo": { "type": "structure", "members": { "name": { "shape": "TargetGroupName", "documentation": "

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

" } }, "documentation": "

Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.

" }, "TargetGroupInfoList": { "type": "list", "member": { "shape": "TargetGroupInfo" } }, "TargetGroupName": { "type": "string" }, "TargetGroupPairInfo": { "type": "structure", "members": { "targetGroups": { "shape": "TargetGroupInfoList", "documentation": "

One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.

" }, "prodTrafficRoute": { "shape": "TrafficRoute", "documentation": "

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

" }, "testTrafficRoute": { "shape": "TrafficRoute", "documentation": "

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.

" } }, "documentation": "

Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.

" }, "TargetGroupPairInfoList": { "type": "list", "member": { "shape": "TargetGroupPairInfo" } }, "TargetId": { "type": "string" }, "TargetIdList": { "type": "list", "member": { "shape": "TargetId" } }, "TargetInstances": { "type": "structure", "members": { "tagFilters": { "shape": "EC2TagFilterList", "documentation": "

The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet.

" }, "autoScalingGroups": { "shape": "AutoScalingGroupNameList", "documentation": "

The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.

" }, "ec2TagSet": { "shape": "EC2TagSet", "documentation": "

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.

" } }, "documentation": "

Information about the instances to be used in the replacement environment in a blue/green deployment.

" }, "TargetLabel": { "type": "string", "enum": [ "Blue", "Green" ] }, "TargetStatus": { "type": "string", "enum": [ "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown", "Ready" ] }, "Time": { "type": "timestamp" }, "TimeBasedCanary": { "type": "structure", "members": { "canaryPercentage": { "shape": "Percentage", "documentation": "

The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.

" }, "canaryInterval": { "shape": "WaitTimeInMins", "documentation": "

The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.

" } }, "documentation": "

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": "structure", "members": { "linearPercentage": { "shape": "Percentage", "documentation": "

The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.

" }, "linearInterval": { "shape": "WaitTimeInMins", "documentation": "

The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.

" } }, "documentation": "

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.

" }, "TimeRange": { "type": "structure", "members": { "start": { "shape": "Timestamp", "documentation": "

The start time of the time range.

Specify null to leave the start time open-ended.

" }, "end": { "shape": "Timestamp", "documentation": "

The end time of the time range.

Specify null to leave the end time open-ended.

" } }, "documentation": "

Information about a time range.

" }, "Timestamp": { "type": "timestamp" }, "TrafficRoute": { "type": "structure", "members": { "listenerArns": { "shape": "ListenerArnList", "documentation": "

The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.

" } }, "documentation": "

Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group.

" }, "TrafficRoutingConfig": { "type": "structure", "members": { "type": { "shape": "TrafficRoutingType", "documentation": "

The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.

" }, "timeBasedCanary": { "shape": "TimeBasedCanary", "documentation": "

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": { "shape": "TimeBasedLinear", "documentation": "

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.

" } }, "documentation": "

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.

" }, "TrafficRoutingType": { "type": "string", "enum": [ "TimeBasedCanary", "TimeBasedLinear", "AllAtOnce" ] }, "TrafficWeight": { "type": "double" }, "TriggerConfig": { "type": "structure", "members": { "triggerName": { "shape": "TriggerName", "documentation": "

The name of the notification trigger.

" }, "triggerTargetArn": { "shape": "TriggerTargetArn", "documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

" }, "triggerEvents": { "shape": "TriggerEventTypeList", "documentation": "

The event type or types for which notifications are triggered.

" } }, "documentation": "

Information about notification triggers for the deployment group.

" }, "TriggerConfigList": { "type": "list", "member": { "shape": "TriggerConfig" } }, "TriggerEventType": { "type": "string", "enum": [ "DeploymentStart", "DeploymentSuccess", "DeploymentFailure", "DeploymentStop", "DeploymentRollback", "DeploymentReady", "InstanceStart", "InstanceSuccess", "InstanceFailure", "InstanceReady" ] }, "TriggerEventTypeList": { "type": "list", "member": { "shape": "TriggerEventType" } }, "TriggerName": { "type": "string" }, "TriggerTargetArn": { "type": "string" }, "UntagResourceInput": { "type": "structure", "required": [ "ResourceArn", "TagKeys" ], "members": { "ResourceArn": { "shape": "Arn", "documentation": "

The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys input parameter.

" }, "TagKeys": { "shape": "TagKeyList", "documentation": "

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.

" } } }, "UntagResourceOutput": { "type": "structure", "members": {} }, "UpdateApplicationInput": { "type": "structure", "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The current name of the application you want to change.

" }, "newApplicationName": { "shape": "ApplicationName", "documentation": "

The new name to give the application.

" } }, "documentation": "

Represents the input of an UpdateApplication operation.

" }, "UpdateDeploymentGroupInput": { "type": "structure", "required": [ "applicationName", "currentDeploymentGroupName" ], "members": { "applicationName": { "shape": "ApplicationName", "documentation": "

The application name that corresponds to the deployment group to update.

" }, "currentDeploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The current name of the deployment group.

" }, "newDeploymentGroupName": { "shape": "DeploymentGroupName", "documentation": "

The new name of the deployment group, if you want to change it.

" }, "deploymentConfigName": { "shape": "DeploymentConfigName", "documentation": "

The replacement deployment configuration name to use, if you want to change it.

" }, "ec2TagFilters": { "shape": "EC2TagFilterList", "documentation": "

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": { "shape": "TagFilterList", "documentation": "

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": { "shape": "AutoScalingGroupNameList", "documentation": "

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

" }, "serviceRoleArn": { "shape": "Role", "documentation": "

A replacement ARN for the service role, if you want to change it.

" }, "triggerConfigurations": { "shape": "TriggerConfigList", "documentation": "

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

" }, "alarmConfiguration": { "shape": "AlarmConfiguration", "documentation": "

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

" }, "autoRollbackConfiguration": { "shape": "AutoRollbackConfiguration", "documentation": "

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

" }, "outdatedInstancesStrategy": { "shape": "OutdatedInstancesStrategy", "documentation": "

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.

" }, "deploymentStyle": { "shape": "DeploymentStyle", "documentation": "

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.

" }, "blueGreenDeploymentConfiguration": { "shape": "BlueGreenDeploymentConfiguration", "documentation": "

Information about blue/green deployment options for a deployment group.

" }, "loadBalancerInfo": { "shape": "LoadBalancerInfo", "documentation": "

Information about the load balancer used in a deployment.

" }, "ec2TagSet": { "shape": "EC2TagSet", "documentation": "

Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

" }, "ecsServices": { "shape": "ECSServiceList", "documentation": "

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": { "shape": "OnPremisesTagSet", "documentation": "

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

" }, "terminationHookEnabled": { "shape": "NullableBoolean", "documentation": "

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

" } }, "documentation": "

Represents the input of an UpdateDeploymentGroup operation.

" }, "UpdateDeploymentGroupOutput": { "type": "structure", "members": { "hooksNotCleanedUp": { "shape": "AutoScalingGroupList", "documentation": "

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.

" } }, "documentation": "

Represents the output of an UpdateDeploymentGroup operation.

" }, "Value": { "type": "string" }, "Version": { "type": "string" }, "VersionId": { "type": "string" }, "WaitTimeInMins": { "type": "integer" }, "WaitTimeInSeconds": { "type": "long" }, "ZonalConfig": { "type": "structure", "members": { "firstZoneMonitorDurationInSeconds": { "shape": "WaitTimeInSeconds", "documentation": "

The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for firstZoneMonitorDurationInSeconds, then CodeDeploy uses the monitorDurationInSeconds value for the first Availability Zone.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

" }, "monitorDurationInSeconds": { "shape": "WaitTimeInSeconds", "documentation": "

The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a monitorDurationInSeconds, CodeDeploy starts deploying to the next Availability Zone immediately.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

" }, "minimumHealthyHostsPerZone": { "shape": "MinimumHealthyHostsPerZone", "documentation": "

The number or percentage of instances that must remain available per Availability Zone during a deployment. This option works in conjunction with the MinimumHealthyHosts option. For more information, see About the minimum number of healthy hosts per Availability Zone in the CodeDeploy User Guide.

If you don't specify the minimumHealthyHostsPerZone option, then CodeDeploy uses a default value of 0 percent.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

" } }, "documentation": "

Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region. By deploying to one Availability Zone at a time, you can expose your deployment to a progressively larger audience as confidence in the deployment's performance and viability grows. If you don't configure the ZonalConfig object, CodeDeploy deploys your application to a random selection of hosts across a Region.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

" } }, "documentation": "

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

" }