Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# SDK を使用した CodeDeploy のアクション AWS SDKs
次のコード例は、 AWS SDKs を使用して個々の CodeDeploy アクションを実行する方法を示しています。それぞれの例には、GitHub へのリンクがあり、そこにはコードの設定と実行に関する説明が記載されています。
以下の例には、最も一般的に使用されるアクションのみ含まれています。詳細な一覧については、「[AWS CodeDeploy API リファレンス](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)
# CLI で `AddTagsToOnPremisesInstances` を使用する
次のサンプルコードは、`AddTagsToOnPremisesInstances` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**オンプレミスインスタンスにタグを追加するには**
次の`add-tags-to-on-premises-instances`例では、同じオンプレミスインスタンスタグを 2 つのオンプレミスインスタンスに in AWS CodeDeploy を関連付けます。オンプレミスインスタンスは AWS CodeDeploy に登録されません。
```
aws deploy add-tags-to-on-premises-instances \
--instance-names AssetTag12010298EX AssetTag23121309EX \
--tags Key=Name,Value=CodeDeployDemo-OnPrem
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTagsToOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/add-tags-to-on-premises-instances.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたオンプレミスインスタンスに指定されたキーと値を持つオンプレミスインスタンスタグを追加します。**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたオンプレミスインスタンスに指定されたキーと値を持つオンプレミスインスタンスタグを追加します。**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `BatchGetApplications` を使用する
次のサンプルコードは、`BatchGetApplications` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**複数のアプリケーションに関する情報を取得するには**
次の の`batch-get-applications`例では、ユーザーの AWS アカウントに関連付けられている複数のアプリケーションに関する情報を表示します。
```
aws deploy batch-get-applications --application-names WordPress_App MyOther_App
```
出力:
```
{
"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
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-applications.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションに関する情報を取得します。**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[BatchGetApplications](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに関する情報を取得します。**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[BatchGetApplications](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `BatchGetDeployments` を使用する
次のサンプルコードは、`BatchGetDeployments` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**複数のデプロイに関する情報を取得するには**
次の の`batch-get-deployments`例では、ユーザーの AWS アカウントに関連付けられている複数のデプロイに関する情報を表示します。
```
aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222
```
出力:
```
{
"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
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployments.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイに関する情報を取得します。**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[BatchGetDeployments](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイに関する情報を取得します。**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[BatchGetDeployments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `BatchGetOnPremisesInstances` を使用する
次のサンプルコードは、`BatchGetOnPremisesInstances` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**1 つまたは複数のオンプレミスインスタンスに関する情報を取得するには**
次の `batch-get-on-premises-instances` の例では、2 つのオンプレミスインスタンスに関する情報を取得しています。
```
aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX
```
出力:
```
{
"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"
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-on-premises-instances.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたオンプレミスインスタンスに関する情報を取得します。**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**出力:**
```
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}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたオンプレミスインスタンスに関する情報を取得します。**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**出力:**
```
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}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `CreateApplication` を使用する
次のサンプルコードは、`CreateApplication` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションを作成する方法**
次の`create-application`例では、アプリケーションを作成し、ユーザーの AWS アカウントに関連付けます。
```
aws deploy create-application --application-name MyOther_App
```
出力:
```
{
"applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-application.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定した名前で新しいアプリケーションを作成します。**
```
New-CDApplication -ApplicationName MyNewApplication
```
**出力:**
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[CreateApplication](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定した名前で新しいアプリケーションを作成します。**
```
New-CDApplication -ApplicationName MyNewApplication
```
**出力:**
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[CreateApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `CreateDeployment` を使用する
次のサンプルコードは、`CreateDeployment` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**例 1: EC2/オンプレミスコンピューティングプラットフォームを使用して CodeDeploy デプロイを作成するには**
次の の`create-deployment`例では、デプロイを作成し、ユーザーの AWS アカウントに関連付けます。
```
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
```
出力:
```
{
"deploymentId": "d-A1B2C3111"
}
```
**例 2: Amazon ECS コンピューティングプラットフォームを使用して CodeDeploy デプロイを作成するには**
次の `create-deployment` の例では、次の 2 つのファイルを使用して Amazon ECS サービスをデプロイしています。
`create-deployment.json` ファイルの内容。
```
{
"applicationName": "ecs-deployment",
"deploymentGroupName": "ecs-deployment-dg",
"revision": {
"revisionType": "S3",
"s3Location": {
"bucket": "ecs-deployment-bucket",
"key": "appspec.yaml",
"bundleType": "YAML"
}
}
}
```
このファイルは、次に `ecs-deployment-bucket` という S3 バケットから次のファイル `appspec.yaml` を取得しています。
```
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"
```
コマンド:
```
aws deploy create-deployment \
--cli-input-json file://create-deployment.json \
--region us-east-1
```
出力:
```
{
"deploymentId": "d-1234ABCDE"
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[CreateDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment.html)」を参照してください。**
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイ設定とアプリケーションリビジョンを使用して、指定されたアプリケーションとデプロイグループの新しいデプロイを作成します。**
```
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
```
**出力:**
```
d-ZHROG7UEX
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
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"})
```
**出力:**
```
d-ZHROG7UEX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[CreateDeployment](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイ設定とアプリケーションリビジョンを使用して、指定されたアプリケーションとデプロイグループの新しいデプロイを作成します。**
```
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
```
**出力:**
```
d-ZHROG7UEX
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
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"})
```
**出力:**
```
d-ZHROG7UEX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[CreateDeployment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `CreateDeploymentConfig` を使用する
次のサンプルコードは、`CreateDeploymentConfig` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**カスタムデプロイ設定を作成するには**
次の の`create-deployment-config`例では、カスタムデプロイ設定を作成し、ユーザーの AWS アカウントに関連付けます。
```
aws deploy create-deployment-config \
--deployment-config-name ThreeQuartersHealthy \
--minimum-healthy-hosts type=FLEET_PERCENT,value=75
```
出力:
```
{
"deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-config.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定された名前と動作で新しいデプロイ設定を作成します。**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**出力:**
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前と動作で新しいデプロイ設定を作成します。**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**出力:**
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `CreateDeploymentGroup` を使用する
次のサンプルコードは、`CreateDeploymentGroup` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイグループを作成するには**
次の の`create-deployment-group`例では、デプロイグループを作成し、指定されたアプリケーションとユーザーの AWS アカウントに関連付けます。
```
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
```
出力:
```
{
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-group.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションに対して指定された名前、Auto Scaling グループ、デプロイ設定、タグ、サービスロールを持つデプロイグループを作成します。**
```
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
```
**出力:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
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"})
```
**出力:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[CreateDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに対して指定された名前、Auto Scaling グループ、デプロイ設定、タグ、サービスロールを持つデプロイグループを作成します。**
```
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
```
**出力:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
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"})
```
**出力:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[CreateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DeleteApplication` を使用する
次のサンプルコードは、`DeleteApplication` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションを削除するには**
次の の`delete-application`例では、ユーザーの AWS アカウントに関連付けられている指定されたアプリケーションを削除します。
```
aws deploy delete-application --application-name WordPress_App
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-application.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定された名前のアプリケーションを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでアプリケーションを削除します。**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[DeleteApplication](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のアプリケーションを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでアプリケーションを削除します。**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[DeleteApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DeleteDeploymentConfig` を使用する
次のサンプルコードは、`DeleteDeploymentConfig` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイ設定を削除するには**
次の の`delete-deployment-config`例では、ユーザーの AWS アカウントに関連付けられているカスタムデプロイ設定を削除します。
```
aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-config.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定された名前のデプロイ設定を削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでデプロイ設定を削除します。**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のデプロイ設定を削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでデプロイ設定を削除します。**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DeleteDeploymentGroup` を使用する
次のサンプルコードは、`DeleteDeploymentGroup` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイグループを削除するには**
次の `delete-deployment-group` の例では、指定されたアプリケーションに関連付けられているデプロイグループを削除しています。
```
aws deploy delete-deployment-group \
--application-name WordPress_App \
--deployment-group-name WordPress_DG
```
出力:
```
{
"hooksNotCleanedUp": []
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-group.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションの指定された名前のデプロイグループを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでデプロイグループを削除します。**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションの指定された名前のデプロイグループを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでデプロイグループを削除します。**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DeregisterOnPremisesInstance` を使用する
次のサンプルコードは、`DeregisterOnPremisesInstance` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**オンプレミスインスタンスの登録を解除するには**
次の`deregister-on-premises-instance`例では、 AWS CodeDeploy を使用してオンプレミスインスタンスを登録解除しますが、インスタンスに関連付けられた IAM ユーザーを削除したり、インスタンスから in AWS CodeDeploy インスタンスタグの関連付けを解除したりすることはありません。また、 AWS CodeDeploy エージェントをインスタンスからアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したりしません。
```
aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister-on-premises-instance.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定された名前のオンプレミスインスタンスを登録解除します。**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のオンプレミスインスタンスを登録解除します。**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetApplication` を使用する
次のサンプルコードは、`GetApplication` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションに関する情報を取得するには**
次の の`get-application`例では、ユーザーの AWS アカウントに関連付けられているアプリケーションに関する情報を表示します。
```
aws deploy get-application --application-name WordPress_App
```
出力:
```
{
"application": {
"applicationName": "WordPress_App",
"applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"createTime": 1407878168.078,
"linkedToGitHub": false
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションに関する情報を取得します。**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**出力:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetApplication](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに関する情報を取得します。**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**出力:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetApplicationRevision` を使用する
次のサンプルコードは、`GetApplicationRevision` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションリビジョンに関する情報を取得するには**
次の `get-application-revision` の例では、指定されたアプリケーションに関連付けられているアプリケーションリビジョンに関する情報を表示しています。
```
aws deploy get-application-revision \
--application-name WordPress_App \
--s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
```
出力:
```
{
"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"
}
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application-revision.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションリビジョンに関する情報を取得します。**
```
$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)
```
**出力:**
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetApplicationRevision](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションリビジョンに関する情報を取得します。**
```
$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)
```
**出力:**
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetDeployment` を使用する
次のサンプルコードは、`GetDeployment` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイの情報を取得する方法**
次の の`get-deployment`例では、ユーザーの AWS アカウントに関連付けられているデプロイに関する情報を表示します。
```
aws deploy get-deployment --deployment-id d-A1B2C3123
```
出力:
```
{
"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
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイに関する概要情報を取得します。**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**出力:**
```
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
```
**例 2: この例では、指定されたデプロイに参加しているインスタンスのステータスに関する情報を取得します。**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**出力:**
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**例 3: この例では、指定されたデプロイのアプリケーションリビジョンに関する情報を取得します。**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**出力:**
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetDeployment](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイに関する概要情報を取得します。**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**出力:**
```
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
```
**例 2: この例では、指定されたデプロイに参加しているインスタンスのステータスに関する情報を取得します。**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**出力:**
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**例 3: この例では、指定されたデプロイのアプリケーションリビジョンに関する情報を取得します。**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**出力:**
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetDeployment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetDeploymentConfig` を使用する
次のサンプルコードは、`GetDeploymentConfig` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイ設定に関する情報を取得するには**
次の の`get-deployment-config`例では、ユーザーの AWS アカウントに関連付けられているデプロイ設定に関する情報を表示します。
```
aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy
```
出力:
```
{
"deploymentConfigInfo": {
"deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"minimumHealthyHosts": {
"type": "FLEET_PERCENT",
"value": 75
},
"createTime": 1411081164.379,
"deploymentConfigName": "ThreeQuartersHealthy"
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-config.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイ設定に関する概要情報を取得します。**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**出力:**
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**例 2: この例では、指定されたデプロイ設定の定義に関する情報を取得します。**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**出力:**
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイ設定に関する概要情報を取得します。**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**出力:**
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**例 2: この例では、指定されたデプロイ設定の定義に関する情報を取得します。**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**出力:**
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetDeploymentGroup` を使用する
次のサンプルコードは、`GetDeploymentGroup` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイグループに関する情報を表示するには**
次の `get-deployment-group` の例では、指定されたアプリケーションに関連付けられているデプロイグループに関する情報を表示しています。
```
aws deploy get-deployment-group \
--application-name WordPress_App \
--deployment-group-name WordPress_DG
```
出力:
```
{
"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"
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-group.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイグループに関する情報を取得します。**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイグループに関する情報を取得します。**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetDeploymentInstance` を使用する
次のサンプルコードは、`GetDeploymentInstance` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイインスタンスに関する情報を取得するには**
次の `get-deployment-instance` の例では、指定されたデプロイに関連付けられているデプロイインスタンスに関する情報を表示しています。
```
aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX
```
出力:
```
{
"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"
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-instance.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイの指定されたインスタンスに関する情報を取得します。**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイの指定されたインスタンスに関する情報を取得します。**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**出力:**
```
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
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetOnPremisesInstance` を使用する
次のサンプルコードは、`GetOnPremisesInstance` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**オンプレミスインスタンスに関する情報を取得するには**
次の `get-on-premises-instance` の例では、指定されたオンプレミスインスタンスに関する情報を取得しています。
```
aws deploy get-on-premises-instance --instance-name AssetTag12010298EX
```
出力:
```
{
"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"
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-on-premises-instance.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたオンプレミスインスタンスに関する情報を取得します。**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**出力:**
```
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}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたオンプレミスインスタンスに関する情報を取得します。**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**出力:**
```
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}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListApplicationRevisions` を使用する
次のサンプルコードは、`ListApplicationRevisions` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションリビジョンに関する情報を取得するには**
次の `list-application-revisions` の例では、指定されたアプリケーションに関連付けられているすべてのアプリケーションリビジョンに関する情報を表示しています。
```
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
```
出力:
```
{
"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"
}
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-application-revisions.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションで使用可能なリビジョンに関する情報を取得します。**
```
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)
>> }
>> }
>>
```
**出力:**
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションで使用可能なリビジョンに関する情報を取得します。**
```
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)
>> }
>> }
>>
```
**出力:**
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListApplications` を使用する
次のサンプルコードは、`ListApplications` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションに関する情報を取得するには**
次の の`list-applications`例では、ユーザーの AWS アカウントに関連付けられているすべてのアプリケーションに関する情報を表示します。
```
aws deploy list-applications
```
出力:
```
{
"applications": [
"WordPress_App",
"MyOther_App"
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-applications.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、使用可能なアプリケーションのリストを取得します。**
```
Get-CDApplicationList
```
**出力:**
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListApplications](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なアプリケーションのリストを取得します。**
```
Get-CDApplicationList
```
**出力:**
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListApplications](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListDeploymentConfigs` を使用する
次のサンプルコードは、`ListDeploymentConfigs` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイ設定に関する情報を取得するには**
次の の`list-deployment-configs`例では、ユーザーの AWS アカウントに関連付けられているすべてのデプロイ設定に関する情報を表示します。
```
aws deploy list-deployment-configs
```
出力:
```
{
"deploymentConfigsList": [
"ThreeQuartersHealthy",
"CodeDeployDefault.AllAtOnce",
"CodeDeployDefault.HalfAtATime",
"CodeDeployDefault.OneAtATime"
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-configs.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、使用可能なデプロイ設定のリストを取得します。**
```
Get-CDDeploymentConfigList
```
**出力:**
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なデプロイ設定のリストを取得します。**
```
Get-CDDeploymentConfigList
```
**出力:**
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListDeploymentGroups` を使用する
次のサンプルコードは、`ListDeploymentGroups` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイグループに関する情報を取得するには**
次の `list-deployment-groups` の例では、指定されたアプリケーションに関連付けられているすべてのデプロイグループに関する情報を表示しています。
```
aws deploy list-deployment-groups --application-name WordPress_App
```
出力:
```
{
"applicationName": "WordPress_App",
"deploymentGroups": [
"WordPress_DG",
"WordPress_Beta_DG"
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-groups.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションのデプロイグループのリストを取得します。**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**出力:**
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションのデプロイグループのリストを取得します。**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**出力:**
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListDeploymentInstances` を使用する
次のサンプルコードは、`ListDeploymentInstances` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイインスタンスに関する情報を取得するには**
次の `list-deployment-instances` の例では、指定されたデプロイに関連付けられているすべてのデプロイインスタンスに関する情報を表示しています。
```
aws deploy list-deployment-instances \
--deployment-id d-A1B2C3111 \
--instance-status-filter Succeeded
```
出力:
```
{
"instancesList": [
"i-EXAMPLE11",
"i-EXAMPLE22"
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-instances.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイのインスタンス ID のリストを取得します。**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**出力:**
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListDeploymentInstances](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイのインスタンス ID のリストを取得します。**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**出力:**
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListDeploymentInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListDeployments` を使用する
次のサンプルコードは、`ListDeployments` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイに関する情報を取得するには**
次の `list-deployments` の例では、指定されたアプリケーションとデプロイグループに関連付けられているすべてのデプロイに関する情報を表示しています。
```
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
```
出力:
```
{
"deployments": [
"d-EXAMPLE11",
"d-EXAMPLE22",
"d-EXAMPLE33"
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployments.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションとデプロイグループのデプロイ ID のリストを取得します。**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**出力:**
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListDeployments](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションとデプロイグループのデプロイ ID のリストを取得します。**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**出力:**
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListDeployments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListOnPremisesInstances` を使用する
次のサンプルコードは、`ListOnPremisesInstances` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**1 つまたは複数のオンプレミスインスタンスに関する情報を取得するには**
次の の`list-on-premises-instances`例では、in AWS CodeDeploy に登録され、インスタンス AWS CodeDeploy に関連付けられた指定されたオンプレミスインスタンスタグを持つインスタンスで使用可能なオンプレミスインスタンス名のリストを取得します。
```
aws deploy list-on-premises-instances \
--registration-status Registered \
--tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE
```
出力:
```
{
"instanceNames": [
"AssetTag12010298EX"
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-on-premises-instances.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、使用可能なオンプレミスインスタンス名のリストを取得します。**
```
Get-CDOnPremiseInstanceList
```
**出力:**
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なオンプレミスインスタンス名のリストを取得します。**
```
Get-CDOnPremiseInstanceList
```
**出力:**
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `RegisterApplicationRevision` を使用する
次のサンプルコードは、`RegisterApplicationRevision` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アップロード済みのアプリケーションリビジョンに関する情報を登録するには**
次の の`register-application-revision`例では、Amazon S3 に保存されているアップロード済みのアプリケーションリビジョンに関する情報を 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
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-application-revision.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションに対し、指定された Amazon S3 ロケーションでアプリケーションリビジョンを登録します。**
```
Register-CDApplicationRevision -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -S3Location_Key aws-codedeploy_linux-master.zip -Revision_RevisionType S3
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに対し、指定された Amazon S3 ロケーションでアプリケーションリビジョンを登録します。**
```
Register-CDApplicationRevision -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -S3Location_Key aws-codedeploy_linux-master.zip -Revision_RevisionType S3
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `RegisterOnPremisesInstance` を使用する
次のサンプルコードは、`RegisterOnPremisesInstance` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**オンプレミスインスタンスを登録するには**
次の の`register-on-premises-instance`例では、 AWS CodeDeploy にオンプレミスインスタンスを登録します。指定された IAM ユーザーを作成したり、in AWS CodeDeploy のオンプレミスインスタンスタグを登録済みインスタンスに関連付けたりすることはありません。
```
aws deploy register-on-premises-instance \
--instance-name AssetTag12010298EX \
--iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-on-premises-instance.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定された名前と IAM ユーザーでオンプレミスインスタンスを登録します。**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前と IAM ユーザーでオンプレミスインスタンスを登録します。**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `RemoveTagsFromOnPremisesInstances` を使用する
次のサンプルコードは、`RemoveTagsFromOnPremisesInstances` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**1 つまたは複数のオンプレミスインスタンスからタグを削除するには**
次の の`remove-tags-from-on-premises-instances`例では、指定されたオンプレミスタグ in AWS CodeDeploy とオンプレミスインスタンスの関連付けを解除します。 AWS CodeDeploy でオンプレミスインスタンスの登録を解除したり、インスタンスから AWS CodeDeploy エージェントをアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したり、インスタンスに関連付けられている IAM ユーザーを削除したりすることはありません。
```
aws deploy remove-tags-from-on-premises-instances \
--instance-names AssetTag12010298EX AssetTag23121309EX \
--tags Key=Name,Value=CodeDeployDemo-OnPrem
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/remove-tags-from-on-premises-instances.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定された名前のオンプレミスインスタンスの指定されたタグを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでタグを削除します。**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のオンプレミスインスタンスの指定されたタグを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでタグを削除します。**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `StopDeployment` を使用する
次のサンプルコードは、`StopDeployment` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイを停止するには**
次の`stop-deployment`例では、ユーザーの AWS アカウントに関連付けられている進行中のデプロイを停止しようとします。
aws deploy stop-deployment --deployment-id d-A1B2C3111
出力:
```
{
"status": "Succeeded",
"statusMessage": "No more commands will be scheduled for execution in the deployment instances"
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/stop-deployment.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたデプロイ ID を持つデプロイの停止を試みます。**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**出力:**
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の[StopDeployment](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイ ID を持つデプロイの停止を試みます。**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**出力:**
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の[StopDeployment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `UpdateApplication` を使用する
次のサンプルコードは、`UpdateApplication` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**アプリケーションの詳細を変更するには**
次の の`update-application`例では、ユーザーの AWS アカウントに関連付けられているアプリケーションの名前を変更します。
```
aws deploy update-application \
--application-name WordPress_App \
--new-application-name My_WordPress_App
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-application.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションの名前を変更します。**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[UpdateApplication](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションの名前を変更します。**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)*の「[UpdateApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `UpdateDeploymentGroup` を使用する
次のサンプルコードは、`UpdateDeploymentGroup` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**デプロイグループに関する情報を変更するには**
次の `update-deployment-group` の例では、指定されたアプリケーションに関連付けられているデプロイグループの設定を変更しています。
```
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
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-deployment-group.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたアプリケーションの指定されたデプロイグループの名前を変更します。**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
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"})
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[UpdateDeploymentGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションの指定されたデプロイグループの名前を変更します。**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
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"})
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------