Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS IoT Greengrass V2 を使用した の例 AWS CLI
次のコード例は、 AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS IoT Greengrass V2。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `associate-service-role-to-account`
次の例は、`associate-service-role-to-account` を使用する方法を説明しています。
**AWS CLI**
**Greengrass サービスロールを AWS アカウントに関連付けるには**
次の の`associate-service-role-to-account`例では、 AWS サービスロールをアカウントの AWS IoT Greengrass に関連付けます。
```
aws greengrassv2 associate-service-role-to-account \
--role-arn arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole
```
出力:
```
{
"associatedAt": "2022-01-19T19:21:53Z"
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateServiceRoleToAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/associate-service-role-to-account.html)」を参照してください。
### `batch-associate-client-device-with-core-device`
次のコード例は、`batch-associate-client-device-with-core-device` を使用する方法を示しています。
**AWS CLI**
**クライアントデバイスをコアデバイスと関連付けるには**
次の `batch-associate-client-device-with-core-device` の例では、2 つのクライアントデバイスを 1 つのコアデバイスに関連付けます。
```
aws greengrassv2 batch-associate-client-device-with-core-device \
--core-device-thing-name MyGreengrassCore \
--entries thingName=MyClientDevice1 thingName=MyClientDevice2
```
出力:
```
{
"errorEntries": []
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[ローカル IoT デバイスとやり取りする](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html)」参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchAssociateClientDeviceWithCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/batch-associate-client-device-with-core-device.html)」を参照してください。
### `batch-disassociate-client-device-from-core-device`
次のコード例は、`batch-disassociate-client-device-from-core-device` を使用する方法を示しています。
**AWS CLI**
**クライアントデバイスのコアデバイスとの関連付けを解除するには**
次の `batch-disassociate-client-device-from-core-device` の例では、2 つのクライアントデバイスをコアデバイスから関連付け解除します。
```
aws greengrassv2 batch-disassociate-client-device-from-core-device \
--core-device-thing-name MyGreengrassCore \
--entries thingName=MyClientDevice1 thingName=MyClientDevice2
```
出力:
```
{
"errorEntries": []
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[ローカル IoT デバイスとやり取りする](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html)」参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDisassociateClientDeviceFromCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/batch-disassociate-client-device-from-core-device.html)」を参照してください。
### `cancel-deployment`
次のコード例は、`cancel-deployment` を使用する方法を示しています。
**AWS CLI**
**デプロイをキャンセルするには**
次の `cancel-deployment` の例では、モノのグループへの継続的なデプロイを停止します。
```
aws greengrassv2 cancel-deployment \
--deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
出力:
```
{
"message": "SUCCESS"
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[デプロイをキャンセルする](https://docs.aws.amazon.com/greengrass/v2/developerguide/cancel-deployments.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス」*の「[CancelDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/cancel-deployment.html)」を参照してください。
### `create-component-version`
次のコード例は、`create-component-version` を使用する方法を示しています。
**AWS CLI**
**例 1: レシピからコンポーネントバージョンを作成するには**
次の `create-component-version` の例では、レシピファイルから Hello World コンポーネントのバージョンを作成します。
```
aws greengrassv2 create-component-version \
--inline-recipe fileb://com.example.HelloWorld-1.0.0.json
```
`com.example.HelloWorld-1.0.0.json` の内容:
```
{
"RecipeFormatVersion": "2020-01-25",
"ComponentName": "com.example.HelloWorld",
"ComponentVersion": "1.0.0",
"ComponentDescription": "My first AWS IoT Greengrass component.",
"ComponentPublisher": "Amazon",
"ComponentConfiguration": {
"DefaultConfiguration": {
"Message": "world"
}
},
"Manifests": [
{
"Platform": {
"os": "linux"
},
"Lifecycle": {
"Run": "echo 'Hello {configuration:/Message}'"
}
}
]
}
```
出力:
```
{
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0",
"componentName": "com.example.HelloWorld",
"componentVersion": "1.0.0",
"creationTimestamp": "2021-01-07T16:24:33.650000-08:00",
"status": {
"componentState": "REQUESTED",
"message": "NONE",
"errors": {}
}
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[カスタムコンポーネントを作成する](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-components.html)」および「[デプロイするコンポーネントをアップロードする](https://docs.aws.amazon.com/greengrass/v2/developerguide/upload-components.html)」を参照してください。
**例 2: AWS Lambda 関数からコンポーネントバージョンを作成するには**
次の`create-component-version`例では、 AWS Lambda 関数から Hello World コンポーネントのバージョンを作成します。
```
aws greengrassv2 create-component-version \
--cli-input-json file://lambda-function-component.json
```
`lambda-function-component.json` の内容:
```
{
"lambdaFunction": {
"lambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:HelloWorldPythonLambda:1",
"componentName": "com.example.HelloWorld",
"componentVersion": "1.0.0",
"componentLambdaParameters": {
"eventSources": [
{
"topic": "hello/world/+",
"type": "IOT_CORE"
}
]
}
}
}
```
出力:
```
{
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0",
"componentName": "com.example.HelloWorld",
"componentVersion": "1.0.0",
"creationTimestamp": "2021-01-07T17:05:27.347000-08:00",
"status": {
"componentState": "REQUESTED",
"message": "NONE",
"errors": {}
}
}
```
詳細については、*AWS 「 IoT Greengrass V2 デベロッパーガイド*」の[AWS 「Lambda 関数の実行](https://docs.aws.amazon.com/greengrass/v2/developerguide/run-lambda-functions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateComponentVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/create-component-version.html)」を参照してください。
### `create-deployment`
次のコード例は、`create-deployment` を使用する方法を示しています。
**AWS CLI**
**例 1: デプロイを作成するには**
次の の`create-deployment`例では、 AWS IoT Greengrass コマンドラインインターフェイスをコアデバイスにデプロイします。
```
aws greengrassv2 create-deployment \
--cli-input-json file://cli-deployment.json
```
`cli-deployment.json` の内容:
```
{
"targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore",
"deploymentName": "Deployment for MyGreengrassCore",
"components": {
"aws.greengrass.Cli": {
"componentVersion": "2.0.3"
}
},
"deploymentPolicies": {
"failureHandlingPolicy": "DO_NOTHING",
"componentUpdatePolicy": {
"timeoutInSeconds": 60,
"action": "NOTIFY_COMPONENTS"
},
"configurationValidationPolicy": {
"timeoutInSeconds": 60
}
},
"iotJobConfiguration": {}
}
```
出力:
```
{
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[デプロイを作成する](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html)」を参照してください。
**例 2: コンポーネント設定を更新するデプロイを作成するには**
次の`create-deployment`例では、 AWS IoT Greengrass nucleus コンポーネントをコアデバイスのグループにデプロイします。このデプロイでは、nucleus コンポーネントに対して以下の設定更新が適用されます。
ターゲットデバイスのプロキシ設定をデフォルトのプロキシなし設定にリセットします。ターゲットデバイスの MQTT 設定をデフォルトにリセットします。nucleus の JVM オプションを設定します。nucleus のログ記録レベルを設定します。
```
aws greengrassv2 create-deployment \
--cli-input-json file://nucleus-deployment.json
```
`nucleus-deployment.json` の内容:
```
{
"targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup",
"deploymentName": "Deployment for MyGreengrassCoreGroup",
"components": {
"aws.greengrass.Nucleus": {
"componentVersion": "2.0.3",
"configurationUpdate": {
"reset": [
"/networkProxy",
"/mqtt"
],
"merge": "{\"jvmOptions\":\"-Xmx64m\",\"logging\":{\"level\":\"WARN\"}}"
}
}
},
"deploymentPolicies": {
"failureHandlingPolicy": "ROLLBACK",
"componentUpdatePolicy": {
"timeoutInSeconds": 60,
"action": "NOTIFY_COMPONENTS"
},
"configurationValidationPolicy": {
"timeoutInSeconds": 60
}
},
"iotJobConfiguration": {}
}
```
出力:
```
{
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
```
詳細は、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[デプロイを作成する](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html)」と「[コンポーネント設定を更新する](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/create-deployment.html)」を参照してください。**
### `delete-component`
次のコード例は、`delete-component` を使用する方法を示しています。
**AWS CLI**
**コンポーネントバージョンを削除するには**
次の `delete-component` の例では、Hello World コンポーネントを削除します。
```
aws greengrassv2 delete-component \
--arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0
```
このコマンドでは何も出力されません。
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/delete-component.html)」を参照してください。
### `delete-core-device`
次のコード例は、`delete-core-device` を使用する方法を示しています。
**AWS CLI**
**コアデバイスを削除するには**
次の の`delete-core-device`例では、 AWS IoT Greengrass コアデバイスを削除します。
```
aws greengrassv2 delete-core-device \
--core-device-thing-name MyGreengrassCore
```
このコマンドでは何も出力されません。
詳細については、[AWS 「 IoT Greengrass V2 デベロッパーガイド」の「Uninstall theIoT Greengrass Core software](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#uninstall-greengrass-core-v2)」を参照してください。 *AWS IoT V2 *
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/delete-core-device.html)」を参照してください。
### `describe-component`
次のコード例は、`describe-component` を使用する方法を示しています。
**AWS CLI**
**コンポーネントバージョンを記述するには**
次の `describe-component` の例では、Hello World コンポーネントを記述します。
```
aws greengrassv2 describe-component \
--arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0
```
出力:
```
{
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0",
"componentName": "com.example.HelloWorld",
"componentVersion": "1.0.0",
"creationTimestamp": "2021-01-07T17:12:11.133000-08:00",
"publisher": "Amazon",
"description": "My first AWS IoT Greengrass component.",
"status": {
"componentState": "DEPLOYABLE",
"message": "NONE",
"errors": {}
},
"platforms": [
{
"attributes": {
"os": "linux"
}
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/describe-component.html)」を参照してください。
### `disassociate-service-role-from-account`
次の例は、`disassociate-service-role-from-account` を使用する方法を説明しています。
**AWS CLI**
** AWS アカウントから Greengrass サービスロールの関連付けを解除するには**
次の の`disassociate-service-role-from-account`例では、 AWS アカウントの Greengrass サービスロールと AWS IoT Greengrass の関連付けを解除します。
```
aws greengrassv2 disassociate-service-role-from-account
```
出力:
```
{
"disassociatedAt": "2022-01-19T19:26:09Z"
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateServiceRoleFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/disassociate-service-role-from-account.html)」を参照してください。
### `get-component-version-artifact`
次のコード例は、`get-component-version-artifact` を使用する方法を示しています。
**AWS CLI**
**コンポーネントアーティファクトをダウンロードする URL を取得するには**
次の `get-component-version-artifact` の例では、ローカルデバッグコンソールコンポーネントの JAR ファイルをダウンロードするための URL を取得します。
```
aws greengrassv2 get-component-version-artifact \
--arn arn:aws:greengrass:us-west-2:aws:components:aws.greengrass.LocalDebugConsole:versions:2.0.3 \
--artifact-name "Uvt6ZEzQ9TKiAuLbfXBX_APdY0TWks3uc46tHFHTzBM=/aws.greengrass.LocalDebugConsole.jar"
```
出力:
```
{
"preSignedUrl": "https://evergreencomponentmanageme-artifactbucket7410c9ef-g18n1iya8kwr.s3.us-west-2.amazonaws.com/public/aws.greengrass.LocalDebugConsole/2.0.3/s3/ggv2-component-releases-prod-pdx/EvergreenHttpDebugView/2ffc496ba41b39568968b22c582b4714a937193ee7687a45527238e696672521/aws.greengrass.LocalDebugConsole/aws.greengrass.LocalDebugConsole.jar?X-Amz-Security-Token=KwfLKSdEXAMPLE..."
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComponentVersionArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-component-version-artifact.html)」を参照してください。
### `get-component`
次のコード例は、`get-component` を使用する方法を示しています。
**AWS CLI**
**例 1: コンポーネントのレシピを YAML 形式でダウンロードするには (Linux、macOS または Unix)**
次の `get-component` の例では、Hello World コンポーネントのレシピを YAML 形式のファイルにダウンロードします。このコマンドは次のことを行います。
`--output` および `--query` パラメータを使用して、コマンドの出力を制御します。これらのパラメータは、コマンドの出力からレシピ BLOB を抽出します。詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[コマンド出力の制御](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html)」を参照してください。`base64` ユーティリティを使用します。このユーティリティは、抽出された BLOB を元のテキストにデコードします。成功した `get-component` コマンドによって返される BLOB は base64 でエンコードされたテキストです。元のテキストを取得するには、この BLOB をデコードする必要があります。デコードされたテキストを ファイルに保存します。コマンド (`> com.example.HelloWorld-1.0.0.json`) の最後のセクションでは、デコードされたテキストがファイルに保存されます。
```
aws greengrassv2 get-component \
--arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 \
--recipe-output-format YAML \
--query recipe \
--output text | base64 --decode > com.example.HelloWorld-1.0.0.json
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
**例 2: コンポーネントのレシピを YAML 形式でダウンロードするには (Windows CMD)**
次の `get-component` の例では、Hello World コンポーネントのレシピを YAML 形式のファイルにダウンロードします。このコマンドは `certutil` ユーティリティを使用します。
```
aws greengrassv2 get-component ^
--arn arn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0 ^
--recipe-output-format YAML ^
--query recipe ^
--output text > com.example.HelloWorld-1.0.0.yaml.b64
certutil -decode com.example.HelloWorld-1.0.0.yaml.b64 com.example.HelloWorld-1.0.0.yaml
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
**例 3: コンポーネントのレシピを YAML 形式でダウンロードするには (Windows PowerShell)**
次の `get-component` の例では、Hello World コンポーネントのレシピを YAML 形式のファイルにダウンロードします。このコマンドは `certutil` ユーティリティを使用します。
```
aws greengrassv2 get-component `
--arn arn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0 `
--recipe-output-format YAML `
--query recipe `
--output text > com.example.HelloWorld-1.0.0.yaml.b64
certutil -decode com.example.HelloWorld-1.0.0.yaml.b64 com.example.HelloWorld-1.0.0.yaml
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-component.html)」を参照してください。
### `get-connectivity-info`
次のコード例は、`get-connectivity-info` を使用する方法を示しています。
**AWS CLI**
**Greengrass コアデバイスの接続情報を取得するには**
次の `get-connectivity-info` の例では、Greengrass コアデバイスの接続情報を取得します。クライアントデバイスはこの情報を使用して、このコアデバイスで実行される MQTT ブローカーに接続します。
```
aws greengrassv2 get-connectivity-info \
--thing-name MyGreengrassCore
```
出力:
```
{
"connectivityInfo": [
{
"id": "localIP_192.0.2.0",
"hostAddress": "192.0.2.0",
"portNumber": 8883
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスエンドポイントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-core-device-endpoints.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-connectivity-info.html)」を参照してください。
### `get-core-device`
次のコード例は、`get-core-device` を使用する方法を示しています。
**AWS CLI**
**コアデバイスを取得するには**
次の の`get-core-device`例では、 AWS IoT Greengrass コアデバイスに関する情報を取得します。
```
aws greengrassv2 get-core-device \
--core-device-thing-name MyGreengrassCore
```
出力:
```
{
"coreDeviceThingName": "MyGreengrassCore",
"coreVersion": "2.0.3",
"platform": "linux",
"architecture": "amd64",
"status": "HEALTHY",
"lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00",
"tags": {}
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-core-device.html)」を参照してください。
### `get-deployment`
次のコード例は、`get-deployment` を使用する方法を示しています。
**AWS CLI**
**デプロイを取得するには**
次の の`get-deployment`例では、 AWS IoT Greengrass nucleus コンポーネントのコアデバイスのグループへのデプロイに関する情報を取得します。
```
aws greengrassv2 get-deployment \
--deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
出力:
```
{
"targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup",
"revisionId": "14",
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"deploymentName": "Deployment for MyGreengrassCoreGroup",
"deploymentStatus": "ACTIVE",
"iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"components": {
"aws.greengrass.Nucleus": {
"componentVersion": "2.0.3",
"configurationUpdate": {
"merge": "{\"jvmOptions\":\"-Xmx64m\",\"logging\":{\"level\":\"WARN\"}}",
"reset": [
"/networkProxy",
"/mqtt"
]
}
}
},
"deploymentPolicies": {
"failureHandlingPolicy": "ROLLBACK",
"componentUpdatePolicy": {
"timeoutInSeconds": 60,
"action": "NOTIFY_COMPONENTS"
},
"configurationValidationPolicy": {
"timeoutInSeconds": 60
}
},
"iotJobConfiguration": {},
"creationTimestamp": "2021-01-07T17:21:20.691000-08:00",
"isLatestForTarget": false,
"tags": {}
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントをデバイスにデプロイする](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-deployments.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-deployment.html)」を参照してください。
### `get-service-role-for-account`
次の例は、`get-service-role-for-account` を使用する方法を説明しています。
**AWS CLI**
** AWS アカウントの Greengrass サービスロールを取得するには**
次の の`get-service-role-for-account`例では、 AWS アカウントの AWS IoT Greengrass に関連付けられているサービスロールを取得します。
```
aws greengrassv2 get-service-role-for-account
```
出力:
```
{
"associatedAt": "2022-01-19T19:21:53Z",
"roleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole"
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceRoleForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-service-role-for-account.html)」を参照してください。
### `list-client-devices-associated-with-core-device`
次のコード例は、`list-client-devices-associated-with-core-device` を使用する方法を示しています。
**AWS CLI**
**コアデバイスに関連付けられたクライアントデバイスを一覧表示するには**
次の `list-client-devices-associated-with-core-device` の例では、コアデバイスに関連付けられているすべてのクライアントデバイスを一覧表示します。
```
aws greengrassv2 list-client-devices-associated-with-core-device \
--core-device-thing-name MyTestGreengrassCore
```
出力:
```
{
"associatedClientDevices": [
{
"thingName": "MyClientDevice2",
"associationTimestamp": "2021-07-12T16:33:55.843000-07:00"
},
{
"thingName": "MyClientDevice1",
"associationTimestamp": "2021-07-12T16:33:55.843000-07:00"
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[ローカル IoT デバイスとやり取りする](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html)」参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListClientDevicesAssociatedWithCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-client-devices-associated-with-core-device.html)」を参照してください。
### `list-component-versions`
次のコード例は、`list-component-versions` を使用する方法を示しています。
**AWS CLI**
**コンポーネントのバージョンを一覧表示するには**
次の `list-component-versions` の例では、Hello World コンポーネントのすべてのバージョンを一覧表示します。
```
aws greengrassv2 list-component-versions \
--arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld
```
出力:
```
{
"componentVersions": [
{
"componentName": "com.example.HelloWorld",
"componentVersion": "1.0.1",
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.1"
},
{
"componentName": "com.example.HelloWorld",
"componentVersion": "1.0.0",
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0"
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComponentVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-component-versions.html)」を参照してください。
### `list-components`
次のコード例は、`list-components` を使用する方法を示しています。
**AWS CLI**
**コンポーネントを一覧表示するには**
次の の`list-components`例では、現在のリージョンの AWS アカウントで定義されている各コンポーネントとその最新バージョンを一覧表示します。
```
aws greengrassv2 list-components
```
出力:
```
{
"components": [
{
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld",
"componentName": "com.example.HelloWorld",
"latestVersion": {
"arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.1",
"componentVersion": "1.0.1",
"creationTimestamp": "2021-01-08T16:51:07.352000-08:00",
"description": "My first AWS IoT Greengrass component.",
"publisher": "Amazon",
"platforms": [
{
"attributes": {
"os": "linux"
}
}
]
}
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-components.html)」を参照してください。
### `list-core-devices`
次のコード例は、`list-core-devices` を使用する方法を示しています。
**AWS CLI**
**コアデバイスを一覧表示するには**
次の の`list-core-devices`例では、現在のリージョンの AWS アカウントの AWS IoT Greengrass コアデバイスを一覧表示します。
```
aws greengrassv2 list-core-devices
```
出力:
```
{
"coreDevices": [
{
"coreDeviceThingName": "MyGreengrassCore",
"status": "HEALTHY",
"lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00"
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCoreDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-core-devices.html)」を参照してください。
### `list-deployments`
次のコード例は、`list-deployments` を使用する方法を示しています。
**AWS CLI**
**デプロイを一覧表示するには**
次の の`list-deployments`例では、現在のリージョンの AWS アカウントで定義された各デプロイの最新リビジョンを一覧表示します。
```
aws greengrassv2 list-deployments
```
出力:
```
{
"deployments": [
{
"targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup",
"revisionId": "14",
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"deploymentName": "Deployment for MyGreengrassCoreGroup",
"creationTimestamp": "2021-01-07T17:21:20.691000-08:00",
"deploymentStatus": "ACTIVE",
"isLatestForTarget": false
},
{
"targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore",
"revisionId": "1",
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"deploymentName": "Deployment for MyGreengrassCore",
"creationTimestamp": "2021-01-06T16:10:42.407000-08:00",
"deploymentStatus": "COMPLETED",
"isLatestForTarget": false
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントをデバイスにデプロイする](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-deployments.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-deployments.html)」を参照してください。
### `list-effective-deployments`
次のコード例は、`list-effective-deployments` を使用する方法を示しています。
**AWS CLI**
**デプロイジョブを一覧表示するには**
次の の`list-effective-deployments`例では、 AWS IoT Greengrass コアデバイスに適用されるデプロイを一覧表示します。
```
aws greengrassv2 list-effective-deployments \
--core-device-thing-name MyGreengrassCore
```
出力:
```
{
"effectiveDeployments": [
{
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"deploymentName": "Deployment for MyGreengrassCore",
"iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore",
"coreDeviceExecutionStatus": "COMPLETED",
"reason": "SUCCESSFUL",
"creationTimestamp": "2021-01-06T16:10:42.442000-08:00",
"modifiedTimestamp": "2021-01-08T17:21:27.830000-08:00"
},
{
"deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"deploymentName": "Deployment for MyGreengrassCoreGroup",
"iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
"iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
"targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup",
"coreDeviceExecutionStatus": "SUCCEEDED",
"reason": "SUCCESSFUL",
"creationTimestamp": "2021-01-07T17:19:20.394000-08:00",
"modifiedTimestamp": "2021-01-07T17:21:20.721000-08:00"
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEffectiveDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-effective-deployments.html)」を参照してください。
### `list-installed-components`
次のコード例は、`list-installed-components` を使用する方法を示しています。
**AWS CLI**
**コアデバイスにインストールされているコンポーネントを一覧表示するには**
次の の`list-installed-components`例では、 AWS IoT Greengrass コアデバイスにインストールされているコンポーネントを一覧表示します。
```
aws greengrassv2 list-installed-components \
--core-device-thing-name MyGreengrassCore
```
出力:
```
{
"installedComponents": [
{
"componentName": "aws.greengrass.Cli",
"componentVersion": "2.0.3",
"lifecycleState": "RUNNING",
"isRoot": true
},
{
"componentName": "aws.greengrass.Nucleus",
"componentVersion": "2.0.3",
"lifecycleState": "FINISHED",
"isRoot": true
}
]
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstalledComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-installed-components.html)」を参照してください。
### `list-tags-for-resource`
次のコード例は、`list-tags-for-resource` を使用する方法を示しています。
**AWS CLI**
**リソースのタグを一覧表示するには**
次の の`list-tags-for-resource`例では、 AWS IoT Greengrass コアデバイスのすべてのタグを一覧表示します。
```
aws greengrassv2 list-tags-for-resource \
--resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore
```
出力:
```
{
"tags": {
"Owner": "richard-roe"
}
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[リソースのタグ付け](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-tags-for-resource.html)」を参照してください。
### `tag-resource`
次のコード例は、`tag-resource` を使用する方法を示しています。
**AWS CLI**
**リソースにタグを追加**
次の`tag-resource`例では、 AWS IoT Greengrass コアデバイスに所有者タグを追加します。このタグを使用して、コアデバイスを所有するユーザーに基づいてコアデバイスへのアクセスを制御できます。
```
aws greengrassv2 tag-resource \
--resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \
--tags Owner=richard-roe
```
このコマンドでは何も出力されません。
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[リソースのタグ付け](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/tag-resource.html)」を参照してください。
### `untag-resource`
次の例では、`untag-resource` を使用する方法を説明しています。
**AWS CLI**
**リソースからタグを削除するには**
次の の`untag-resource`例では、 AWS IoT Greengrass コアデバイスから所有者タグを削除します。
```
aws iotsitewise untag-resource \
--resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \
--tag-keys Owner
```
このコマンドでは何も出力されません。
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[リソースのタグ付け](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/untag-resource.html)」を参照してください。
### `update-connectivity-info`
次のコード例は、`update-connectivity-info` を使用する方法を示しています。
**AWS CLI**
**Greengrass コアデバイスの接続情報を更新するには**
次の `update-connectivity-info` の例では、Greengrass コアデバイスの接続情報を取得します。クライアントデバイスはこの情報を使用して、このコアデバイスで実行される MQTT ブローカーに接続します。
```
aws greengrassv2 update-connectivity-info \
--thing-name MyGreengrassCore \
--cli-input-json file://core-device-connectivity-info.json
```
`core-device-connectivity-info.json` の内容:
```
{
"connectivityInfo": [
{
"hostAddress": "192.0.2.0",
"portNumber": 8883,
"id": "localIP_192.0.2.0"
}
]
}
```
出力:
```
{
"version": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスエンドポイントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-core-device-endpoints.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/update-connectivity-info.html)」を参照してください。