{ "version": "2.0", "service": "AWS CodeDeploy Overview

This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide.

Using the APIs

You can use the AWS CodeDeploy APIs to work with the following:

", "operations": { "AddTagsToOnPremisesInstances": "

Adds tags to on-premises instances.

", "BatchGetApplicationRevisions": "

Gets information about one or more application revisions.

", "BatchGetApplications": "

Gets information about one or more applications.

", "BatchGetDeploymentGroups": "

Get information about one or more deployment groups.

", "BatchGetDeploymentInstances": "

Gets information about one or more instance that are part of a deployment group.

", "BatchGetDeployments": "

Gets information about one or more deployments.

", "BatchGetOnPremisesInstances": "

Gets information about one or more on-premises instances.

", "CreateApplication": "

Creates an application.

", "CreateDeployment": "

Deploys an application revision through the specified deployment group.

", "CreateDeploymentConfig": "

Creates a deployment configuration.

", "CreateDeploymentGroup": "

Creates a deployment group to which application revisions will be deployed.

", "DeleteApplication": "

Deletes an application.

", "DeleteDeploymentConfig": "

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.", "DeleteDeploymentGroup": "

Deletes a deployment group.

", "DeregisterOnPremisesInstance": "

Deregisters an on-premises instance.

", "GetApplication": "

Gets information about an application.

", "GetApplicationRevision": "

Gets information about an application revision.

", "GetDeployment": "

Gets information about a deployment.

", "GetDeploymentConfig": "

Gets information about a deployment configuration.

", "GetDeploymentGroup": "

Gets information about a deployment group.

", "GetDeploymentInstance": "

Gets information about an instance as part of a deployment.

", "GetOnPremisesInstance": "

Gets information about an on-premises instance.

", "ListApplicationRevisions": "

Lists information about revisions for an application.

", "ListApplications": "

Lists the applications registered with the applicable IAM user or AWS account.

", "ListDeploymentConfigs": "

Lists the deployment configurations with the applicable IAM user or AWS account.

", "ListDeploymentGroups": "

Lists the deployment groups for an application registered with the applicable IAM user or AWS account.

", "ListDeploymentInstances": "

Lists the instance for a deployment associated with the applicable IAM user or AWS account.

", "ListDeployments": "

Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.

", "ListOnPremisesInstances": "

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

", "RegisterApplicationRevision": "

Registers with AWS CodeDeploy a revision for the specified application.

", "RegisterOnPremisesInstance": "

Registers an on-premises instance.

", "RemoveTagsFromOnPremisesInstances": "

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

", "StopDeployment": "

Attempts to stop an ongoing deployment.

", "UpdateApplication": "

Changes the name of an application.

", "UpdateDeploymentGroup": "

Changes information about a deployment group.

" }, "shapes": { "AddTagsToOnPremisesInstancesInput": { "base": "

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

", "refs": { } }, "ApplicationAlreadyExistsException": { "base": "

An application with the specified name already exists with the applicable IAM user or AWS account.

", "refs": { } }, "ApplicationDoesNotExistException": { "base": "

The application does not exist with the applicable IAM user or AWS account.

", "refs": { } }, "ApplicationId": { "base": null, "refs": { "ApplicationInfo$applicationId": "

The application ID.

", "CreateApplicationOutput$applicationId": "

A unique application ID.

" } }, "ApplicationInfo": { "base": "

Information about an application.

", "refs": { "ApplicationsInfoList$member": null, "GetApplicationOutput$application": "

Information about the application.

" } }, "ApplicationLimitExceededException": { "base": "

More applications were attempted to be created than are allowed.

", "refs": { } }, "ApplicationName": { "base": null, "refs": { "ApplicationInfo$applicationName": "

The application name.

", "ApplicationsList$member": null, "BatchGetApplicationRevisionsInput$applicationName": "

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

", "BatchGetApplicationRevisionsOutput$applicationName": "

The name of the application that corresponds to the revisions.

", "BatchGetDeploymentGroupsInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "CreateApplicationInput$applicationName": "

The name of the application. This name must be unique with the applicable IAM user or AWS account.

", "CreateDeploymentGroupInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "CreateDeploymentInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "DeleteApplicationInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "DeleteDeploymentGroupInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "DeploymentGroupInfo$applicationName": "

The application name.

", "DeploymentInfo$applicationName": "

The application name.

", "GetApplicationInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "GetApplicationRevisionInput$applicationName": "

The name of the application that corresponds to the revision.

", "GetApplicationRevisionOutput$applicationName": "

The name of the application that corresponds to the revision.

", "GetDeploymentGroupInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "ListApplicationRevisionsInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "ListDeploymentGroupsInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "ListDeploymentGroupsOutput$applicationName": "

The application name.

", "ListDeploymentsInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "RegisterApplicationRevisionInput$applicationName": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

", "UpdateApplicationInput$applicationName": "

The current name of the application you want to change.

", "UpdateApplicationInput$newApplicationName": "

The new name to give the application.

", "UpdateDeploymentGroupInput$applicationName": "

The application name corresponding to the deployment group to update.

" } }, "ApplicationNameRequiredException": { "base": "

The minimum number of required application names was not specified.

", "refs": { } }, "ApplicationRevisionSortBy": { "base": null, "refs": { "ListApplicationRevisionsInput$sortBy": "

The column name to use to sort the list results:

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

" } }, "ApplicationsInfoList": { "base": null, "refs": { "BatchGetApplicationsOutput$applicationsInfo": "

Information about the applications.

" } }, "ApplicationsList": { "base": null, "refs": { "BatchGetApplicationsInput$applicationNames": "

A list of application names separated by spaces.

", "ListApplicationsOutput$applications": "

A list of application names.

" } }, "AutoScalingGroup": { "base": "

Information about an Auto Scaling group.

", "refs": { "AutoScalingGroupList$member": null } }, "AutoScalingGroupHook": { "base": null, "refs": { "AutoScalingGroup$hook": "

An Auto Scaling lifecycle event hook name.

" } }, "AutoScalingGroupList": { "base": null, "refs": { "DeleteDeploymentGroupOutput$hooksNotCleanedUp": "

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS 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, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.

", "DeploymentGroupInfo$autoScalingGroups": "

A list of associated Auto Scaling groups.

", "UpdateDeploymentGroupOutput$hooksNotCleanedUp": "

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.

" } }, "AutoScalingGroupName": { "base": null, "refs": { "AutoScalingGroup$name": "

The Auto Scaling group name.

", "AutoScalingGroupNameList$member": null } }, "AutoScalingGroupNameList": { "base": null, "refs": { "CreateDeploymentGroupInput$autoScalingGroups": "

A list of associated Auto Scaling groups.

", "UpdateDeploymentGroupInput$autoScalingGroups": "

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

" } }, "BatchGetApplicationRevisionsInput": { "base": "

Represents the input of a batch get application revisions operation.

", "refs": { } }, "BatchGetApplicationRevisionsOutput": { "base": "

Represents the output of a batch get application revisions operation.

", "refs": { } }, "BatchGetApplicationsInput": { "base": "

Represents the input of a batch get applications operation.

", "refs": { } }, "BatchGetApplicationsOutput": { "base": "

Represents the output of a batch get applications operation.

", "refs": { } }, "BatchGetDeploymentGroupsInput": { "base": "

Represents the input of a batch get deployment groups operation.

", "refs": { } }, "BatchGetDeploymentGroupsOutput": { "base": "

Represents the output of a batch get deployment groups operation.

", "refs": { } }, "BatchGetDeploymentInstancesInput": { "base": "

Represents the input of a batch get deployment instances operation.

", "refs": { } }, "BatchGetDeploymentInstancesOutput": { "base": "

Represents the output of a batch get deployment instance operation.

", "refs": { } }, "BatchGetDeploymentsInput": { "base": "

Represents the input of a batch get deployments operation.

", "refs": { } }, "BatchGetDeploymentsOutput": { "base": "

Represents the output of a batch get deployments operation.

", "refs": { } }, "BatchGetOnPremisesInstancesInput": { "base": "

Represents the input of a batch get on-premises instances operation.

", "refs": { } }, "BatchGetOnPremisesInstancesOutput": { "base": "

Represents the output of a batch get on-premises instances operation.

", "refs": { } }, "BatchLimitExceededException": { "base": "

The maximum number of names or IDs allowed for this request (100) was exceeded.

", "refs": { } }, "Boolean": { "base": null, "refs": { "ApplicationInfo$linkedToGitHub": "

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

", "CreateDeploymentInput$ignoreApplicationStopFailures": "

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

", "DeploymentInfo$ignoreApplicationStopFailures": "

If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.

If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

" } }, "BucketNameFilterRequiredException": { "base": "

A bucket name is required, but was not provided.

", "refs": { } }, "BundleType": { "base": null, "refs": { "S3Location$bundleType": "

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

" } }, "CommitId": { "base": null, "refs": { "GitHubLocation$commitId": "

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

" } }, "CreateApplicationInput": { "base": "

Represents the input of a create application operation.

", "refs": { } }, "CreateApplicationOutput": { "base": "

Represents the output of a create application operation.

", "refs": { } }, "CreateDeploymentConfigInput": { "base": "

Represents the input of a create deployment configuration operation.

", "refs": { } }, "CreateDeploymentConfigOutput": { "base": "

Represents the output of a create deployment configuration operation.

", "refs": { } }, "CreateDeploymentGroupInput": { "base": "

Represents the input of a create deployment group operation.

", "refs": { } }, "CreateDeploymentGroupOutput": { "base": "

Represents the output of a create deployment group operation.

", "refs": { } }, "CreateDeploymentInput": { "base": "

Represents the input of a create deployment operation.

", "refs": { } }, "CreateDeploymentOutput": { "base": "

Represents the output of a create deployment operation.

", "refs": { } }, "DeleteApplicationInput": { "base": "

Represents the input of a delete application operation.

", "refs": { } }, "DeleteDeploymentConfigInput": { "base": "

Represents the input of a delete deployment configuration operation.

", "refs": { } }, "DeleteDeploymentGroupInput": { "base": "

Represents the input of a delete deployment group operation.

", "refs": { } }, "DeleteDeploymentGroupOutput": { "base": "

Represents the output of a delete deployment group operation.

", "refs": { } }, "DeploymentAlreadyCompletedException": { "base": "

The deployment is already complete.

", "refs": { } }, "DeploymentConfigAlreadyExistsException": { "base": "

A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.

", "refs": { } }, "DeploymentConfigDoesNotExistException": { "base": "

The deployment configuration does not exist with the applicable IAM user or AWS account.

", "refs": { } }, "DeploymentConfigId": { "base": null, "refs": { "CreateDeploymentConfigOutput$deploymentConfigId": "

A unique deployment configuration ID.

", "DeploymentConfigInfo$deploymentConfigId": "

The deployment configuration ID.

" } }, "DeploymentConfigInUseException": { "base": "

The deployment configuration is still in use.

", "refs": { } }, "DeploymentConfigInfo": { "base": "

Information about a deployment configuration.

", "refs": { "GetDeploymentConfigOutput$deploymentConfigInfo": "

Information about the deployment configuration.

" } }, "DeploymentConfigLimitExceededException": { "base": "

The deployment configurations limit was exceeded.

", "refs": { } }, "DeploymentConfigName": { "base": null, "refs": { "CreateDeploymentConfigInput$deploymentConfigName": "

The name of the deployment configuration to create.

", "CreateDeploymentGroupInput$deploymentConfigName": "

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS 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 the deployment group.

The predefined deployment configurations include the following:

", "CreateDeploymentInput$deploymentConfigName": "

The name of a deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

", "DeleteDeploymentConfigInput$deploymentConfigName": "

The name of a deployment configuration associated with the applicable IAM user or AWS account.

", "DeploymentConfigInfo$deploymentConfigName": "

The deployment configuration name.

", "DeploymentConfigsList$member": null, "DeploymentGroupInfo$deploymentConfigName": "

The deployment configuration name.

", "DeploymentInfo$deploymentConfigName": "

The deployment configuration name.

", "GetDeploymentConfigInput$deploymentConfigName": "

The name of a deployment configuration associated with the applicable IAM user or AWS account.

", "UpdateDeploymentGroupInput$deploymentConfigName": "

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

" } }, "DeploymentConfigNameRequiredException": { "base": "

The deployment configuration name was not specified.

", "refs": { } }, "DeploymentConfigsList": { "base": null, "refs": { "ListDeploymentConfigsOutput$deploymentConfigsList": "

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

" } }, "DeploymentCreator": { "base": null, "refs": { "DeploymentInfo$creator": "

The means by which the deployment was created:

" } }, "DeploymentDoesNotExistException": { "base": "

The deployment does not exist with the applicable IAM user or AWS account.

", "refs": { } }, "DeploymentGroupAlreadyExistsException": { "base": "

A deployment group with the specified name already exists with the applicable IAM user or AWS account.

", "refs": { } }, "DeploymentGroupDoesNotExistException": { "base": "

The named deployment group does not exist with the applicable IAM user or AWS account.

", "refs": { } }, "DeploymentGroupId": { "base": null, "refs": { "CreateDeploymentGroupOutput$deploymentGroupId": "

A unique deployment group ID.

", "DeploymentGroupInfo$deploymentGroupId": "

The deployment group ID.

" } }, "DeploymentGroupInfo": { "base": "

Information about a deployment group.

", "refs": { "DeploymentGroupInfoList$member": null, "GetDeploymentGroupOutput$deploymentGroupInfo": "

Information about the deployment group.

" } }, "DeploymentGroupInfoList": { "base": null, "refs": { "BatchGetDeploymentGroupsOutput$deploymentGroupsInfo": "

Information about the deployment groups.

" } }, "DeploymentGroupLimitExceededException": { "base": "

The deployment groups limit was exceeded.

", "refs": { } }, "DeploymentGroupName": { "base": null, "refs": { "CreateDeploymentGroupInput$deploymentGroupName": "

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

", "CreateDeploymentInput$deploymentGroupName": "

The name of the deployment group.

", "DeleteDeploymentGroupInput$deploymentGroupName": "

The name of an existing deployment group for the specified application.

", "DeploymentGroupInfo$deploymentGroupName": "

The deployment group name.

", "DeploymentGroupsList$member": null, "DeploymentInfo$deploymentGroupName": "

The deployment group name.

", "GetDeploymentGroupInput$deploymentGroupName": "

The name of an existing deployment group for the specified application.

", "ListDeploymentsInput$deploymentGroupName": "

The name of an existing deployment group for the specified application.

", "UpdateDeploymentGroupInput$currentDeploymentGroupName": "

The current name of the deployment group.

", "UpdateDeploymentGroupInput$newDeploymentGroupName": "

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

" } }, "DeploymentGroupNameRequiredException": { "base": "

The deployment group name was not specified.

", "refs": { } }, "DeploymentGroupsList": { "base": null, "refs": { "BatchGetDeploymentGroupsInput$deploymentGroupNames": "

The deployment groups' names.

", "GenericRevisionInfo$deploymentGroups": "

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

", "ListDeploymentGroupsOutput$deploymentGroups": "

A list of corresponding deployment group names.

" } }, "DeploymentId": { "base": null, "refs": { "BatchGetDeploymentInstancesInput$deploymentId": "

The unique ID of a deployment.

", "CreateDeploymentOutput$deploymentId": "

A unique deployment ID.

", "DeploymentInfo$deploymentId": "

The deployment ID.

", "DeploymentsList$member": null, "GetDeploymentInput$deploymentId": "

A deployment ID associated with the applicable IAM user or AWS account.

", "GetDeploymentInstanceInput$deploymentId": "

The unique ID of a deployment.

", "InstanceSummary$deploymentId": "

The deployment ID.

", "ListDeploymentInstancesInput$deploymentId": "

The unique ID of a deployment.

", "StopDeploymentInput$deploymentId": "

The unique ID of a deployment.

" } }, "DeploymentIdRequiredException": { "base": "

At least one deployment ID must be specified.

", "refs": { } }, "DeploymentInfo": { "base": "

Information about a deployment.

", "refs": { "DeploymentsInfoList$member": null, "GetDeploymentOutput$deploymentInfo": "

Information about the deployment.

" } }, "DeploymentLimitExceededException": { "base": "

The number of allowed deployments was exceeded.

", "refs": { } }, "DeploymentNotStartedException": { "base": "

The specified deployment has not started.

", "refs": { } }, "DeploymentOverview": { "base": "

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

", "refs": { "DeploymentInfo$deploymentOverview": "

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

" } }, "DeploymentStatus": { "base": null, "refs": { "DeploymentInfo$status": "

The current state of the deployment as a whole.

", "DeploymentStatusList$member": null } }, "DeploymentStatusList": { "base": null, "refs": { "ListDeploymentsInput$includeOnlyStatuses": "

A subset of deployments to list by status:

" } }, "DeploymentsInfoList": { "base": null, "refs": { "BatchGetDeploymentsOutput$deploymentsInfo": "

Information about the deployments.

" } }, "DeploymentsList": { "base": null, "refs": { "BatchGetDeploymentsInput$deploymentIds": "

A list of deployment IDs, separated by spaces.

", "ListDeploymentsOutput$deployments": "

A list of deployment IDs.

" } }, "DeregisterOnPremisesInstanceInput": { "base": "

Represents the input of a deregister on-premises instance operation.

", "refs": { } }, "Description": { "base": null, "refs": { "CreateDeploymentInput$description": "

A comment about the deployment.

", "DeploymentInfo$description": "

A comment about the deployment.

", "GenericRevisionInfo$description": "

A comment about the revision.

", "RegisterApplicationRevisionInput$description": "

A comment about the revision.

" } }, "DescriptionTooLongException": { "base": "

The description is too long.

", "refs": { } }, "Diagnostics": { "base": "

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

", "refs": { "LifecycleEvent$diagnostics": "

Diagnostic information about the deployment lifecycle event.

" } }, "EC2TagFilter": { "base": "

Information about a tag filter.

", "refs": { "EC2TagFilterList$member": null } }, "EC2TagFilterList": { "base": null, "refs": { "CreateDeploymentGroupInput$ec2TagFilters": "

The Amazon EC2 tags on which to filter.

", "DeploymentGroupInfo$ec2TagFilters": "

The Amazon EC2 tags on which to filter.

", "UpdateDeploymentGroupInput$ec2TagFilters": "

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.

" } }, "EC2TagFilterType": { "base": null, "refs": { "EC2TagFilter$Type": "

The tag filter type:

" } }, "ETag": { "base": null, "refs": { "S3Location$eTag": "

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 will be skipped.

" } }, "ErrorCode": { "base": null, "refs": { "ErrorInformation$code": "

The error code:

" } }, "ErrorInformation": { "base": "

Information about a deployment error.

", "refs": { "DeploymentInfo$errorInformation": "

Information about any error associated with this deployment.

" } }, "ErrorMessage": { "base": null, "refs": { "BatchGetApplicationRevisionsOutput$errorMessage": "

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

", "BatchGetDeploymentGroupsOutput$errorMessage": "

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

", "BatchGetDeploymentInstancesOutput$errorMessage": "

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

", "ErrorInformation$message": "

An accompanying error message.

" } }, "GenericRevisionInfo": { "base": "

Information about an application revision.

", "refs": { "GetApplicationRevisionOutput$revisionInfo": "

General information about the revision.

", "RevisionInfo$genericRevisionInfo": null } }, "GetApplicationInput": { "base": "

Represents the input of a get application operation.

", "refs": { } }, "GetApplicationOutput": { "base": "

Represents the output of a get application operation.

", "refs": { } }, "GetApplicationRevisionInput": { "base": "

Represents the input of a get application revision operation.

", "refs": { } }, "GetApplicationRevisionOutput": { "base": "

Represents the output of a get application revision operation.

", "refs": { } }, "GetDeploymentConfigInput": { "base": "

Represents the input of a get deployment configuration operation.

", "refs": { } }, "GetDeploymentConfigOutput": { "base": "

Represents the output of a get deployment configuration operation.

", "refs": { } }, "GetDeploymentGroupInput": { "base": "

Represents the input of a get deployment group operation.

", "refs": { } }, "GetDeploymentGroupOutput": { "base": "

Represents the output of a get deployment group operation.

", "refs": { } }, "GetDeploymentInput": { "base": "

Represents the input of a get deployment operation.

", "refs": { } }, "GetDeploymentInstanceInput": { "base": "

Represents the input of a get deployment instance operation.

", "refs": { } }, "GetDeploymentInstanceOutput": { "base": "

Represents the output of a get deployment instance operation.

", "refs": { } }, "GetDeploymentOutput": { "base": "

Represents the output of a get deployment operation.

", "refs": { } }, "GetOnPremisesInstanceInput": { "base": "

Represents the input of a get on-premises instance operation.

", "refs": { } }, "GetOnPremisesInstanceOutput": { "base": "

Represents the output of a get on-premises instance operation.

", "refs": { } }, "GitHubLocation": { "base": "

Information about the location of application artifacts stored in GitHub.

", "refs": { "RevisionLocation$gitHubLocation": null } }, "IamUserArn": { "base": null, "refs": { "InstanceInfo$iamUserArn": "

The IAM user ARN associated with the on-premises instance.

", "RegisterOnPremisesInstanceInput$iamUserArn": "

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

" } }, "IamUserArnAlreadyRegisteredException": { "base": "

The specified IAM user ARN is already registered with an on-premises instance.

", "refs": { } }, "IamUserArnRequiredException": { "base": "

An IAM user ARN was not specified.

", "refs": { } }, "InstanceArn": { "base": null, "refs": { "InstanceInfo$instanceArn": "

The ARN of the on-premises instance.

" } }, "InstanceCount": { "base": null, "refs": { "DeploymentOverview$Pending": "

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

", "DeploymentOverview$InProgress": "

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

", "DeploymentOverview$Succeeded": "

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

", "DeploymentOverview$Failed": "

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

", "DeploymentOverview$Skipped": "

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

" } }, "InstanceDoesNotExistException": { "base": "

The specified instance does not exist in the deployment group.

", "refs": { } }, "InstanceId": { "base": null, "refs": { "GetDeploymentInstanceInput$instanceId": "

The unique ID of an instance in the deployment group.

", "InstanceSummary$instanceId": "

The instance ID.

", "InstancesList$member": null } }, "InstanceIdRequiredException": { "base": "

The instance ID was not specified.

", "refs": { } }, "InstanceInfo": { "base": "

Information about an on-premises instance.

", "refs": { "GetOnPremisesInstanceOutput$instanceInfo": "

Information about the on-premises instance.

", "InstanceInfoList$member": null } }, "InstanceInfoList": { "base": null, "refs": { "BatchGetOnPremisesInstancesOutput$instanceInfos": "

Information about the on-premises instances.

" } }, "InstanceLimitExceededException": { "base": "

The maximum number of allowed on-premises instances in a single call was exceeded.

", "refs": { } }, "InstanceName": { "base": null, "refs": { "DeregisterOnPremisesInstanceInput$instanceName": "

The name of the on-premises instance to deregister.

", "GetOnPremisesInstanceInput$instanceName": "

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

", "InstanceInfo$instanceName": "

The name of the on-premises instance.

", "InstanceNameList$member": null, "RegisterOnPremisesInstanceInput$instanceName": "

The name of the on-premises instance to register.

" } }, "InstanceNameAlreadyRegisteredException": { "base": "

The specified on-premises instance name is already registered.

", "refs": { } }, "InstanceNameList": { "base": null, "refs": { "AddTagsToOnPremisesInstancesInput$instanceNames": "

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

", "BatchGetOnPremisesInstancesInput$instanceNames": "

The names of the on-premises instances about which to get information.

", "ListOnPremisesInstancesOutput$instanceNames": "

The list of matching on-premises instance names.

", "RemoveTagsFromOnPremisesInstancesInput$instanceNames": "

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

" } }, "InstanceNameRequiredException": { "base": "

An on-premises instance name was not specified.

", "refs": { } }, "InstanceNotRegisteredException": { "base": "

The specified on-premises instance is not registered.

", "refs": { } }, "InstanceStatus": { "base": null, "refs": { "InstanceStatusList$member": null, "InstanceSummary$status": "

The deployment status for this instance:

" } }, "InstanceStatusList": { "base": null, "refs": { "ListDeploymentInstancesInput$instanceStatusFilter": "

A subset of instances to list by status:

" } }, "InstanceSummary": { "base": "

Information about an instance in a deployment.

", "refs": { "GetDeploymentInstanceOutput$instanceSummary": "

Information about the instance.

", "InstanceSummaryList$member": null } }, "InstanceSummaryList": { "base": null, "refs": { "BatchGetDeploymentInstancesOutput$instancesSummary": "

Information about the instance.

" } }, "InstancesList": { "base": null, "refs": { "BatchGetDeploymentInstancesInput$instanceIds": "

The unique IDs of instances in the deployment group.

", "ListDeploymentInstancesOutput$instancesList": "

A list of instance IDs.

" } }, "InvalidApplicationNameException": { "base": "

The application name was specified in an invalid format.

", "refs": { } }, "InvalidAutoScalingGroupException": { "base": "

The Auto Scaling group was specified in an invalid format or does not exist.

", "refs": { } }, "InvalidBucketNameFilterException": { "base": "

The bucket name either doesn't exist or was specified in an invalid format.

", "refs": { } }, "InvalidDeployedStateFilterException": { "base": "

The deployed state filter was specified in an invalid format.

", "refs": { } }, "InvalidDeploymentConfigNameException": { "base": "

The deployment configuration name was specified in an invalid format.

", "refs": { } }, "InvalidDeploymentGroupNameException": { "base": "

The deployment group name was specified in an invalid format.

", "refs": { } }, "InvalidDeploymentIdException": { "base": "

At least one of the deployment IDs was specified in an invalid format.

", "refs": { } }, "InvalidDeploymentStatusException": { "base": "

The specified deployment status doesn't exist or cannot be determined.

", "refs": { } }, "InvalidEC2TagException": { "base": "

The tag was specified in an invalid format.

", "refs": { } }, "InvalidIamUserArnException": { "base": "

The IAM user ARN was specified in an invalid format.

", "refs": { } }, "InvalidInstanceNameException": { "base": "

The specified on-premises instance name was specified in an invalid format.

", "refs": { } }, "InvalidInstanceStatusException": { "base": "

The specified instance status does not exist.

", "refs": { } }, "InvalidKeyPrefixFilterException": { "base": "

The specified key prefix filter was specified in an invalid format.

", "refs": { } }, "InvalidMinimumHealthyHostValueException": { "base": "

The minimum healthy instance value was specified in an invalid format.

", "refs": { } }, "InvalidNextTokenException": { "base": "

The next token was specified in an invalid format.

", "refs": { } }, "InvalidOperationException": { "base": "

An invalid operation was detected.

", "refs": { } }, "InvalidRegistrationStatusException": { "base": "

The registration status was specified in an invalid format.

", "refs": { } }, "InvalidRevisionException": { "base": "

The revision was specified in an invalid format.

", "refs": { } }, "InvalidRoleException": { "base": "

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.

", "refs": { } }, "InvalidSortByException": { "base": "

The column name to sort by is either not present or was specified in an invalid format.

", "refs": { } }, "InvalidSortOrderException": { "base": "

The sort order was specified in an invalid format.

", "refs": { } }, "InvalidTagException": { "base": "

The specified tag was specified in an invalid format.

", "refs": { } }, "InvalidTagFilterException": { "base": "

The specified tag filter was specified in an invalid format.

", "refs": { } }, "InvalidTimeRangeException": { "base": "

The specified time range was specified in an invalid format.

", "refs": { } }, "InvalidTriggerConfigException": { "base": "

The trigger was specified in an invalid format.

", "refs": { } }, "Key": { "base": null, "refs": { "EC2TagFilter$Key": "

The tag filter key.

", "Tag$Key": "

The tag's key.

", "TagFilter$Key": "

The on-premises instance tag filter key.

" } }, "LifecycleErrorCode": { "base": null, "refs": { "Diagnostics$errorCode": "

The associated error code:

" } }, "LifecycleEvent": { "base": "

Information about a deployment lifecycle event.

", "refs": { "LifecycleEventList$member": null } }, "LifecycleEventList": { "base": null, "refs": { "InstanceSummary$lifecycleEvents": "

A list of lifecycle events for this instance.

" } }, "LifecycleEventName": { "base": null, "refs": { "LifecycleEvent$lifecycleEventName": "

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

" } }, "LifecycleEventStatus": { "base": null, "refs": { "LifecycleEvent$status": "

The deployment lifecycle event status:

" } }, "LifecycleHookLimitExceededException": { "base": "

The limit for lifecycle hooks was exceeded.

", "refs": { } }, "LifecycleMessage": { "base": null, "refs": { "Diagnostics$message": "

The message associated with the error.

" } }, "ListApplicationRevisionsInput": { "base": "

Represents the input of a list application revisions operation.

", "refs": { } }, "ListApplicationRevisionsOutput": { "base": "

Represents the output of a list application revisions operation.

", "refs": { } }, "ListApplicationsInput": { "base": "

Represents the input of a list applications operation.

", "refs": { } }, "ListApplicationsOutput": { "base": "

Represents the output of a list applications operation.

", "refs": { } }, "ListDeploymentConfigsInput": { "base": "

Represents the input of a list deployment configurations operation.

", "refs": { } }, "ListDeploymentConfigsOutput": { "base": "

Represents the output of a list deployment configurations operation.

", "refs": { } }, "ListDeploymentGroupsInput": { "base": "

Represents the input of a list deployment groups operation.

", "refs": { } }, "ListDeploymentGroupsOutput": { "base": "

Represents the output of a list deployment groups operation.

", "refs": { } }, "ListDeploymentInstancesInput": { "base": "

Represents the input of a list deployment instances operation.

", "refs": { } }, "ListDeploymentInstancesOutput": { "base": "

Represents the output of a list deployment instances operation.

", "refs": { } }, "ListDeploymentsInput": { "base": "

Represents the input of a list deployments operation.

", "refs": { } }, "ListDeploymentsOutput": { "base": "

Represents the output of a list deployments operation.

", "refs": { } }, "ListOnPremisesInstancesInput": { "base": "

Represents the input of a list on-premises instances operation.

.", "refs": { } }, "ListOnPremisesInstancesOutput": { "base": "

Represents the output of list on-premises instances operation.

", "refs": { } }, "ListStateFilterAction": { "base": null, "refs": { "ListApplicationRevisionsInput$deployed": "

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

" } }, "LogTail": { "base": null, "refs": { "Diagnostics$logTail": "

The last portion of the diagnostic log.

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

" } }, "Message": { "base": null, "refs": { "StopDeploymentOutput$statusMessage": "

An accompanying status message.

" } }, "MinimumHealthyHosts": { "base": "

Information about minimum healthy instance.

", "refs": { "CreateDeploymentConfigInput$minimumHealthyHosts": "

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.

", "DeploymentConfigInfo$minimumHealthyHosts": "

Information about the number or percentage of minimum healthy instance.

" } }, "MinimumHealthyHostsType": { "base": null, "refs": { "MinimumHealthyHosts$type": "

The minimum healthy instance type:

In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be 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 instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.

In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return 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, AWS CodeDeploy will try 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 still succeeds." } }, "MinimumHealthyHostsValue": { "base": null, "refs": { "MinimumHealthyHosts$value": "

The minimum healthy instance value.

" } }, "NextToken": { "base": null, "refs": { "ListApplicationRevisionsInput$nextToken": "

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

", "ListApplicationRevisionsOutput$nextToken": "

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

", "ListApplicationsInput$nextToken": "

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

", "ListApplicationsOutput$nextToken": "

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, will also be returned. in the list.

", "ListDeploymentConfigsInput$nextToken": "

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

", "ListDeploymentConfigsOutput$nextToken": "

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.

", "ListDeploymentGroupsInput$nextToken": "

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.

", "ListDeploymentGroupsOutput$nextToken": "

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.

", "ListDeploymentInstancesInput$nextToken": "

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.

", "ListDeploymentInstancesOutput$nextToken": "

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.

", "ListDeploymentsInput$nextToken": "

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

", "ListDeploymentsOutput$nextToken": "

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.

", "ListOnPremisesInstancesInput$nextToken": "

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.

", "ListOnPremisesInstancesOutput$nextToken": "

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.

" } }, "RegisterApplicationRevisionInput": { "base": "

Represents the input of a register application revision operation.

", "refs": { } }, "RegisterOnPremisesInstanceInput": { "base": "

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

", "refs": { } }, "RegistrationStatus": { "base": null, "refs": { "ListOnPremisesInstancesInput$registrationStatus": "

The registration status of the on-premises instances:

" } }, "RemoveTagsFromOnPremisesInstancesInput": { "base": "

Represents the input of a remove tags from on-premises instances operation.

", "refs": { } }, "Repository": { "base": null, "refs": { "GitHubLocation$repository": "

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.

" } }, "RevisionDoesNotExistException": { "base": "

The named revision does not exist with the applicable IAM user or AWS account.

", "refs": { } }, "RevisionInfo": { "base": "

Information about an application revision.

", "refs": { "RevisionInfoList$member": null } }, "RevisionInfoList": { "base": null, "refs": { "BatchGetApplicationRevisionsOutput$revisions": "

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

" } }, "RevisionLocation": { "base": "

Information about the location of an application revision.

", "refs": { "CreateDeploymentInput$revision": "

The type and location of the revision to deploy.

", "DeploymentGroupInfo$targetRevision": "

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

", "DeploymentInfo$revision": "

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

", "GetApplicationRevisionInput$revision": "

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

", "GetApplicationRevisionOutput$revision": "

Additional information about the revision, including type and location.

", "RegisterApplicationRevisionInput$revision": "

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

", "RevisionInfo$revisionLocation": null, "RevisionLocationList$member": null } }, "RevisionLocationList": { "base": null, "refs": { "BatchGetApplicationRevisionsInput$revisions": "

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

", "ListApplicationRevisionsOutput$revisions": "

A list of locations that contain the matching revisions.

" } }, "RevisionLocationType": { "base": null, "refs": { "RevisionLocation$revisionType": "

The type of application revision:

" } }, "RevisionRequiredException": { "base": "

The revision ID was not specified.

", "refs": { } }, "Role": { "base": null, "refs": { "CreateDeploymentGroupInput$serviceRoleArn": "

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

", "DeploymentGroupInfo$serviceRoleArn": "

A service role ARN.

", "UpdateDeploymentGroupInput$serviceRoleArn": "

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

" } }, "RoleRequiredException": { "base": "

The role ID was not specified.

", "refs": { } }, "S3Bucket": { "base": null, "refs": { "ListApplicationRevisionsInput$s3Bucket": "

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

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

", "S3Location$bucket": "

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

" } }, "S3Key": { "base": null, "refs": { "ListApplicationRevisionsInput$s3KeyPrefix": "

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

", "S3Location$key": "

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

" } }, "S3Location": { "base": "

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

", "refs": { "RevisionLocation$s3Location": null } }, "ScriptName": { "base": null, "refs": { "Diagnostics$scriptName": "

The name of the script.

" } }, "SortOrder": { "base": null, "refs": { "ListApplicationRevisionsInput$sortOrder": "

The order in which to sort the list results:

If not specified, the results will be sorted in ascending order.

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

" } }, "StopDeploymentInput": { "base": "

Represents the input of a stop deployment operation.

", "refs": { } }, "StopDeploymentOutput": { "base": "

Represents the output of a stop deployment operation.

", "refs": { } }, "StopStatus": { "base": null, "refs": { "StopDeploymentOutput$status": "

The status of the stop deployment operation:

" } }, "Tag": { "base": "

Information about a tag.

", "refs": { "TagList$member": null } }, "TagFilter": { "base": "

Information about an on-premises instance tag filter.

", "refs": { "TagFilterList$member": null } }, "TagFilterList": { "base": null, "refs": { "CreateDeploymentGroupInput$onPremisesInstanceTagFilters": "

The on-premises instance tags on which to filter.

", "DeploymentGroupInfo$onPremisesInstanceTagFilters": "

The on-premises instance tags on which to filter.

", "ListOnPremisesInstancesInput$tagFilters": "

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.

", "UpdateDeploymentGroupInput$onPremisesInstanceTagFilters": "

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.

" } }, "TagFilterType": { "base": null, "refs": { "TagFilter$Type": "

The on-premises instance tag filter type:

" } }, "TagLimitExceededException": { "base": "

The maximum allowed number of tags was exceeded.

", "refs": { } }, "TagList": { "base": null, "refs": { "AddTagsToOnPremisesInstancesInput$tags": "

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.

", "InstanceInfo$tags": "

The tags currently associated with the on-premises instance.

", "RemoveTagsFromOnPremisesInstancesInput$tags": "

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

" } }, "TagRequiredException": { "base": "

A tag was not specified.

", "refs": { } }, "TimeRange": { "base": "

Information about a time range.

", "refs": { "ListDeploymentsInput$createTimeRange": "

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

" } }, "Timestamp": { "base": null, "refs": { "ApplicationInfo$createTime": "

The time at which the application was created.

", "DeploymentConfigInfo$createTime": "

The time at which the deployment configuration was created.

", "DeploymentInfo$createTime": "

A timestamp indicating when the deployment was created.

", "DeploymentInfo$startTime": "

A timestamp indicating when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end servers that participate in the deployment process.

", "DeploymentInfo$completeTime": "

A timestamp indicating when the deployment was complete.

", "GenericRevisionInfo$firstUsedTime": "

When the revision was first used by AWS CodeDeploy.

", "GenericRevisionInfo$lastUsedTime": "

When the revision was last used by AWS CodeDeploy.

", "GenericRevisionInfo$registerTime": "

When the revision was registered with AWS CodeDeploy.

", "InstanceInfo$registerTime": "

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

", "InstanceInfo$deregisterTime": "

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

", "InstanceSummary$lastUpdatedAt": "

A timestamp indicating when the instance information was last updated.

", "LifecycleEvent$startTime": "

A timestamp indicating when the deployment lifecycle event started.

", "LifecycleEvent$endTime": "

A timestamp indicating when the deployment lifecycle event ended.

", "TimeRange$start": "

The start time of the time range.

Specify null to leave the start time open-ended.", "TimeRange$end": "

The end time of the time range.

Specify null to leave the end time open-ended." } }, "TriggerConfig": { "base": "

Information about notification triggers for the deployment group.

", "refs": { "TriggerConfigList$member": null } }, "TriggerConfigList": { "base": null, "refs": { "CreateDeploymentGroupInput$triggerConfigurations": "

Information about triggers to create when the deployment group is created.

", "DeploymentGroupInfo$triggerConfigurations": "

A list of associated triggers.

", "UpdateDeploymentGroupInput$triggerConfigurations": "

Information about triggers to change when the deployment group is updated.

" } }, "TriggerEventType": { "base": null, "refs": { "TriggerEventTypeList$member": null } }, "TriggerEventTypeList": { "base": null, "refs": { "TriggerConfig$triggerEvents": "

The event type or types for which notifications are triggered.

The following event type values are supported:

" } }, "TriggerName": { "base": null, "refs": { "TriggerConfig$triggerName": "

The name of the notification trigger.

" } }, "TriggerTargetArn": { "base": null, "refs": { "TriggerConfig$triggerTargetArn": "

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

" } }, "TriggerTargetsLimitExceededException": { "base": "

The maximum allowed number of triggers was exceeded.

", "refs": { } }, "UpdateApplicationInput": { "base": "

Represents the input of an update application operation.

", "refs": { } }, "UpdateDeploymentGroupInput": { "base": "

Represents the input of an update deployment group operation.

", "refs": { } }, "UpdateDeploymentGroupOutput": { "base": "

Represents the output of an update deployment group operation.

", "refs": { } }, "Value": { "base": null, "refs": { "EC2TagFilter$Value": "

The tag filter value.

", "Tag$Value": "

The tag's value.

", "TagFilter$Value": "

The on-premises instance tag filter value.

" } }, "VersionId": { "base": null, "refs": { "S3Location$version": "

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 will use the most recent version by default.

" } } } }