# AWS CLI を使用した CodeDeploy の例
次のコード例は、CodeDeploy で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `add-tags-to-on-premises-instances`
次のコード例は、`add-tags-to-on-premises-instances` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスにタグを追加するには**
次の `add-tags-to-on-premises-instances` の例では、AWS CodeDeploy で同じオンプレミスインスタンスタグを 2 つのオンプレミスインスタンスに関連付けています。オンプレミスインスタンスは、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)」を参照してください。
### `batch-get-application-revisions`
次のコード例は、`batch-get-application-revisions` を使用する方法を示しています。
**AWS CLI**
**アプリケーションリビジョンに関する情報を取得するには**
次の `batch-get-application-revisions` の例では、GitHub リポジトリに保存されている指定されたリビジョンに関する情報を取得しています。
```
aws deploy batch-get-application-revisions \
--application-name my-codedeploy-application \
--revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]"
```
出力:
```
{
"revisions": [
{
"genericRevisionInfo": {
"description": "Application revision registered by Deployment ID: d-A1B2C3111",
"lastUsedTime": 1556912355.884,
"registerTime": 1556912355.884,
"firstUsedTime": 1556912355.884,
"deploymentGroups": []
},
"revisionLocation": {
"revisionType": "GitHub",
"gitHubLocation": {
"commitId": "fa85936EXAMPLEa31736c051f10d77297EXAMPLE",
"repository": "my-github-token/my-repository"
}
}
}
],
"applicationName": "my-codedeploy-application",
"errorMessage": ""
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[BatchGetApplicationRevisions](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetApplicationRevisions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-application-revisions.html)」を参照してください。
### `batch-get-applications`
次のコード例は、`batch-get-applications` を使用する方法を示しています。
**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)」を参照してください。
### `batch-get-deployment-groups`
次のコード例は、`batch-get-deployment-groups` を使用する方法を示しています。
**AWS CLI**
**1 つまたは複数のデプロイグループに関する情報を取得するには**
次の `batch-get-deployment-groups` の例では、指定された CodeDeploy アプリケーションに関連付けられている 2 つのデプロイグループに関する情報を取得しています。
```
aws deploy batch-get-deployment-groups \
--application-name my-codedeploy-application \
--deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]"
```
出力:
```
{
"deploymentGroupsInfo": [
{
"deploymentStyle": {
"deploymentOption": "WITHOUT_TRAFFIC_CONTROL",
"deploymentType": "IN_PLACE"
},
"autoRollbackConfiguration": {
"enabled": false
},
"onPremisesTagSet": {
"onPremisesTagSetList": []
},
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole",
"lastAttemptedDeployment": {
"endTime": 1556912366.415,
"status": "Failed",
"createTime": 1556912355.884,
"deploymentId": "d-A1B2C3111"
},
"autoScalingGroups": [],
"deploymentGroupName": "my-deployment-group-1",
"ec2TagSet": {
"ec2TagSetList": [
[
{
"Type": "KEY_AND_VALUE",
"Value": "my-EC2-instance",
"Key": "Name"
}
]
]
},
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example",
"triggerConfigurations": [],
"applicationName": "my-codedeploy-application",
"computePlatform": "Server",
"deploymentConfigName": "CodeDeployDefault.AllAtOnce"
},
{
"deploymentStyle": {
"deploymentOption": "WITHOUT_TRAFFIC_CONTROL",
"deploymentType": "IN_PLACE"
},
"autoRollbackConfiguration": {
"enabled": false
},
"onPremisesTagSet": {
"onPremisesTagSetList": []
},
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole",
"autoScalingGroups": [],
"deploymentGroupName": "my-deployment-group-2",
"ec2TagSet": {
"ec2TagSetList": [
[
{
"Type": "KEY_AND_VALUE",
"Value": "my-EC2-instance",
"Key": "Name"
}
]
]
},
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example",
"triggerConfigurations": [],
"applicationName": "my-codedeploy-application",
"computePlatform": "Server",
"deploymentConfigName": "CodeDeployDefault.AllAtOnce"
}
],
"errorMessage": ""
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[BatchGetDeploymentGroups](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentGroups.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-groups.html)」を参照してください。
### `batch-get-deployment-targets`
次のコード例は、`batch-get-deployment-targets` を使用する方法を示しています。
**AWS CLI**
**デプロイに関連付けられているターゲットを取得するには**
次の `batch-get-deployment-targets` の例では、指定されたデプロイに関連付けられたターゲットの 1 つに関する情報を返しています。
```
aws deploy batch-get-deployment-targets \
--deployment-id "d-1A2B3C4D5" \
--target-ids "i-01a2b3c4d5e6f1111"
```
出力:
```
{
"deploymentTargets": [
{
"deploymentTargetType": "InstanceTarget",
"instanceTarget": {
"lifecycleEvents": [
{
"startTime": 1556918592.162,
"lifecycleEventName": "ApplicationStop",
"status": "Succeeded",
"endTime": 1556918592.247,
"diagnostics": {
"scriptName": "",
"errorCode": "Success",
"logTail": "",
"message": "Succeeded"
}
},
{
"startTime": 1556918593.193,
"lifecycleEventName": "DownloadBundle",
"status": "Succeeded",
"endTime": 1556918593.981,
"diagnostics": {
"scriptName": "",
"errorCode": "Success",
"logTail": "",
"message": "Succeeded"
}
},
{
"startTime": 1556918594.805,
"lifecycleEventName": "BeforeInstall",
"status": "Succeeded",
"endTime": 1556918681.807,
"diagnostics": {
"scriptName": "",
"errorCode": "Success",
"logTail": "",
"message": "Succeeded"
}
}
],
"targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111",
"deploymentId": "d-1A2B3C4D5",
"lastUpdatedAt": 1556918687.504,
"targetId": "i-01a2b3c4d5e6f1111",
"status": "Succeeded"
}
}
]
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[BatchGetDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentTargets.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-targets.html)」を参照してください。
### `batch-get-deployments`
次のコード例は、`batch-get-deployments` を使用する方法を示しています。
**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)」を参照してください。
### `batch-get-on-premises-instances`
次のコード例は、`batch-get-on-premises-instances` を使用する方法を示しています。
**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)」を参照してください。
### `continue-deployment`
次のコード例は、`continue-deployment` を使用する方法を示しています。
**AWS CLI**
**指定された待機時間が経過するのを待たずにトラフィックの再ルーティングを開始するには。**
次の `continue-deployment` の例では、置き換え先環境のインスタンスへトラフィックを移行する準備ができている元の環境のインスタンスからのトラフィックの再ルーティングを開始します。
```
aws deploy continue-deployment \
--deployment-id "d-A1B2C3111" \
--deployment-wait-type "READY_WAIT"
```
このコマンドでは何も出力されません。
詳細については、「*AWS CodeDeploy API リファレンス*」の「[ContinueDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ContinueDeployment.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ContinueDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/continue-deployment.html)」を参照してください。
### `create-application`
次のコード例は、`create-application` を使用する方法を示しています。
**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)」を参照してください。
### `create-deployment-config`
次のコード例は、`create-deployment-config` を使用する方法を示しています。
**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)」を参照してください。
### `create-deployment-group`
次のコード例は、`create-deployment-group` を使用する方法を示しています。
**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)」を参照してください。
### `create-deployment`
次のコード例は、`create-deployment` を使用する方法を示しています。
**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)」を参照してください。**
### `delete-application`
次のコード例は、`delete-application` を使用する方法を示しています。
**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)」を参照してください。
### `delete-deployment-config`
次のコード例は、`delete-deployment-config` を使用する方法を示しています。
**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)」を参照してください。
### `delete-deployment-group`
次のコード例は、`delete-deployment-group` を使用する方法を示しています。
**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)」を参照してください。
### `delete-git-hub-account-token`
次のコード例は、`delete-git-hub-account-token` を使用する方法を示しています。
**AWS CLI**
**GitHub アカウント接続を削除するには**
次の `delete-git-hub-account-token` の例では、指定された GitHub アカウントの接続を削除しています。
```
aws deploy delete-git-hub-account-token --token-name my-github-account
```
出力:
```
{
"tokenName": "my-github-account"
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[DeleteGitHubAccountToken](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_DeleteGitHubAccountToken.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGitHubAccountToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-git-hub-account-token.html)」を参照してください。
### `deregister-on-premises-instance`
次のコード例は、`deregister-on-premises-instance` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスの登録を解除するには**
次の `deregister-on-premises-instance` の例では、AWS CodeDeploy へのオンプレミスインスタンスの登録を解除していますが、インスタンスに関連付けられた IAM ユーザーを削除したり、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)」を参照してください。
### `deregister`
次のコード例は、`deregister` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスの登録を解除するには**
次の `deregister` の例では、AWS CodeDeploy へのオンプレミスインスタンスの登録を解除しています。インスタンスに関連付けられた IAM ユーザーは削除されません。AWS CodeDeploy でオンプレミスタグとインスタンスとの関連付けを解除します。AWS CodeDeploy エージェントをインスタンスからアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したりすることはありません。
```
aws deploy deregister \
--instance-name AssetTag12010298EX \
--no-delete-iam-user \
--region us-west-2
```
出力:
```
Retrieving on-premises instance information... DONE
IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX
Tags: Key=Name,Value=CodeDeployDemo-OnPrem
Removing tags from the on-premises instance... DONE
Deregistering the on-premises instance... DONE
Run the following command on the on-premises instance to uninstall the codedeploy-agent:
aws deploy uninstall
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Deregister](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister.html)」を参照してください。
### `get-application-revision`
次のコード例は、`get-application-revision` を使用する方法を示しています。
**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)」を参照してください。
### `get-application`
次のコード例は、`get-application` を使用する方法を示しています。
**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)」を参照してください。
### `get-deployment-config`
次のコード例は、`get-deployment-config` を使用する方法を示しています。
**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)」を参照してください。
### `get-deployment-group`
次のコード例は、`get-deployment-group` を使用する方法を示しています。
**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)」を参照してください。
### `get-deployment-instance`
次のコード例は、`get-deployment-instance` を使用する方法を示しています。
**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)」を参照してください。
### `get-deployment-target`
次のコード例は、`get-deployment-target` を使用する方法を示しています。
**AWS CLI**
**デプロイターゲットに関する情報を返すには**
次の `get-deployment-target` の例では、指定されたデプロイに関連付けられているデプロイターゲットに関する情報を返しています。
```
aws deploy get-deployment-target \
--deployment-id "d-A1B2C3111" \
--target-id "i-a1b2c3d4e5f611111"
```
出力:
```
{
"deploymentTarget": {
"deploymentTargetType": "InstanceTarget",
"instanceTarget": {
"lastUpdatedAt": 1556918687.504,
"targetId": "i-a1b2c3d4e5f611111",
"targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-a1b2c3d4e5f611111",
"status": "Succeeded",
"lifecycleEvents": [
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "ApplicationStop",
"startTime": 1556918592.162,
"endTime": 1556918592.247
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "DownloadBundle",
"startTime": 1556918593.193,
"endTime": 1556918593.981
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "BeforeInstall",
"startTime": 1556918594.805,
"endTime": 1556918681.807
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "Install",
"startTime": 1556918682.696,
"endTime": 1556918683.005
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "AfterInstall",
"startTime": 1556918684.135,
"endTime": 1556918684.216
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "ApplicationStart",
"startTime": 1556918685.211,
"endTime": 1556918685.295
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "ValidateService",
"startTime": 1556918686.65,
"endTime": 1556918686.747
}
],
"deploymentId": "d-A1B2C3111"
}
}
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[GetDeploymentTarget](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetDeploymentTarget.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-target.html)」を参照してください。
### `get-deployment`
次のコード例は、`get-deployment` を使用する方法を示しています。
**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)」を参照してください。
### `get-on-premises-instance`
次のコード例は、`get-on-premises-instance` を使用する方法を示しています。
**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)」を参照してください。
### `install`
次のコード例は、`install` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスをインストールするには**
次の `install` の例では、オンプレミスの設定ファイルを、インスタンスの指定された場所から AWS CodeDeploy エージェントが見つけやすいインスタンスの場所へコピーしています。また、インスタンスに AWS CodeDeploy エージェントもインストールします。IAM ユーザーを作成したり、オンプレミスインスタンスを AWS CodeDeploy に登録したり、インスタンスの AWS CodeDeploy にオンプレミスインスタンスタグを関連付けたりすることはありません。
```
aws deploy install \
--override-config \
--config-file C:\temp\codedeploy.onpremises.yml \
--region us-west-2 \
--agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi
```
出力:
```
Creating the on-premises instance configuration file... DONE
Installing the AWS CodeDeploy Agent... DONE
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Install](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/install.html)」を参照してください。
### `list-application-revisions`
次のコード例は、`list-application-revisions` を使用する方法を示しています。
**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)」を参照してください。
### `list-applications`
次のコード例は、`list-applications` を使用する方法を示しています。
**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)」を参照してください。
### `list-deployment-configs`
次のコード例は、`list-deployment-configs` を使用する方法を示しています。
**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)」を参照してください。
### `list-deployment-groups`
次のコード例は、`list-deployment-groups` を使用する方法を示しています。
**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)」を参照してください。
### `list-deployment-instances`
次のコード例は、`list-deployment-instances` を使用する方法を示しています。
**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)」を参照してください。
### `list-deployment-targets`
次のコード例は、`list-deployment-targets` を使用する方法を示しています。
**AWS CLI**
**デプロイに関連付けられているターゲット ID のリストを取得するには**
次の `list-deployment-targets` の例では、「Failed」または「InProgress」のステータスを持つデプロイに関連付けられたターゲット ID のリストを取得しています。
```
aws deploy list-deployment-targets \
--deployment-id "d-A1B2C3111" \
--target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}"
```
出力:
```
{
"targetIds": [
"i-0f1558aaf90e5f1f9"
]
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[ListDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListDeploymentTargets.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-targets.html)」を参照してください。
### `list-deployments`
次のコード例は、`list-deployments` を使用する方法を示しています。
**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)」を参照してください。
### `list-git-hub-account-token-names`
次のコード例は、`list-git-hub-account-token-names` を使用する方法を示しています。
**AWS CLI**
**GitHub アカウントへの保存された接続の名前を一覧表示するには**
次の `list-git-hub-account-token-names` の例では、現在の AWS ユーザーの GitHub アカウントへの保存された接続の名前を一覧表示しています。
```
aws deploy list-git-hub-account-token-names
```
出力:
```
{
"tokenNameList": [
"my-first-token",
"my-second-token",
"my-third-token"
]
}
```
詳細については、「*AWS CodeDeploy API リファレンス*」の「[ListGitHubAccountTokenNames](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListGitHubAccountTokenNames.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGitHubAccountTokenNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-git-hub-account-token-names.html)」を参照してください。
### `list-on-premises-instances`
次のコード例は、`list-on-premises-instances` を使用する方法を示しています。
**AWS CLI**
**1 つまたは複数のオンプレミスインスタンスに関する情報を取得するには**
次の `list-on-premises-instances` の例では、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)」を参照してください。
### `list-tags-for-resource`
次のコード例は、`list-tags-for-resource` を使用する方法を示しています。
**AWS CLI**
**リソースのタグを一覧表示するには (アプリケーション)**
次の `list-tags-for-resource` の例では、CodeDeploy の testApp という名前のアプリケーションに適用されるタグを一覧表示しています。
```
aws deploy list-tags-for-resource \
--resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp
```
出力:
```
{
"Tags": [
{
"Key": "Type",
"Value": "testType"
},
{
"Key": "Name",
"Value": "testName"
}
]
}
```
詳細については、「*AWS CodeDeploy ユーザーガイド*」の「[Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-tags-for-resource.html)」を参照してください。
### `push`
次のコード例は、`push` を使用する方法を示しています。
**AWS CLI**
**AWS CodeDeploy 互換のアプリケーションリビジョンをバンドルして Amazon S3 にデプロイするには**
次の `push` の例では、アプリケーションリビジョンをバンドルして Amazon S3 にデプロイし、アプリケーションリビジョンを指定されたアプリケーションに関連付けています。
```
aws deploy push \
--application-name WordPress_App \
--description "This is my deployment" \
--ignore-hidden-files \
--s3-location s3://amzn-s3-demo-bucket/WordPressApp.zip \
--source /tmp/MyLocalDeploymentFolder/
```
出力では、`create-deployment` コマンドを使用して、アップロードされたアプリケーションリビジョンを使用するデプロイを作成する方法について説明しています。
```
To deploy with this revision, run:
aws deploy create-deployment --application-name WordPress_App --deployment-config-name --deployment-group-name --s3-location bucket=amzn-s3-demo-bucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Push](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/push.html)」を参照してください。
### `register-application-revision`
次のコード例は、`register-application-revision` を使用する方法を示しています。
**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)」を参照してください。
### `register-on-premises-instance`
次のコード例は、`register-on-premises-instance` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスを登録するには**
次の `register-on-premises-instance` の例では、オンプレミスインスタンスを AWS CodeDeploy に登録しています。指定された IAM ユーザーを作成したり、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)」を参照してください。
### `register`
次のコード例は、`register` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスを登録するには**
次の `register` の例では、オンプレミスインスタンスを AWS CodeDeploy に登録し、AWS CodeDeploy で指定されたオンプレミスインスタンスタグを登録されたインスタンスに関連付け、インスタンスにコピーできるオンプレミス設定ファイルを作成しています。IAM ユーザーを作成したり、インスタンスに AWS CodeDeploy エージェントをインストールしたりすることはありません。
```
aws deploy register \
--instance-name AssetTag12010298EX \
--iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem \
--tags Key=Name,Value=CodeDeployDemo-OnPrem \
--region us-west-2
```
出力:
```
Registering the on-premises instance... DONE
Adding tags to the on-premises instance... DONE
Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent:
aws deploy install --config-file codedeploy.onpremises.yml
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Register](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register.html)」を参照してください。
### `remove-tags-from-on-premises-instances`
次のコード例は、`remove-tags-from-on-premises-instances` を使用する方法を示しています。
**AWS CLI**
**1 つまたは複数のオンプレミスインスタンスからタグを削除するには**
次の `remove-tags-from-on-premises-instances` の例では、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)」を参照してください。
### `stop-deployment`
次のコード例は、`stop-deployment` を使用する方法を示しています。
**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)」を参照してください。
### `tag-resource`
次の例は、`tag-resource` を使用する方法を説明しています。
**AWS CLI**
**リソースにタグを付けるには (アプリケーション)**
次の `tag-resource` の例では、CodeDeploy の testApp という名前のアプリケーションに、キー Name と Type、値 testName と testType を持つ 2 つのタグを追加しています。
```
aws deploy tag-resource \
--resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \
--tags Key=Name,Value=testName Key=Type,Value=testType
```
このコマンドが成功した場合、出力は生成されません。
詳細については、「*AWS CodeDeploy ユーザーガイド*」の「[Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/tag-resource.html)」を参照してください。
### `uninstall`
次のコード例は、`uninstall` を使用する方法を示しています。
**AWS CLI**
**オンプレミスインスタンスをアンインストールするには**
次の `uninstall` の例では、オンプレミスインスタンスから AWS CodeDeploy エージェントをアンインストールし、インスタンスからオンプレミス設定ファイルを削除しています。AWS CodeDeploy のインスタンスの登録を解除したり、AWS CodeDeploy のオンプレミスインスタンスタグとインスタンスとの関連付けを解除したり、インスタンスに関連付けられている IAM ユーザーを削除したりすることはありません。
```
aws deploy uninstall
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Uninstall](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/uninstall.html)」を参照してください。
### `untag-resource`
次のコード例は、`untag-resource` を使用する方法を示しています。
**AWS CLI**
**リソースからタグを削除するには (アプリケーション)**
次の `untag-resource` の例では、CodeDeploy の testApp という名前のアプリケーションから、キー Name と Type を持つ 2 つのタグを削除しています。
```
aws deploy untag-resource \
--resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \
--tag-keys Name Type
```
このコマンドが成功した場合、出力は生成されません。
詳細については、「*AWS CodeDeploy ユーザーガイド*」の「[Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/untag-resource.html)」を参照してください。
### `update-application`
次のコード例は、`update-application` を使用する方法を示しています。
**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)」を参照してください。
### `update-deployment-group`
次のコード例は、`update-deployment-group` を使用する方法を示しています。
**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)」を参照してください。