There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for CodeDeploy using AWS SDKs
The following code examples show you how to use AWS CodeDeploy with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
**More resources**
+ **[ CodeDeploy Developer Guide](https://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html)** – More information about CodeDeploy.
+ **[CodeDeploy API Reference](https://docs.aws.amazon.com/codedeploy/latest/APIReference/Welcome.html)** – Details about all available CodeDeploy actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](codedeploy_code_examples_basics.md)
+ [Actions](codedeploy_code_examples_actions.md)
+ [`AddTagsToOnPremisesInstances`](codedeploy_example_codedeploy_AddTagsToOnPremisesInstances_section.md)
+ [`BatchGetApplications`](codedeploy_example_codedeploy_BatchGetApplications_section.md)
+ [`BatchGetDeployments`](codedeploy_example_codedeploy_BatchGetDeployments_section.md)
+ [`BatchGetOnPremisesInstances`](codedeploy_example_codedeploy_BatchGetOnPremisesInstances_section.md)
+ [`CreateApplication`](codedeploy_example_codedeploy_CreateApplication_section.md)
+ [`CreateDeployment`](codedeploy_example_codedeploy_CreateDeployment_section.md)
+ [`CreateDeploymentConfig`](codedeploy_example_codedeploy_CreateDeploymentConfig_section.md)
+ [`CreateDeploymentGroup`](codedeploy_example_codedeploy_CreateDeploymentGroup_section.md)
+ [`DeleteApplication`](codedeploy_example_codedeploy_DeleteApplication_section.md)
+ [`DeleteDeploymentConfig`](codedeploy_example_codedeploy_DeleteDeploymentConfig_section.md)
+ [`DeleteDeploymentGroup`](codedeploy_example_codedeploy_DeleteDeploymentGroup_section.md)
+ [`DeregisterOnPremisesInstance`](codedeploy_example_codedeploy_DeregisterOnPremisesInstance_section.md)
+ [`GetApplication`](codedeploy_example_codedeploy_GetApplication_section.md)
+ [`GetApplicationRevision`](codedeploy_example_codedeploy_GetApplicationRevision_section.md)
+ [`GetDeployment`](codedeploy_example_codedeploy_GetDeployment_section.md)
+ [`GetDeploymentConfig`](codedeploy_example_codedeploy_GetDeploymentConfig_section.md)
+ [`GetDeploymentGroup`](codedeploy_example_codedeploy_GetDeploymentGroup_section.md)
+ [`GetDeploymentInstance`](codedeploy_example_codedeploy_GetDeploymentInstance_section.md)
+ [`GetOnPremisesInstance`](codedeploy_example_codedeploy_GetOnPremisesInstance_section.md)
+ [`ListApplicationRevisions`](codedeploy_example_codedeploy_ListApplicationRevisions_section.md)
+ [`ListApplications`](codedeploy_example_codedeploy_ListApplications_section.md)
+ [`ListDeploymentConfigs`](codedeploy_example_codedeploy_ListDeploymentConfigs_section.md)
+ [`ListDeploymentGroups`](codedeploy_example_codedeploy_ListDeploymentGroups_section.md)
+ [`ListDeploymentInstances`](codedeploy_example_codedeploy_ListDeploymentInstances_section.md)
+ [`ListDeployments`](codedeploy_example_codedeploy_ListDeployments_section.md)
+ [`ListOnPremisesInstances`](codedeploy_example_codedeploy_ListOnPremisesInstances_section.md)
+ [`RegisterApplicationRevision`](codedeploy_example_codedeploy_RegisterApplicationRevision_section.md)
+ [`RegisterOnPremisesInstance`](codedeploy_example_codedeploy_RegisterOnPremisesInstance_section.md)
+ [`RemoveTagsFromOnPremisesInstances`](codedeploy_example_codedeploy_RemoveTagsFromOnPremisesInstances_section.md)
+ [`StopDeployment`](codedeploy_example_codedeploy_StopDeployment_section.md)
+ [`UpdateApplication`](codedeploy_example_codedeploy_UpdateApplication_section.md)
+ [`UpdateDeploymentGroup`](codedeploy_example_codedeploy_UpdateDeploymentGroup_section.md)
# Basic examples for CodeDeploy using AWS SDKs
The following code examples show how to use the basics of AWS CodeDeploy with AWS SDKs.
**Contents**
+ [Actions](codedeploy_code_examples_actions.md)
+ [`AddTagsToOnPremisesInstances`](codedeploy_example_codedeploy_AddTagsToOnPremisesInstances_section.md)
+ [`BatchGetApplications`](codedeploy_example_codedeploy_BatchGetApplications_section.md)
+ [`BatchGetDeployments`](codedeploy_example_codedeploy_BatchGetDeployments_section.md)
+ [`BatchGetOnPremisesInstances`](codedeploy_example_codedeploy_BatchGetOnPremisesInstances_section.md)
+ [`CreateApplication`](codedeploy_example_codedeploy_CreateApplication_section.md)
+ [`CreateDeployment`](codedeploy_example_codedeploy_CreateDeployment_section.md)
+ [`CreateDeploymentConfig`](codedeploy_example_codedeploy_CreateDeploymentConfig_section.md)
+ [`CreateDeploymentGroup`](codedeploy_example_codedeploy_CreateDeploymentGroup_section.md)
+ [`DeleteApplication`](codedeploy_example_codedeploy_DeleteApplication_section.md)
+ [`DeleteDeploymentConfig`](codedeploy_example_codedeploy_DeleteDeploymentConfig_section.md)
+ [`DeleteDeploymentGroup`](codedeploy_example_codedeploy_DeleteDeploymentGroup_section.md)
+ [`DeregisterOnPremisesInstance`](codedeploy_example_codedeploy_DeregisterOnPremisesInstance_section.md)
+ [`GetApplication`](codedeploy_example_codedeploy_GetApplication_section.md)
+ [`GetApplicationRevision`](codedeploy_example_codedeploy_GetApplicationRevision_section.md)
+ [`GetDeployment`](codedeploy_example_codedeploy_GetDeployment_section.md)
+ [`GetDeploymentConfig`](codedeploy_example_codedeploy_GetDeploymentConfig_section.md)
+ [`GetDeploymentGroup`](codedeploy_example_codedeploy_GetDeploymentGroup_section.md)
+ [`GetDeploymentInstance`](codedeploy_example_codedeploy_GetDeploymentInstance_section.md)
+ [`GetOnPremisesInstance`](codedeploy_example_codedeploy_GetOnPremisesInstance_section.md)
+ [`ListApplicationRevisions`](codedeploy_example_codedeploy_ListApplicationRevisions_section.md)
+ [`ListApplications`](codedeploy_example_codedeploy_ListApplications_section.md)
+ [`ListDeploymentConfigs`](codedeploy_example_codedeploy_ListDeploymentConfigs_section.md)
+ [`ListDeploymentGroups`](codedeploy_example_codedeploy_ListDeploymentGroups_section.md)
+ [`ListDeploymentInstances`](codedeploy_example_codedeploy_ListDeploymentInstances_section.md)
+ [`ListDeployments`](codedeploy_example_codedeploy_ListDeployments_section.md)
+ [`ListOnPremisesInstances`](codedeploy_example_codedeploy_ListOnPremisesInstances_section.md)
+ [`RegisterApplicationRevision`](codedeploy_example_codedeploy_RegisterApplicationRevision_section.md)
+ [`RegisterOnPremisesInstance`](codedeploy_example_codedeploy_RegisterOnPremisesInstance_section.md)
+ [`RemoveTagsFromOnPremisesInstances`](codedeploy_example_codedeploy_RemoveTagsFromOnPremisesInstances_section.md)
+ [`StopDeployment`](codedeploy_example_codedeploy_StopDeployment_section.md)
+ [`UpdateApplication`](codedeploy_example_codedeploy_UpdateApplication_section.md)
+ [`UpdateDeploymentGroup`](codedeploy_example_codedeploy_UpdateDeploymentGroup_section.md)
# Actions for CodeDeploy using AWS SDKs
The following code examples demonstrate how to perform individual CodeDeploy actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [AWS CodeDeploy API Reference](https://docs.aws.amazon.com/codedeploy/latest/APIReference/Welcome.html).
**Topics**
+ [`AddTagsToOnPremisesInstances`](codedeploy_example_codedeploy_AddTagsToOnPremisesInstances_section.md)
+ [`BatchGetApplications`](codedeploy_example_codedeploy_BatchGetApplications_section.md)
+ [`BatchGetDeployments`](codedeploy_example_codedeploy_BatchGetDeployments_section.md)
+ [`BatchGetOnPremisesInstances`](codedeploy_example_codedeploy_BatchGetOnPremisesInstances_section.md)
+ [`CreateApplication`](codedeploy_example_codedeploy_CreateApplication_section.md)
+ [`CreateDeployment`](codedeploy_example_codedeploy_CreateDeployment_section.md)
+ [`CreateDeploymentConfig`](codedeploy_example_codedeploy_CreateDeploymentConfig_section.md)
+ [`CreateDeploymentGroup`](codedeploy_example_codedeploy_CreateDeploymentGroup_section.md)
+ [`DeleteApplication`](codedeploy_example_codedeploy_DeleteApplication_section.md)
+ [`DeleteDeploymentConfig`](codedeploy_example_codedeploy_DeleteDeploymentConfig_section.md)
+ [`DeleteDeploymentGroup`](codedeploy_example_codedeploy_DeleteDeploymentGroup_section.md)
+ [`DeregisterOnPremisesInstance`](codedeploy_example_codedeploy_DeregisterOnPremisesInstance_section.md)
+ [`GetApplication`](codedeploy_example_codedeploy_GetApplication_section.md)
+ [`GetApplicationRevision`](codedeploy_example_codedeploy_GetApplicationRevision_section.md)
+ [`GetDeployment`](codedeploy_example_codedeploy_GetDeployment_section.md)
+ [`GetDeploymentConfig`](codedeploy_example_codedeploy_GetDeploymentConfig_section.md)
+ [`GetDeploymentGroup`](codedeploy_example_codedeploy_GetDeploymentGroup_section.md)
+ [`GetDeploymentInstance`](codedeploy_example_codedeploy_GetDeploymentInstance_section.md)
+ [`GetOnPremisesInstance`](codedeploy_example_codedeploy_GetOnPremisesInstance_section.md)
+ [`ListApplicationRevisions`](codedeploy_example_codedeploy_ListApplicationRevisions_section.md)
+ [`ListApplications`](codedeploy_example_codedeploy_ListApplications_section.md)
+ [`ListDeploymentConfigs`](codedeploy_example_codedeploy_ListDeploymentConfigs_section.md)
+ [`ListDeploymentGroups`](codedeploy_example_codedeploy_ListDeploymentGroups_section.md)
+ [`ListDeploymentInstances`](codedeploy_example_codedeploy_ListDeploymentInstances_section.md)
+ [`ListDeployments`](codedeploy_example_codedeploy_ListDeployments_section.md)
+ [`ListOnPremisesInstances`](codedeploy_example_codedeploy_ListOnPremisesInstances_section.md)
+ [`RegisterApplicationRevision`](codedeploy_example_codedeploy_RegisterApplicationRevision_section.md)
+ [`RegisterOnPremisesInstance`](codedeploy_example_codedeploy_RegisterOnPremisesInstance_section.md)
+ [`RemoveTagsFromOnPremisesInstances`](codedeploy_example_codedeploy_RemoveTagsFromOnPremisesInstances_section.md)
+ [`StopDeployment`](codedeploy_example_codedeploy_StopDeployment_section.md)
+ [`UpdateApplication`](codedeploy_example_codedeploy_UpdateApplication_section.md)
+ [`UpdateDeploymentGroup`](codedeploy_example_codedeploy_UpdateDeploymentGroup_section.md)
# Use `AddTagsToOnPremisesInstances` with a CLI
The following code examples show how to use `AddTagsToOnPremisesInstances`.
------
#### [ CLI ]
**AWS CLI**
**To add tags to on-premises instances**
The following `add-tags-to-on-premises-instances` example associates in AWS CodeDeploy the same on-premises instance tag to two on-premises instances. It does not register the on-premises instances with AWS CodeDeploy.
```
aws deploy add-tags-to-on-premises-instances \
--instance-names AssetTag12010298EX AssetTag23121309EX \
--tags Key=Name,Value=CodeDeployDemo-OnPrem
```
This command produces no output.
+ For API details, see [AddTagsToOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/add-tags-to-on-premises-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example adds an on-premises instance tag with the specified key and value for the specified on-premises instance.**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ For API details, see [AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example adds an on-premises instance tag with the specified key and value for the specified on-premises instance.**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ For API details, see [AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `BatchGetApplications` with a CLI
The following code examples show how to use `BatchGetApplications`.
------
#### [ CLI ]
**AWS CLI**
**To get information about multiple applications**
The following `batch-get-applications` example displays information about multiple applications that are associated with the user's AWS account.
```
aws deploy batch-get-applications --application-names WordPress_App MyOther_App
```
Output:
```
{
"applicationsInfo": [
{
"applicationName": "WordPress_App",
"applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE",
"createTime": 1407878168.078,
"linkedToGitHub": false
},
{
"applicationName": "MyOther_App",
"applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE",
"createTime": 1407453571.63,
"linkedToGitHub": false
}
]
}
```
+ For API details, see [BatchGetApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-applications.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified applications.**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**Output:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
1ecfd602-62f1-4038-8f0d-06688EXAMPLE CodePipelineDemoApplication 8/13/2015 5:53:26 PM False
```
+ For API details, see [BatchGetApplications](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified applications.**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**Output:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
1ecfd602-62f1-4038-8f0d-06688EXAMPLE CodePipelineDemoApplication 8/13/2015 5:53:26 PM False
```
+ For API details, see [BatchGetApplications](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `BatchGetDeployments` with a CLI
The following code examples show how to use `BatchGetDeployments`.
------
#### [ CLI ]
**AWS CLI**
**To get information about multiple deployments**
The following `batch-get-deployments` example displays information about multiple deployments that are associated with the user's AWS account.
```
aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222
```
Output:
```
{
"deploymentsInfo": [
{
"applicationName": "WordPress_App",
"status": "Failed",
"deploymentOverview": {
"Failed": 0,
"InProgress": 0,
"Skipped": 0,
"Succeeded": 1,
"Pending": 0
},
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"creator": "user",
"deploymentGroupName": "WordPress_DG",
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"version": "uTecLusEXAMPLEFXtfUcyfV8bEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPressApp.zip"
}
},
"deploymentId": "d-A1B2C3111",
"createTime": 1408480721.9,
"completeTime": 1408480741.822
},
{
"applicationName": "MyOther_App",
"status": "Failed",
"deploymentOverview": {
"Failed": 1,
"InProgress": 0,
"Skipped": 0,
"Succeeded": 0,
"Pending": 0
},
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"creator": "user",
"errorInformation": {
"message": "Deployment failed: Constraint default violated: No hosts succeeded.",
"code": "HEALTH_CONSTRAINTS"
},
"deploymentGroupName": "MyOther_DG",
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"",
"bucket": "amzn-s3-demo-bucket",
"key": "MyOtherApp.zip"
}
},
"deploymentId": "d-A1B2C3222",
"createTime": 1409764576.589,
"completeTime": 1409764596.101
}
]
}
```
+ For API details, see [BatchGetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployments.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified deployments.**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**Output:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
ApplicationName : CodePipelineDemoApplication
CompleteTime : 7/23/2015 6:07:30 PM
CreateTime : 7/23/2015 6:06:29 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodePipelineDemoFleet
DeploymentId : d-RR0T5KTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
+ For API details, see [BatchGetDeployments](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified deployments.**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**Output:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
ApplicationName : CodePipelineDemoApplication
CompleteTime : 7/23/2015 6:07:30 PM
CreateTime : 7/23/2015 6:06:29 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodePipelineDemoFleet
DeploymentId : d-RR0T5KTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
+ For API details, see [BatchGetDeployments](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `BatchGetOnPremisesInstances` with a CLI
The following code examples show how to use `BatchGetOnPremisesInstances`.
------
#### [ CLI ]
**AWS CLI**
**To get information about one or more on-premises instances**
The following `batch-get-on-premises-instances` example gets information about two on-premises instances.
```
aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX
```
Output:
```
{
"instanceInfos": [
{
"iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX",
"tags": [
{
"Value": "CodeDeployDemo-OnPrem",
"Key": "Name"
}
],
"instanceName": "AssetTag12010298EX",
"registerTime": 1425579465.228,
"instanceArn": "arn:aws:codedeploy:us-west-2:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh"
},
{
"iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag23121309EX",
"tags": [
{
"Value": "CodeDeployDemo-OnPrem",
"Key": "Name"
}
],
"instanceName": "AssetTag23121309EX",
"registerTime": 1425595585.988,
"instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was"
}
]
}
```
+ For API details, see [BatchGetOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-on-premises-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified on-premises instances.**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**Output:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployFRWUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX-2_XmeSz18rEX
InstanceName : AssetTag12010298EX-2
RegisterTime : 4/3/2015 6:38:52 PM
Tags : {Name}
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ For API details, see [BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified on-premises instances.**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**Output:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployFRWUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX-2_XmeSz18rEX
InstanceName : AssetTag12010298EX-2
RegisterTime : 4/3/2015 6:38:52 PM
Tags : {Name}
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ For API details, see [BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateApplication` with a CLI
The following code examples show how to use `CreateApplication`.
------
#### [ CLI ]
**AWS CLI**
**To create an application**
The following `create-application` example creates an application and associates it with the user's AWS account.
```
aws deploy create-application --application-name MyOther_App
```
Output:
```
{
"applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ For API details, see [CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-application.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a new application with the specified name.**
```
New-CDApplication -ApplicationName MyNewApplication
```
**Output:**
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ For API details, see [CreateApplication](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a new application with the specified name.**
```
New-CDApplication -ApplicationName MyNewApplication
```
**Output:**
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ For API details, see [CreateApplication](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateDeployment` with a CLI
The following code examples show how to use `CreateDeployment`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create a CodeDeploy deployment using the EC2/On-premises compute platform**
The following `create-deployment` example creates a deployment and associates it with the user's AWS account.
```
aws deploy create-deployment \
--application-name WordPress_App \
--deployment-config-name CodeDeployDefault.OneAtATime \
--deployment-group-name WordPress_DG \
--description "My demo deployment" \
--s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
```
Output:
```
{
"deploymentId": "d-A1B2C3111"
}
```
**Example 2: To create a CodeDeploy deployment using the Amazon ECS compute platform**
The following `create-deployment` example uses the following two files to deploy an Amazon ECS service.
Contents of `create-deployment.json` file:
```
{
"applicationName": "ecs-deployment",
"deploymentGroupName": "ecs-deployment-dg",
"revision": {
"revisionType": "S3",
"s3Location": {
"bucket": "ecs-deployment-bucket",
"key": "appspec.yaml",
"bundleType": "YAML"
}
}
}
```
That file, in turn, retrieves the following file `appspec.yaml` from an S3 bucket called `ecs-deployment-bucket`.
```
version: 0.0
Resources:
- TargetService:
Type: AWS::ECS::Service
Properties:
TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2"
LoadBalancerInfo:
ContainerName: "sample-app"
ContainerPort: 80
PlatformVersion: "LATEST"
```
Command:
```
aws deploy create-deployment \
--cli-input-json file://create-deployment.json \
--region us-east-1
```
Output:
```
{
"deploymentId": "d-1234ABCDE"
}
```
For more information, see [CreateDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a new deployment for the specified application and deployment group with the specified deployment configuration and application revision.**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3
```
**Output:**
```
d-ZHROG7UEX
```
**Example 2: This example shows how to specify groups of 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.**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**Output:**
```
d-ZHROG7UEX
```
+ For API details, see [CreateDeployment](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a new deployment for the specified application and deployment group with the specified deployment configuration and application revision.**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3
```
**Output:**
```
d-ZHROG7UEX
```
**Example 2: This example shows how to specify groups of 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.**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**Output:**
```
d-ZHROG7UEX
```
+ For API details, see [CreateDeployment](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateDeploymentConfig` with a CLI
The following code examples show how to use `CreateDeploymentConfig`.
------
#### [ CLI ]
**AWS CLI**
**To create a custom deployment configuration**
The following `create-deployment-config` example creates a custom deployment configuration and associates it with the user's AWS account.
```
aws deploy create-deployment-config \
--deployment-config-name ThreeQuartersHealthy \
--minimum-healthy-hosts type=FLEET_PERCENT,value=75
```
Output:
```
{
"deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ For API details, see [CreateDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-config.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a new deployment configuration with the specified name and behavior.**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**Output:**
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ For API details, see [CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a new deployment configuration with the specified name and behavior.**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**Output:**
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ For API details, see [CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateDeploymentGroup` with a CLI
The following code examples show how to use `CreateDeploymentGroup`.
------
#### [ CLI ]
**AWS CLI**
**To create a deployment group**
The following `create-deployment-group` example creates a deployment group and associates it with the specified application and the user's AWS account.
```
aws deploy create-deployment-group \
--application-name WordPress_App \
--auto-scaling-groups CodeDeployDemo-ASG \
--deployment-config-name CodeDeployDefault.OneAtATime \
--deployment-group-name WordPress_DG \
--ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE \
--service-role-arn arn:aws:iam::123456789012:role/CodeDeployDemoRole
```
Output:
```
{
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ For API details, see [CreateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a deployment group with the specified name, Auto Scaling group, deployment configuration, tag, and service role, for the specified application.**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo
```
**Output:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**Example 2: This example shows how to specify groups of 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.**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**Output:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ For API details, see [CreateDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a deployment group with the specified name, Auto Scaling group, deployment configuration, tag, and service role, for the specified application.**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo
```
**Output:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**Example 2: This example shows how to specify groups of 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.**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**Output:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ For API details, see [CreateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteApplication` with a CLI
The following code examples show how to use `DeleteApplication`.
------
#### [ CLI ]
**AWS CLI**
**To delete an application**
The following `delete-application` example deletes the specified application that is associated with the user's AWS account.
```
aws deploy delete-application --application-name WordPress_App
```
This command produces no output.
+ For API details, see [DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-application.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the application with the specified name. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the application without a prompt.**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ For API details, see [DeleteApplication](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the application with the specified name. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the application without a prompt.**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ For API details, see [DeleteApplication](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteDeploymentConfig` with a CLI
The following code examples show how to use `DeleteDeploymentConfig`.
------
#### [ CLI ]
**AWS CLI**
**To delete a deployment configuration**
The following `delete-deployment-config` example deletes a custom deployment configuration that is associated with the user's AWS account.
```
aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy
```
This command produces no output.
+ For API details, see [DeleteDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-config.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the deployment configuration with the specified name. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the deployment configuration without a prompt.**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ For API details, see [DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the deployment configuration with the specified name. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the deployment configuration without a prompt.**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ For API details, see [DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteDeploymentGroup` with a CLI
The following code examples show how to use `DeleteDeploymentGroup`.
------
#### [ CLI ]
**AWS CLI**
**To delete a deployment group**
The following `delete-deployment-group` example deletes a deployment group that is associated with the specified application.
```
aws deploy delete-deployment-group \
--application-name WordPress_App \
--deployment-group-name WordPress_DG
```
Output:
```
{
"hooksNotCleanedUp": []
}
```
+ For API details, see [DeleteDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the deployment group with the specified name for the specified application. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the deployment group without a prompt.**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ For API details, see [DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the deployment group with the specified name for the specified application. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the deployment group without a prompt.**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ For API details, see [DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeregisterOnPremisesInstance` with a CLI
The following code examples show how to use `DeregisterOnPremisesInstance`.
------
#### [ CLI ]
**AWS CLI**
**To deregister an on-premises instance**
The following `deregister-on-premises-instance` example deregisters an on-premises instance with AWS CodeDeploy, but it does not delete the IAM user associated with the instance, nor does it disassociate in AWS CodeDeploy the on-premises instance tags from the instance. It also does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance.
```
aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX
```
This command produces no output.
+ For API details, see [DeregisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister-on-premises-instance.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deregisters the on-premises instance with the specified name.**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ For API details, see [DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deregisters the on-premises instance with the specified name.**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ For API details, see [DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetApplication` with a CLI
The following code examples show how to use `GetApplication`.
------
#### [ CLI ]
**AWS CLI**
**To get information about an application**
The following `get-application` example displays information about an application that is associated with the user's AWS account.
```
aws deploy get-application --application-name WordPress_App
```
Output:
```
{
"application": {
"applicationName": "WordPress_App",
"applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"createTime": 1407878168.078,
"linkedToGitHub": false
}
}
```
+ For API details, see [GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified application.**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**Output:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ For API details, see [GetApplication](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified application.**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**Output:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ For API details, see [GetApplication](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetApplicationRevision` with a CLI
The following code examples show how to use `GetApplicationRevision`.
------
#### [ CLI ]
**AWS CLI**
**To get information about an application revision**
The following `get-application-revision` example displays information about an application revision that is associated with the specified application.
```
aws deploy get-application-revision \
--application-name WordPress_App \
--s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
```
Output:
```
{
"applicationName": "WordPress_App",
"revisionInfo": {
"description": "Application revision registered by Deployment ID: d-A1B2C3111",
"registerTime": 1411076520.009,
"deploymentGroups": "WordPress_DG",
"lastUsedTime": 1411076520.009,
"firstUsedTime": 1411076520.009
},
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"eTag": "dd56cfdEXAMPLE8e768f9d77fEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPressApp.zip"
}
}
}
```
+ For API details, see [GetApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application-revision.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified application revision.**
```
$revision = Get-CDApplicationRevision -ApplicationName CodeDeployDemoApplication -S3Location_Bucket amzn-s3-demo-bucket -Revision_RevisionType S3 -S3Location_Key 5xd27EX.zip -S3Location_BundleType zip -S3Location_ETag 4565c1ac97187f190c1a90265EXAMPLE
Write-Output ("Description = " + $revision.RevisionInfo.Description + ", RegisterTime = " + $revision.RevisionInfo.RegisterTime)
```
**Output:**
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ For API details, see [GetApplicationRevision](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified application revision.**
```
$revision = Get-CDApplicationRevision -ApplicationName CodeDeployDemoApplication -S3Location_Bucket amzn-s3-demo-bucket -Revision_RevisionType S3 -S3Location_Key 5xd27EX.zip -S3Location_BundleType zip -S3Location_ETag 4565c1ac97187f190c1a90265EXAMPLE
Write-Output ("Description = " + $revision.RevisionInfo.Description + ", RegisterTime = " + $revision.RevisionInfo.RegisterTime)
```
**Output:**
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ For API details, see [GetApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetDeployment` with a CLI
The following code examples show how to use `GetDeployment`.
------
#### [ CLI ]
**AWS CLI**
**To get information about a deployment**
The following `get-deployment` example displays information about a deployment that is associated with the user's AWS account.
```
aws deploy get-deployment --deployment-id d-A1B2C3123
```
Output:
```
{
"deploymentInfo": {
"applicationName": "WordPress_App",
"status": "Succeeded",
"deploymentOverview": {
"Failed": 0,
"InProgress": 0,
"Skipped": 0,
"Succeeded": 1,
"Pending": 0
},
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"creator": "user",
"description": "My WordPress app deployment",
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPressApp.zip"
}
},
"deploymentId": "d-A1B2C3123",
"deploymentGroupName": "WordPress_DG",
"createTime": 1409764576.589,
"completeTime": 1409764596.101,
"ignoreApplicationStopFailures": false
}
}
```
+ For API details, see [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets summary information about the specified deployment.**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**Output:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
**Example 2: This example gets information about the status of instances that are participating in the specified deployment.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**Output:**
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**Example 3: This example gets information about the application revision for the specified deployment.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**Output:**
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ For API details, see [GetDeployment](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets summary information about the specified deployment.**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**Output:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
**Example 2: This example gets information about the status of instances that are participating in the specified deployment.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**Output:**
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**Example 3: This example gets information about the application revision for the specified deployment.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**Output:**
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ For API details, see [GetDeployment](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetDeploymentConfig` with a CLI
The following code examples show how to use `GetDeploymentConfig`.
------
#### [ CLI ]
**AWS CLI**
**To get information about a deployment configuration**
The following `get-deployment-config` example displays information about a deployment configuration that is associated with the user's AWS account.
```
aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy
```
Output:
```
{
"deploymentConfigInfo": {
"deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"minimumHealthyHosts": {
"type": "FLEET_PERCENT",
"value": 75
},
"createTime": 1411081164.379,
"deploymentConfigName": "ThreeQuartersHealthy"
}
}
```
+ For API details, see [GetDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-config.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets summary information about the specified deployment configuration.**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**Output:**
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**Example 2: This example gets information about the definition of the specified deployment configuration.**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**Output:**
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ For API details, see [GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets summary information about the specified deployment configuration.**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**Output:**
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**Example 2: This example gets information about the definition of the specified deployment configuration.**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**Output:**
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ For API details, see [GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetDeploymentGroup` with a CLI
The following code examples show how to use `GetDeploymentGroup`.
------
#### [ CLI ]
**AWS CLI**
**To view information about a deployment group**
The following `get-deployment-group` example displays information about a deployment group that is associated with the specified application.
```
aws deploy get-deployment-group \
--application-name WordPress_App \
--deployment-group-name WordPress_DG
```
Output:
```
{
"deploymentGroupInfo": {
"applicationName": "WordPress_App",
"autoScalingGroups": [
"CodeDeployDemo-ASG"
],
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"ec2TagFilters": [
{
"Type": "KEY_AND_VALUE",
"Value": "CodeDeployDemo",
"Key": "Name"
}
],
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole",
"deploymentGroupName": "WordPress_DG"
}
}
```
+ For API details, see [GetDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified deployment group.**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Output:**
```
ApplicationName : CodeDeployDemoApplication
AutoScalingGroups : {}
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupId : 7d7c098a-b444-4b27-96ef-22791EXAMPLE
DeploymentGroupName : CodeDeployDemoFleet
Ec2TagFilters : {Name}
OnPremisesInstanceTagFilters : {}
ServiceRoleArn : arn:aws:iam::80398EXAMPLE:role/CodeDeploySampleStack-4ph6EX-CodeDeployTrustRole-O9MWP7XTL8EX
TargetRevision : Amazon.CodeDeploy.Model.RevisionLocation
```
+ For API details, see [GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified deployment group.**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Output:**
```
ApplicationName : CodeDeployDemoApplication
AutoScalingGroups : {}
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupId : 7d7c098a-b444-4b27-96ef-22791EXAMPLE
DeploymentGroupName : CodeDeployDemoFleet
Ec2TagFilters : {Name}
OnPremisesInstanceTagFilters : {}
ServiceRoleArn : arn:aws:iam::80398EXAMPLE:role/CodeDeploySampleStack-4ph6EX-CodeDeployTrustRole-O9MWP7XTL8EX
TargetRevision : Amazon.CodeDeploy.Model.RevisionLocation
```
+ For API details, see [GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetDeploymentInstance` with a CLI
The following code examples show how to use `GetDeploymentInstance`.
------
#### [ CLI ]
**AWS CLI**
**To get information about a deployment instance**
The following `get-deployment-instance` example displays information about a deployment instance that is associated with the specified deployment.
```
aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX
```
Output:
```
{
"instanceSummary": {
"instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX",
"lifecycleEvents": [
{
"status": "Succeeded",
"endTime": 1408480726.569,
"startTime": 1408480726.437,
"lifecycleEventName": "ApplicationStop"
},
{
"status": "Succeeded",
"endTime": 1408480728.016,
"startTime": 1408480727.665,
"lifecycleEventName": "DownloadBundle"
},
{
"status": "Succeeded",
"endTime": 1408480729.744,
"startTime": 1408480729.125,
"lifecycleEventName": "BeforeInstall"
},
{
"status": "Succeeded",
"endTime": 1408480730.979,
"startTime": 1408480730.844,
"lifecycleEventName": "Install"
},
{
"status": "Failed",
"endTime": 1408480732.603,
"startTime": 1408480732.1,
"lifecycleEventName": "AfterInstall"
},
{
"status": "Skipped",
"endTime": 1408480732.606,
"lifecycleEventName": "ApplicationStart"
},
{
"status": "Skipped",
"endTime": 1408480732.606,
"lifecycleEventName": "ValidateService"
}
],
"deploymentId": "d-QA4G4F9EX",
"lastUpdatedAt": 1408480733.152,
"status": "Failed"
}
}
```
+ For API details, see [GetDeploymentInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-instance.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified instance for the specified deployment.**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**Output:**
```
DeploymentId : d-QZMRGSTEX
InstanceId : arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-254e22EX
LastUpdatedAt : 7/23/2015 11:25:24 PM
LifecycleEvents : {ApplicationStop, DownloadBundle, BeforeInstall, Install...}
Status : Succeeded
```
+ For API details, see [GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified instance for the specified deployment.**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**Output:**
```
DeploymentId : d-QZMRGSTEX
InstanceId : arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-254e22EX
LastUpdatedAt : 7/23/2015 11:25:24 PM
LifecycleEvents : {ApplicationStop, DownloadBundle, BeforeInstall, Install...}
Status : Succeeded
```
+ For API details, see [GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetOnPremisesInstance` with a CLI
The following code examples show how to use `GetOnPremisesInstance`.
------
#### [ CLI ]
**AWS CLI**
**To get information about an on-premises instance**
The following `get-on-premises-instance` example retrieves information about the specified on-premises instance.
```
aws deploy get-on-premises-instance --instance-name AssetTag12010298EX
```
Output:
```
{
"instanceInfo": {
"iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX",
"tags": [
{
"Value": "CodeDeployDemo-OnPrem",
"Key": "Name"
}
],
"instanceName": "AssetTag12010298EX",
"registerTime": 1425579465.228,
"instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh"
}
}
```
+ For API details, see [GetOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-on-premises-instance.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about the specified on-premises instance.**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**Output:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ For API details, see [GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about the specified on-premises instance.**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**Output:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ For API details, see [GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListApplicationRevisions` with a CLI
The following code examples show how to use `ListApplicationRevisions`.
------
#### [ CLI ]
**AWS CLI**
**To get information about application revisions**
The following `list-application-revisions` example displays information about all application revisions that are associated with the specified application.
```
aws deploy list-application-revisions \
--application-name WordPress_App \
--s-3-bucket amzn-s3-demo-bucket \
--deployed exclude \
--s-3-key-prefix WordPress_ \
--sort-by lastUsedTime \
--sort-order descending
```
Output:
```
{
"revisions": [
{
"revisionType": "S3",
"s3Location": {
"version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPress_App.zip",
"bundleType": "zip"
}
},
{
"revisionType": "S3",
"s3Location": {
"version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPress_App_2-0.zip",
"bundleType": "zip"
}
}
]
}
```
+ For API details, see [ListApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-application-revisions.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about available revisions for the specified application.**
```
ForEach ($revision in (Get-CDApplicationRevisionList -ApplicationName CodeDeployDemoApplication -Deployed Ignore)) {
>> If ($revision.RevisionType -Eq "S3") {
>> Write-Output ("Type = S3, Bucket = " + $revision.S3Location.Bucket + ", BundleType = " + $revision.S3Location.BundleType + ", ETag = " + $revision.S3Location.ETag + ", Key = " + $revision.S3Location.Key)
>> }
>> If ($revision.RevisionType -Eq "GitHub") {
>> Write-Output ("Type = GitHub, CommitId = " + $revision.GitHubLocation.CommitId + ", Repository = " + $revision.GitHubLocation.Repository)
>> }
>> }
>>
```
**Output:**
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ For API details, see [ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about available revisions for the specified application.**
```
ForEach ($revision in (Get-CDApplicationRevisionList -ApplicationName CodeDeployDemoApplication -Deployed Ignore)) {
>> If ($revision.RevisionType -Eq "S3") {
>> Write-Output ("Type = S3, Bucket = " + $revision.S3Location.Bucket + ", BundleType = " + $revision.S3Location.BundleType + ", ETag = " + $revision.S3Location.ETag + ", Key = " + $revision.S3Location.Key)
>> }
>> If ($revision.RevisionType -Eq "GitHub") {
>> Write-Output ("Type = GitHub, CommitId = " + $revision.GitHubLocation.CommitId + ", Repository = " + $revision.GitHubLocation.Repository)
>> }
>> }
>>
```
**Output:**
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ For API details, see [ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListApplications` with a CLI
The following code examples show how to use `ListApplications`.
------
#### [ CLI ]
**AWS CLI**
**To get information about applications**
The following `list-applications` example displays information about all applications that are associated with the user's AWS account.
```
aws deploy list-applications
```
Output:
```
{
"applications": [
"WordPress_App",
"MyOther_App"
]
}
```
+ For API details, see [ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-applications.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of available applications.**
```
Get-CDApplicationList
```
**Output:**
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ For API details, see [ListApplications](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of available applications.**
```
Get-CDApplicationList
```
**Output:**
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ For API details, see [ListApplications](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListDeploymentConfigs` with a CLI
The following code examples show how to use `ListDeploymentConfigs`.
------
#### [ CLI ]
**AWS CLI**
**To get information about deployment configurations**
The following `list-deployment-configs` example displays information about all deployment configurations that are associated with the user's AWS account.
```
aws deploy list-deployment-configs
```
Output:
```
{
"deploymentConfigsList": [
"ThreeQuartersHealthy",
"CodeDeployDefault.AllAtOnce",
"CodeDeployDefault.HalfAtATime",
"CodeDeployDefault.OneAtATime"
]
}
```
+ For API details, see [ListDeploymentConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-configs.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of available deployment configurations.**
```
Get-CDDeploymentConfigList
```
**Output:**
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ For API details, see [ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of available deployment configurations.**
```
Get-CDDeploymentConfigList
```
**Output:**
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ For API details, see [ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListDeploymentGroups` with a CLI
The following code examples show how to use `ListDeploymentGroups`.
------
#### [ CLI ]
**AWS CLI**
**To get information about deployment groups**
The following `list-deployment-groups` example displays information about all deployment groups that are associated with the specified application.
```
aws deploy list-deployment-groups --application-name WordPress_App
```
Output:
```
{
"applicationName": "WordPress_App",
"deploymentGroups": [
"WordPress_DG",
"WordPress_Beta_DG"
]
}
```
+ For API details, see [ListDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-groups.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of deployment groups for the specified application.**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**Output:**
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ For API details, see [ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of deployment groups for the specified application.**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**Output:**
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ For API details, see [ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListDeploymentInstances` with a CLI
The following code examples show how to use `ListDeploymentInstances`.
------
#### [ CLI ]
**AWS CLI**
**To get information about deployment instances**
The following `list-deployment-instances` example displays information about all deployment instances that are associated with the specified deployment.
```
aws deploy list-deployment-instances \
--deployment-id d-A1B2C3111 \
--instance-status-filter Succeeded
```
Output:
```
{
"instancesList": [
"i-EXAMPLE11",
"i-EXAMPLE22"
]
}
```
+ For API details, see [ListDeploymentInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of instance IDs for the specified deployment.**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**Output:**
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ For API details, see [ListDeploymentInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of instance IDs for the specified deployment.**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**Output:**
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ For API details, see [ListDeploymentInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListDeployments` with a CLI
The following code examples show how to use `ListDeployments`.
------
#### [ CLI ]
**AWS CLI**
**To get information about deployments**
The following `list-deployments` example displays information about all deployments that are associated with the specified application and deployment group.
```
aws deploy list-deployments \
--application-name WordPress_App \
--create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 \
--deployment-group-name WordPress_DG \
--include-only-statuses Failed
```
Output:
```
{
"deployments": [
"d-EXAMPLE11",
"d-EXAMPLE22",
"d-EXAMPLE33"
]
}
```
+ For API details, see [ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployments.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of deployment IDs for the specified application and deployment group.**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Output:**
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ For API details, see [ListDeployments](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of deployment IDs for the specified application and deployment group.**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Output:**
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ For API details, see [ListDeployments](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListOnPremisesInstances` with a CLI
The following code examples show how to use `ListOnPremisesInstances`.
------
#### [ CLI ]
**AWS CLI**
**To get information about one or more on-premises instances**
The following `list-on-premises-instances` example retrieves a list of available on-premises instance names for instances that are registered in AWS CodeDeploy and also have the specified on-premises instance tag associated in AWS CodeDeploy with the instance.
```
aws deploy list-on-premises-instances \
--registration-status Registered \
--tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE
```
Output:
```
{
"instanceNames": [
"AssetTag12010298EX"
]
}
```
+ For API details, see [ListOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-on-premises-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of available on-premises instance names.**
```
Get-CDOnPremiseInstanceList
```
**Output:**
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ For API details, see [ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of available on-premises instance names.**
```
Get-CDOnPremiseInstanceList
```
**Output:**
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ For API details, see [ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `RegisterApplicationRevision` with a CLI
The following code examples show how to use `RegisterApplicationRevision`.
------
#### [ CLI ]
**AWS CLI**
**To register information about an already-uploaded application revision**
The following `register-application-revision` example registers information about an already-uploaded application revision stored in Amazon S3 with AWS CodeDeploy.
```
aws deploy register-application-revision \
--application-name WordPress_App \
--description "Revised WordPress application" \
--s3-location bucket=amzn-s3-demo-bucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE
```
This command produces no output.
+ For API details, see [RegisterApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-application-revision.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example registers an application revision with the specified Amazon S3 location, for the specified application.**
```
Register-CDApplicationRevision -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -S3Location_Key aws-codedeploy_linux-master.zip -Revision_RevisionType S3
```
+ For API details, see [RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example registers an application revision with the specified Amazon S3 location, for the specified application.**
```
Register-CDApplicationRevision -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -S3Location_Key aws-codedeploy_linux-master.zip -Revision_RevisionType S3
```
+ For API details, see [RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `RegisterOnPremisesInstance` with a CLI
The following code examples show how to use `RegisterOnPremisesInstance`.
------
#### [ CLI ]
**AWS CLI**
**To register an on-premises instance**
The following `register-on-premises-instance` example registers an on-premises instance with AWS CodeDeploy. It does not create the specified IAM user, nor does it associate in AWS CodeDeploy any on-premises instances tags with the registered instance.
```
aws deploy register-on-premises-instance \
--instance-name AssetTag12010298EX \
--iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem
```
This command produces no output.
+ For API details, see [RegisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-on-premises-instance.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example registers an on-premises instance with the specified name and IAM user.**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ For API details, see [RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example registers an on-premises instance with the specified name and IAM user.**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ For API details, see [RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `RemoveTagsFromOnPremisesInstances` with a CLI
The following code examples show how to use `RemoveTagsFromOnPremisesInstances`.
------
#### [ CLI ]
**AWS CLI**
**To remove tags from one or more on-premises instances**
The following `remove-tags-from-on-premises-instances` example disassociates the specified on-premises tags in AWS CodeDeploy from on-premises instances. It does not deregister the on-premises instances in AWS CodeDeploy, nor uninstall the AWS CodeDeploy Agent from the instance, nor remove the on-premises configuration file from the instances, nor delete the IAM users that are associated with the instances.
```
aws deploy remove-tags-from-on-premises-instances \
--instance-names AssetTag12010298EX AssetTag23121309EX \
--tags Key=Name,Value=CodeDeployDemo-OnPrem
```
This command produces no output.
+ For API details, see [RemoveTagsFromOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/remove-tags-from-on-premises-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified tag for the on-premises instance with the specified name. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the tag without a prompt.**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ For API details, see [RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified tag for the on-premises instance with the specified name. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the tag without a prompt.**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ For API details, see [RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `StopDeployment` with a CLI
The following code examples show how to use `StopDeployment`.
------
#### [ CLI ]
**AWS CLI**
**To attempt to stop a deployment**
The following `stop-deployment` example attempts to stop an in-progress deployment that is associated with the user's AWS account.
aws deploy stop-deployment --deployment-id d-A1B2C3111
Output:
```
{
"status": "Succeeded",
"statusMessage": "No more commands will be scheduled for execution in the deployment instances"
}
```
+ For API details, see [StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/stop-deployment.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example attempts to stop the deployment with the specified deployment ID.**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**Output:**
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ For API details, see [StopDeployment](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example attempts to stop the deployment with the specified deployment ID.**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**Output:**
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ For API details, see [StopDeployment](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateApplication` with a CLI
The following code examples show how to use `UpdateApplication`.
------
#### [ CLI ]
**AWS CLI**
**To change details of an application**
The following `update-application` example changes the name of an application that is associated with the user's AWS account.
```
aws deploy update-application \
--application-name WordPress_App \
--new-application-name My_WordPress_App
```
This command produces no output.
+ For API details, see [UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-application.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example changes the name of the specified application.**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ For API details, see [UpdateApplication](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example changes the name of the specified application.**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ For API details, see [UpdateApplication](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateDeploymentGroup` with a CLI
The following code examples show how to use `UpdateDeploymentGroup`.
------
#### [ CLI ]
**AWS CLI**
**To change information about a deployment group**
The following `update-deployment-group` example changes the settings of a deployment group that is associated with the specified application.
```
aws deploy update-deployment-group \
--application-name WordPress_App \
--auto-scaling-groups My_CodeDeployDemo_ASG \
--current-deployment-group-name WordPress_DG \
--deployment-config-name CodeDeployDefault.AllAtOnce \
--ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo \
--new-deployment-group-name My_WordPress_DepGroup \
--service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2
```
This command produces no output.
+ For API details, see [UpdateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-deployment-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example changes the name of the specified deployment group for the specified application.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**Example 2: This example shows how to specify groups of 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.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
+ For API details, see [UpdateDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example changes the name of the specified deployment group for the specified application.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**Example 2: This example shows how to specify groups of 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.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
+ For API details, see [UpdateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------