翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS IoTジョブの準備

AWS IoT Device ManagementSoftware Package Catalog は、置換パラメータ、AWS IoTフリートインデックス作成、モノの動的グループ、モノAWS IoTの予約済み名前付きシャドウとの統合を通じてAWS IoTジョブを拡張します。

AWS IoTジョブの置換パラメータ

置換パラメータは、AWS IoTジョブドキュメント内のプレースホルダーとして使用できます。ジョブサービスが代替パラメータを検出すると、そのジョブは、指定されたソフトウェアバージョンのパラメータ値の属性を指します。このプロセスを使用して 1 つのジョブドキュメントを作成し、汎用属性を介してメタデータをジョブに渡すことができます。例えば、Amazon Simple Storage Service (Amazon S3) URL、ソフトウェアパッケージ Amazon リソースネーム (ARN)、または署名をパッケージバージョン属性を介してジョブドキュメントに渡すことができます。

代替パラメータは、ジョブドキュメントで次のようにフォーマットする必要があります。

次の例では、samplePackage という名前のソフトウェアパッケージがあり、そのパッケージバージョンには以下の属性を持つ 2.1.5 という名前のパッケージバージョンがあります。

s3URL の場合、ジョブドキュメントパラメータは次のように記述されます。

{
"samplePackage": "${aws:iot:package:samplePackage1:version:2.1.5:attributes:s3URL}"
}

signature の場合、ジョブドキュメントパラメータは次のように記述されます。

{
"samplePackage": "${aws:iot:package:samplePackage1:version:2.1.5:attributes:signature}"
}

ジョブドキュメント全体は次のように記述されます。

{
  ...
  "Steps": {
    "uninstall": ["samplePackage"],
    "download": [ 
      { 
        "samplePackage": "${aws:iot:package:samplePackage1:version:2.1.5:attributes:s3URL}"
      },
    ],
    "signature": [
      "samplePackage" : "${aws:iot:package:samplePackage1:version:2.1.5:attributes:signature}"
    ]
  }
}

置換が行われると、次のジョブドキュメントがデバイスにデプロイされます。

{
  ...
  "Steps": {
    "uninstall": ["samplePackage"],
    "download": [ 
      { 
        "samplePackage": "https://EXAMPIEBUCKET.s3.us-west-2.amazonaws.com/exampleCodeFile"
      },
    ],
    "signature": [
      "samplePackage" : "aaaaabbbbbcccccdddddeeeeefffffggggghhhhhiiiiijjjj"
    ]
  }
}

置換パラメータ (表示前と表示後)

代替パラメータは、デフォルトのパッケージバージョンの $default など、さまざまなフラグを使用してジョブドキュメントの作成を効率化します。これにより、特定のパッケージ検証で参照されるメタデータがそれらのフラグに自動入力されるため、ジョブデプロイごとに特定のパッケージバージョンメタデータを手動で入力する必要がなくなります。デフォルトのパッケージバージョンの $default など、パッケージバージョンの属性の詳細については、「デプロイ用のジョブドキュメントとパッケージバージョンの準備」を参照してください。

でAWS マネジメントコンソール、パッケージバージョンのジョブデプロイ中にデプロイ指示ファイルエディタウィンドウのプレビュー置換ボタンを切り替えると、置換パラメータの有無にかかわらずジョブドキュメントが表示されます。

DescribeJob および GetJobDocument API の「置換前」パラメータを使用すると、置換パラメータが削除される前後の API レスポンスを表示できます。DescribeJob および GetJobDocument API で次の例を参照してください。

AWS IoTジョブ、ジョブドキュメントの作成、ジョブのデプロイの詳細については、「ジョブ」を参照してください。

デプロイ用のジョブドキュメントとパッケージバージョンの準備

パッケージバージョンが作成されると、デプロイの準備中であることを示す draft 状態になります。デプロイのパッケージバージョンを準備するには、ジョブドキュメントを作成し、ジョブがアクセスできる場所 (Amazon S3 など) にドキュメントを保存して、パッケージバージョンにジョブドキュメントで使用したい属性値があることを確認し、パッケージバージョンを公開する必要があります。(注意: draft 状態にあるパッケージバージョンの属性のみを更新できます)。

単一パッケージデプロイ用の AWS IoTジョブまたは ジョブテンプレートを作成する場合、ジョブドキュメントをカスタマイズするための以下のオプションがあります。

デプロイ指示ファイル (recipe)

Artifact バージョン属性

パッケージバージョン

パッケージバージョンに満足したら、AWS IoTコンソールのソフトウェアパッケージの詳細ページまたは UpdatePackageVersion API オペレーションを発行して公開します。その後、AWS IoTコンソールから、または CreateJob API オペレーションを発行してジョブを作成するときに、パッケージバージョンを参照できます。

デプロイ時のパッケージとバージョンの命名

ソフトウェアパッケージバージョンをデバイスにデプロイするには、ジョブドキュメントで参照されているソフトウェアパッケージとパッケージバージョンが、CreateJob API オペレーションの destinationPackageVersions パラメータに記載されているソフトウェアパッケージとパッケージバージョンと一致していることを確認します。一致しない場合は、両方の参照を一致させるように促すエラーメッセージが表示されます。Software Package Catalog のエラーメッセージの詳細については、「エラーメッセージの一般的なトラブルシューティング」を参照してください。

ジョブドキュメントで参照されているソフトウェアパッケージとパッケージバージョンに加えて、ジョブドキュメントで参照されていない CreateJob API オペレーションの destinationPackageVersions パラメータに追加のソフトウェアパッケージとパッケージバージョンを含めることができます。追加のソフトウェアパッケージバージョンを適切にインストールするために、必要なインストール情報がジョブドキュメントに含まれていることを確認します。CreateJob API オペレーションの詳細については、「CreateJob」を参照してください。

モノのAWS IoT動的グループによるジョブのターゲット設定

Software Package Catalog は、フリートインデックス作成、AWS IoT のジョブ、AWS IoT のモノの動的グループと連携して、フリート内のデバイスをフィルタリングしてターゲットにし、デバイスにデプロイするパッケージバージョンを選択します。デバイスの現在のパッケージ情報に基づいてフリートインデックス作成クエリを実行し、それらのモノを AWS IoTジョブにターゲットにすることができます。ソフトウェアアップデートをリリースすることもできますが、対象となるターゲットデバイスに対してのみです。例えば、現在 iot-device-client 1.5.09 を実行しているデバイスにのみ設定をデプロイするように指定できます。詳細については、「モノの動的グループを作成する」を参照してください。

予約済みの名前付きシャドウとパッケージバージョン

設定されている場合、AWS IoTジョブが正常に完了すると、ジョブはモノの予約済み名前付きシャドウ ($package) を更新できます。そうすれば、パッケージバージョンをモノの予約済みの名前付きシャドウに手動で関連付ける必要がなくなります。

次のような状況では、パッケージバージョンをモノの予約済みの名前付きシャドウに手動で関連付けるか、更新することを選択できます。

コンソールまたは UpdateThingShadow API オペレーションを使用して、モノの予約済みの名前付きシャドウ ($package) にパッケージバージョンを追加または更新できます。詳細については、「 AWS IoTモノへのパッケージバージョンの関連付け」を参照してください。

ソフトウェアパッケージとそのパッケージバージョンのアンインストール

$null は、AWS IoTJobs サービスに、デバイスの予約済みの名前付きシャドウ から既存のソフトウェアパッケージとパッケージバージョンを削除するように求める予約済みプレースホルダーです$package。詳細については、「予約済みの名前付きシャドウ」を参照してください。

この機能を使用するには、destinationPackageVersion Amazon リソースネーム (ARN) を $null に置き換えます。その後、デバイスからソフトウェアを削除するようにサービスに指示する必要があります。

承認された ARN は次の形式を使用します。

arn:aws:iot:<regionCode>:111122223333:package/<packageName>/version/$null

例えば、

$ aws iot create-job \
    ... \
    --destinationPackageVersions ["arn:aws:iot:us-east-1:111122223333:package/samplePackage/version/$null"]