翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
AWS IoT を使用した例 AWS CLI
次のコード例は、 AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS IoT。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。
トピック
アクション
次の例は、accept-certificate-transfer
を使用する方法を説明しています。
- AWS CLI
-
別の AWS アカウントから転送されたデバイス証明書を受け入れるには
次の
accept-certificate-transfer
例では、別の AWS アカウントから転送されたデバイス証明書を受け入れます。証明書は ID で識別されます。aws iot accept-certificate-transfer \ --certificate-id
488b6a7f2acdeb00a77384e63c4e40b18bEXAMPLEe57b7272ba44c45e3448142
このコマンドでは、出力が生成されません。
詳細については、「 IoT Core デベロッパーガイド」の「証明書を別のアカウントに転送する」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスAcceptCertificateTransfer
」の「」を参照してください。
-
次の例は、add-thing-to-billing-group
を使用する方法を説明しています。
- AWS CLI
-
例 1: 請求グループにモノを名前で追加するには
次の
add-thing-to-billing-group
例では、 という名前のモノMyLightBulb
を という名前の請求グループに追加しますGroupOne
。aws iot add-thing-to-billing-group \ --billing-group-name
GroupOne
\ --thing-nameMyLightBulb
このコマンドでは何も出力されません。
例 2: ARN請求グループにモノを追加するには
次の
add-thing-to-billing-group
例では、指定された を持つモノARNを、指定された を持つ請求グループに追加しますARN。の指定ARNは、複数の AWS リージョンまたはアカウントを使用する場合に役立ちます。これにより、 を適切なリージョンとアカウントに追加できます。aws iot add-thing-to-thing-group \ --billing-group-arn
"arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne"
\ --thing-arn"arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb"
このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスAddThingToBillingGroup
」の「」を参照してください。
-
次のコード例は、add-thing-to-thing-group
を使用する方法を示しています。
- AWS CLI
-
モノをグループに追加するには
次の
add-thing-to-thing-group
例では、指定されたモノを指定されたモノグループに追加します。aws iot add-thing-to-thing-group \ --thing-name
MyLightBulb
\ --thing-group-nameLightBulbs
このコマンドでは何も出力されません。
詳細については、「IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスAddThingToThingGroup
」の「」を参照してください。
-
次のコード例は、associate-targets-with-job
を使用する方法を示しています。
- AWS CLI
-
モノのグループを連続ジョブに関連付けるには
次の
associate-targets-with-job
例では、指定されたモノのグループを指定された連続ジョブに関連付けます。aws iot associate-targets-with-job \ --targets
"arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
\ --job-id"example-job-04"
出力:
{ "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", "jobId": "example-job-04", "description": "example continuous job" }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスAssociateTargetsWithJob
」の「」を参照してください。
-
次の例は、attach-policy
を使用する方法を説明しています。
- AWS CLI
-
例 1: モノのグループにポリシーをアタッチするには
次の
attach-policy
例では、指定されたポリシーを によって識別されるモノのグループにアタッチしますARN。aws iot attach-policy \ --target
"arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
\ --policy-name"UpdateDeviceCertPolicy"
このコマンドでは、出力が生成されません。
詳細については、「IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
例 2: ポリシーを証明書にアタッチするには
次の
attach-policy
例では、証明書で指定されたプリンシパルUpdateDeviceCertPolicy
にポリシーをアタッチします。aws iot attach-policy \ --policy-name
UpdateDeviceCertPolicy
\ --target"arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e"
このコマンドでは、出力が生成されません。
詳細については、AWS IoT デベロッパーガイド」の「デバイス証明書に IoT ポリシーをアAWS タッチする IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスAttachPolicy
」の「」を参照してください。
-
次のコード例は、attach-security-profile
を使用する方法を示しています。
- AWS CLI
-
セキュリティプロファイルを登録されていないすべてのデバイスに関連付けるには
次の
attach-security-profile
例では、 という名前の AWS IoT Device Defender セキュリティプロファイルを、この AWS アカウントのus-west-2
リージョン内のすべての未登録デバイスTestprofile
と関連付けます。aws iot attach-security-profile \ --security-profile-name
Testprofile
\ --security-profile-target-arn"arn:aws:iot:us-west-2:123456789012:all/unregistered-things"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスAttachSecurityProfile
」の「」を参照してください。
-
次の例は、attach-thing-principal
を使用する方法を説明しています。
- AWS CLI
-
モノに証明書をアタッチするには
次の
attach-thing-principal
例では、 MyTemperatureSensor モノに証明書をアタッチします。証明書は によって識別されますARN。 AWS IoT コンソールで証明書ARNの を見つけることができます。aws iot attach-thing-principal \ --thing-name
MyTemperatureSensor
\ --principalarn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8
このコマンドでは何も出力されません。
詳細については、「AWS IoT ディベロッパーガイド」の「レジストリによるモノの管理方法」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスAttachThingPrincipal
」の「」を参照してください。
-
次のコード例は、cancel-audit-mitigation-actions-task
を使用する方法を示しています。
- AWS CLI
-
監査緩和アクションタスクをキャンセルするには
次の
cancel-audit-mitigations-action-task
例では、指定されたタスクの緩和アクションの適用をキャンセルします。既に完了したタスクはキャンセルできません。aws iot cancel-audit-mitigation-actions-task --task-id
"myActionsTaskId"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドのCancelAuditMitigationActionsTask 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCancelAuditMitigationActionsTask
」の「」を参照してください。
-
次のコード例は、cancel-audit-task
を使用する方法を示しています。
- AWS CLI
-
監査タスクをキャンセルするには
次の
cancel-audit-task
例では、指定されたタスク ID を持つ監査タスクをキャンセルします。完了したタスクをキャンセルすることはできません。aws iot cancel-audit-task \ --task-id
a3aea009955e501a31b764abe1bebd3d
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCancelAuditTask
」の「」を参照してください。
-
次の例は、cancel-certificate-transfer
を使用する方法を説明しています。
- AWS CLI
-
別の AWS アカウントへの証明書の移管をキャンセルするには
次の
cancel-certificate-transfer
例では、指定された証明書転送の転送をキャンセルします。証明書は証明書 ID で識別されます。 AWS IoT コンソールで証明書の ID を確認できます。aws iot cancel-certificate-transfer \ --certificate-id
f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8
このコマンドでは何も出力されません。
詳細については、「 IoT Core デベロッパーガイド」の「証明書を別のアカウントに転送するAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCancelCertificateTransfer
」の「」を参照してください。
-
次のコード例は、cancel-job-execution
を使用する方法を示しています。
- AWS CLI
-
デバイスでジョブ実行をキャンセルするには
次の
cancel-job-execution
例では、デバイスで指定されたジョブの実行をキャンセルします。ジョブがQUEUED
状態にない場合は、--force
パラメータを追加する必要があります。aws iot cancel-job-execution \ --job-id
"example-job-03"
\ --thing-name"MyRPi"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCancelJobExecution
」の「」を参照してください。
-
次のコード例は、cancel-job
を使用する方法を示しています。
- AWS CLI
-
ジョブをキャンセルするには
次の
cancel-job
例では、指定されたジョブをキャンセルします。aws iot cancel-job \ --job-job
"example-job-03"
出力:
{ "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-03", "jobId": "example-job-03", "description": "example job test" }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCancelJob
」の「」を参照してください。
-
次のコード例は、clear-default-authorizer
を使用する方法を示しています。
- AWS CLI
-
デフォルトのオーソライザーをクリアするには
次の
clear-default-authorizer
例では、現在設定されているデフォルトのカスタムオーソライザーをクリアします。このコマンドを実行すると、デフォルトのオーソライザーはありません。カスタムオーソライザーを使用する場合は、HTTPリクエストヘッダーに名前で指定する必要があります。aws iot clear-default-authorizer
このコマンドでは何も出力されません。
詳細については、AWS IoT APIリファレンスのClearDefaultAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスClearDefaultAuthorizer
」の「」を参照してください。
-
次の例は、confirm-topic-rule-destination
を使用する方法を説明しています。
- AWS CLI
-
トピックルールの送信先を確認するには
次の
confirm-topic-rule-destination
例では、HTTPエンドポイントで受信した確認トークンを使用してトピックルールの送信先を確認します。aws iot confirm-topic-rule-destination \ --confirmation-token
"AYADeIcmtq-ZkxfpiWIQqHWM5ucAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREFxY1E0UmlGeDg0V21BZWZ1VjZtZWFRVUJJUktUYXJaN09OZlJOczJhRENSZmZYL3JHZC9PR3NNcis5T3ZlSitnQT09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLWVhc3QtMTo5ODc5NTE4NTI0OTk6a2V5L2U4YmU3ODViLTU5NWMtNDcxYi1iOWJmLWQ2Y2I4ZjQxODlmNwC4AQIBAHhwz48UWTGWE1ua0P8U1hj27nsFzEaAdf6Hs2K_7wBheAF62zwMuk_A4dPiC6eyPGuMAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM9vtRMpf9D3CiZ8sMAgEQgDuFd0Txy-aywpPqg8YEsa1lD4B40aJ2s1wEHKMybiF1RoOZzYisI0IvslzQY5UmCkqq3tV-3f7-nKfosgIAAAAADAAAEAAAAAAAAAAAAAAAAAAi9RMgy-V19V9m6Iw2xfbw_____wAAAAEAAAAAAAAAAAAAAAEAAAB1hw4SokgUcxiJ3gTO6n50NLJVpzyQR1UmPIj5sShqXEQGcOsWmXzpYOOx_PWyPVNsIFHApyK7Cc3g4bW8VaLVwOLkC83g6YaZAh7dFEl2-iufgrzTePl8RZYOWr0O6Aj9DiVzJZx-1iD6Pu-G6PUw1kaO7Knzs2B4AD0qfrHUF4pYRTvyUgBnMGUCMQC8ZRmhKqntd_c6Kgrow3bMUDBvNqo2qZr8Z8Jm2rzgseROlAnLgFLGpGShr99oSZkCMEd1v62NBRKX9HQXnybyF3fkg__-PIetJ803Z4IlIlF8xXlcdPGP-PV1dOXFemyL8g"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先の確認」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスConfirmTopicRuleDestination
」の「」を参照してください。
-
次の例は、create-audit-suppression
を使用する方法を説明しています。
- AWS CLI
-
監査結果の抑制を作成するには
次の
create-audit-suppression
例では、virtualMachinePolicy「」という名前のポリシーに対して、過度に許容されているというフラグが付けられた監査結果の抑制を作成します。aws iot create-audit-suppression \ --check-name
IOT_POLICY_OVERLY_PERMISSIVE_CHECK
\ --resource-identifier policyVersionIdentifier={"policyName"="virtualMachinePolicy","policyVersionId"="1"} \ --no-suppress-indefinitely \ --expiration-date2020-10-20
このコマンドでは何も出力されません。
詳細については、「 IoT デベロッパーガイド」の「監査結果の抑制AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateAuditSuppression
」の「」を参照してください。
-
次のコード例は、create-authorizer
を使用する方法を示しています。
- AWS CLI
-
カスタムオーソライザーを作成するには
次の
create-authorizer
例では、カスタム認証サービスの一部として指定された Lambda 関数を使用するカスタムオーソライザーを作成します。aws iot create-authorizer \ --authorizer-name "CustomAuthorizer" \ --authorizer-function-arn "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction" \ --token-key-name "MyAuthToken" \ --status ACTIVE \ --token-signing-public-keys FIRST_KEY="-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo Z+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y ZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p zwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ +GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx 50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1 lQIDAQAB -----END PUBLIC KEY-----"
出力:
{ "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" }
詳細については、AWS IoT APIリファレンスのCreateAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateAuthorizer
」の「」を参照してください。
-
次の例は、create-billing-group
を使用する方法を説明しています。
- AWS CLI
-
請求グループを作成するには
次の
create-billing-group
例では、 という名前の単純な請求グループを作成しますGroupOne
。aws iot create-billing-group \ --billing-group-name
GroupOne
出力:
{ "billingGroupName": "GroupOne", "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562" }
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateBillingGroup
」の「」を参照してください。
-
次のコード例は、create-certificate-from-csr
を使用する方法を示しています。
- AWS CLI
-
証明書署名リクエストからデバイス証明書を作成するには (CSR)
次の
create-certificate-from-csr
例では、 からデバイス証明書を作成しますCSR。openssl
コマンドを使用して を作成できますCSR。aws iot create-certificate-from-csr \ --certificate-signing-request=file://certificate.csr
出力:
{ "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", "certificateId": "c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", "certificatePem": "<certificate-text>" }
詳細については、AWS IoT APIリファレンスのCreateCertificateFromCSR「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateCertificateFromCsr
」の「」を参照してください。
-
次の例は、create-custom-metric
を使用する方法を説明しています。
- AWS CLI
-
デバイスが Device Defender に発行するカスタムメトリクスを作成するには
次の
create-custom-metric
例では、バッテリーの割合を測定するカスタムメトリクスを作成します。aws iot create-custom-metric \ --metric-name
"batteryPercentage"
\ --metric-type"number"
\ --display-name"Remaining battery percentage."
\ --regionus-east-1
\ --client-request-token"02ccb92b-33e8-4dfa-a0c1-35b181ed26b0"
出力:
{ "metricName": "batteryPercentage", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage" }
詳細については、「 IoT Core デベロッパーガイド」の「カスタムメトリクス」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateCustomMetric
」の「」を参照してください。
-
次のコード例は、create-dimension
を使用する方法を示しています。
- AWS CLI
-
ディメンションを作成するには
以下では、 という 1 つのトピックフィルターでディメンション
create-dimension
を作成しますTopicFilterForAuthMessages
。aws iot create-dimension \ --name
TopicFilterForAuthMessages
\ --typeTOPIC_FILTER
\ --string-valuesdevice/+/auth
出力:
{ "name": "TopicFilterForAuthMessages", "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages" }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateDimension
」の「」を参照してください。
-
次のコード例は、create-domain-configuration
を使用する方法を示しています。
- AWS CLI
-
ドメイン設定を作成するには
次の
create-domain-configuration
例では、サービスタイプが の AWSマネージドドメイン設定を作成しますDATA
。aws iot create-domain-configuration \ --domain-configuration-name
"additionalDataDomain"
\ --service-type"DATA"
出力:
{ "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" }
詳細については、AWS IoT デベロッパーガイドの「設定可能なエンドポイント」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateDomainConfiguration
」の「」を参照してください。
-
次の例は、create-dynamic-thing-group
を使用する方法を説明しています。
- AWS CLI
-
動的モノのグループを作成するには
次の
create-dynamic-thing-group
例では、60 度を超える温度属性を持つモノを含む動的なモノグループを作成します。動的モノのグループを使用する前に、 AWS IoT フリートのインデックス作成を有効にする必要があります。aws iot create-dynamic-thing-group \ --thing-group-name
"RoomTooWarm"
\ --query-string"attributes.temperature>60"
出力:
{ "thingGroupName": "RoomTooWarm", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm", "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1", "indexName": "AWS_Things", "queryString": "attributes.temperature>60", "queryVersion": "2017-09-30" }
詳細については、IoT デベロッパーガイドの「Dynamic Thing Groups」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateDynamicThingGroup
」の「」を参照してください。
-
次のコード例は、create-job
を使用する方法を示しています。
- AWS CLI
-
例 1: ジョブを作成するには
次の
create-job
例では、MyRaspberryPi
デバイスにJSONドキュメントを送信するシンプルな AWS IoT ジョブを作成します。aws iot create-job \ --job-id
"example-job-01"
\ --targets"arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi"
\ --documentfile://example-job.json
\ --description"example job test"
\ --target-selectionSNAPSHOT
出力:
{ "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "description": "example job test" }
例 2: 連続ジョブを作成するには
次の
create-job
例では、ターゲットとして指定されたモノがジョブを完了した後も引き続き実行されるジョブを作成します。この例では、ターゲットはモノのグループであるため、新しいデバイスがグループに追加されると、それらの新しいモノに対して連続ジョブが実行されます。aws iot create-job --job-id「example-job-04」 --targets「arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" --document file://example-job.json --description」連続ジョブの例「--target-selection CONTINUOUS
出力:
{ "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", "jobId": "example-job-04", "description": "example continuous job" }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateJob
」の「」を参照してください。
-
次のコード例は、create-keys-and-certificate
を使用する方法を示しています。
- AWS CLI
-
RSAキーペアを作成して X.509 証明書を発行するには
以下は、2048 ビットのRSAキーペア
create-keys-and-certificate
を作成し、発行されたパブリックキーを使用して X.509 証明書を発行します。IoT がこの証明書のプライベートキー AWS IoT を提供するのは今回のみですので、必ず安全な場所に保管してください。aws iot create-keys-and-certificate \ --certificate-pem-outfile
"myTest.cert.pem"
\ --public-key-outfile"myTest.public.key"
\ --private-key-outfile"myTest.private.key"
出力:
{ "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", "certificateId": "9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", "certificatePem": " -----BEGIN CERTIFICATE----- MIICiTCCEXAMPLE6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgEXAMPLEAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSEXAMPLE2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYEXAMPLEb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCEXAMPLEJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDAEXAMPLEsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEXAMPLE25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+aEXAMPLE EXAMPLEfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZEXAMPLELG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAEXAMPLEWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9qEXAMPLEyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkEXAMPLEQEFAAOCAQ8AMIIBCgKCAQEAEXAMPLE1nnyJwKSMHw4h\nMMEXAMPLEuuN/dMAS3fyce8DW/4+EXAMPLEyjmoF/YVF/gHr99VEEXAMPLE5VF13\n59VK7cEXAMPLE67GK+y+jikqXOgHh/xJTwo+sGpWEXAMPLEDz18xOd2ka4tCzuWEXAMPLEahJbYkCPUBSU8opVkR7qkEXAMPLE1DR6sx2HocliOOLtu6Fkw91swQWEXAMPLE\GB3ZPrNh0PzQYvjUStZeccyNCx2EXAMPLEvp9mQOUXP6plfgxwKRX2fEXAMPLEDa\nhJLXkX3rHU2xbxJSq7D+XEXAMPLEcw+LyFhI5mgFRl88eGdsAEXAMPLElnI9EesG\nFQIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nkey omittted for security reasons\n-----END RSA PRIVATE KEY-----\n" } }
詳細については、AWS 「 IoT デベロッパーガイド」の「IoT デバイス証明書の作成と登録」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateKeysAndCertificate
」の「」を参照してください。
-
次のコード例は、create-mitigation-action
を使用する方法を示しています。
- AWS CLI
-
緩和アクションを作成するには
次の
create-mitigation-action
例では、 という名前の緩和アクションを定義します。この緩和アクションを適用するAddThingsToQuarantineGroup1Action
と、モノは という名前のモノのグループに移動しますQuarantineGroup1
。このアクションは、動的なモノのグループを上書きします。aws iot create-mitigation-action --cli-input-json
file::params.json
params.json
の内容:{ "actionName": "AddThingsToQuarantineGroup1Action", "actionParams": { "addThingsToThingGroupParams": { "thingGroupNames": [ "QuarantineGroup1" ], "overrideDynamicGroups": true } }, "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole" }
出力:
{ "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroup1Action", "actionId": "992e9a63-a899-439a-aa50-4e20c52367e1" }
詳細については、AWS IoT デベロッパーガイドのCreateMitigationAction 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateMitigationAction
」の「」を参照してください。
-
次のコード例は、create-ota-update
を使用する方法を示しています。
- AWS CLI
-
Amazon Free で使用するOTA更新を作成するにはRTOS
次の
create-ota-update
例では、モノまたはグループのOTAUpdateターゲットグループに AWS IoT を作成します。これは Amazon FreeRTOS over-the-air 更新の一部であり、単一のデバイスまたはデバイスのグループに新しいファームウェアイメージをデプロイできます。aws iot create-ota-update \ --cli-input-json
file://create-ota-update.json
create-ota-update.json
の内容:{ "otaUpdateId": "ota12345", "description": "A critical update needed right away.", "targets": [ "device1", "device2", "device3", "device4" ], "targetSelection": "SNAPSHOT", "awsJobExecutionsRolloutConfig": { "maximumPerMinute": 10 }, "files": [ { "fileName": "firmware.bin", "fileLocation": { "stream": { "streamId": "004", "fileId":123 } }, "codeSigning": { "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ] "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" }
出力:
{ "otaUpdateId": "ota12345", "awsIotJobId": "job54321", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/itsajob", "otaUpdateStatus": "CREATE_IN_PROGRESS" }
詳細については、IoT リファレンス の「CreateOTAUpdate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateOtaUpdate
」の「」を参照してください。
-
次のコード例は、create-policy-version
を使用する方法を示しています。
- AWS CLI
-
ポリシーを新しいバージョンで更新するには
次の
create-policy-version
例では、ポリシー定義を更新し、新しいポリシーバージョンを作成します。この例では、新しいバージョンもデフォルトになります。aws iot create-policy-version \ --policy-name
UpdateDeviceCertPolicy
\ --policy-documentfile://policy.json
\ --set-as-defaultpolicy.json
の内容:{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iot:UpdateCertificate", "Resource": "*" } ] }
出力:
{ "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", "policyVersionId": "2", "isDefaultVersion": true }
詳細については、AWS 「 IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreatePolicyVersion
」の「」を参照してください。
-
次の例は、create-policy
を使用する方法を説明しています。
- AWS CLI
-
AWS IoT ポリシーを作成するには
次の
create-policy
例では、 という名前の AWS IoT ポリシーを作成します TemperatureSensorPolicy。policy.json
ファイルには、 AWS IoT ポリシーアクションを許可するステートメントが含まれています。aws iot create-policy \ --policy-name
TemperatureSensorPolicy
\ --policy-documentfile://policy.json
policy.json
の内容:{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iot:Publish", "iot:Receive" ], "Resource": [ "arn:aws:iot:us-west-2:123456789012:topic/topic_1", "arn:aws:iot:us-west-2:123456789012:topic/topic_2" ] }, { "Effect": "Allow", "Action": [ "iot:Subscribe" ], "Resource": [ "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1", "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2" ] }, { "Effect": "Allow", "Action": [ "iot:Connect" ], "Resource": [ "arn:aws:iot:us-west-2:123456789012:client/basicPubSub" ] } ] }
出力:
{ "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": [ \"iot:Publish\", \"iot:Receive\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Subscribe\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Connect\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" ] } ] }", "policyVersionId": "1" }
詳細については、AWS 「 IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreatePolicy
」の「」を参照してください。
-
次のコード例は、create-provisioning-claim
を使用する方法を示しています。
- AWS CLI
-
プロビジョニングクレームを作成するには
次の
create-provisioning-claim
例では、プロビジョニングテンプレートからプロビジョニングクレームを作成します。aws iot create-provisioning-claim \ --template-name
MyTestProvisioningTemplate
出力:
{ "certificateId": "78de02184b2ce80cf8fb709bda59e62b19fb83513590483eb0434589476ab09f", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgIUXSZhEBLztMLZ2fHG 14gV0NymYY0wDQYJKoZIhvcNAQEL\nBQAwfjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBg VBAcM\nB1NlYXR0bGUxGDAWBgNVBAoMD0FtYXpvbi5jb20gSW5jLjEgMB4GA1UECwwXQW1h\nem9uIElvVCBQcm9 2aXNpb25pbmcxDDAKBgNVBAUTAzEuMDAeFw0yMDA3MjgxNjQ0\nMDZaFw0yMDA3MjgxNjUxMDZaMEsxSTBHBgNVB AMMQDFhNDEyM2VkNmIxYjU3MzE3\nZTgzMTJmY2MzN2FiNTdhY2MzYTZkZGVjOGQ5OGY3NzUwMWRlMjc0YjhmYTQ xN2Iw\nggEiMA0GCSqGSIb3EXAMPLEAA4IBDwAwggEKAoIBAQDBhKI94ktKLqTwnj+ayOq1\nTAJt/N6s6IJDZvl rYjkC0E7wzaeY3TprWk03S29vUzVuEOXHXQXZbihgpg2m6fza\nkWm9/wpjzE9ny5+xkPGVH4Wnwz7yK5m8S0agL T96cRBSWnWmonOWdY0GKVzni0CA\n+iyGudgrFKm7Eae/v18oXrf82KtOAGO4xG0KE2WKYHsT1fx3c9xZhlXP/eX Lhv00\n+lGp0WVw9PbhKfrxliKJ5q6sL5nVUaUHq6hlQPYwsATeOvAp3u0ak5zgTyL0fg7Y\nPyKk6VYwLW62r+V YBSForEMOAhkq3LsP/rjxpEKmi2W4lPVS6oFZRKcD+H1Kyil5\nAgMBAAGjIDAeMAwGA1UdEwEB/wQCMAAwDgYDV R0PAQH/BAQDAgeAMA0GCSqGSIb3\nDQEBCwUAA4IBAQAGgix2k6nVqbZFKq97/fZBzLGS0dyz5rT/E41cDIRX+1j EPW41\nw0D+2sXheCZLZZnSkvIiP74IToNeXDrjdcaodeGFVHIElRjhMIq+4ZebPbRLtidF\nRc2hfcTAlqq9Z6v 5Vk6BeM1tu0RqH1wPoVUccLPya8EjNCbnJZUmGdOfrN/Y9pho\n5ikV+HPeZhG/k6dhE2GsQJyKFVHL/uBgKSily 1bRyWU1r6qcpWBNBHjUoD7HgOwD\nnzMh4XRb2FQDsqFalkCSYmeL8IVC49sgPD9Otyp5uteGMTy62usAAUQdq/f ZvrWg\nOkFpwMVnGKVKT7Kg0kKOLzKWOBB2Jm4/gmrJ\n-----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCg KCAQEAwYSiPeJLSi6k8J4/msjq\ntUwCbfzerOiCQ2b5a2I5AtBO8M2nmN06a1pNN0tvb1M1bhDlx10F2W4oYKYN pun8\n2pFpvf8KY8xPZ8ufsZDxlR+Fp8M+8iuZvEtGoC0/enEQUlp1pqJzlnWNBilc54tA\ngPoshrnYKxSpuxGn v79fKF63/NirTgBjuMRtChNlimEXAMPLE3PcWYZVz/3ly4b9\nNPpRqdFlcPT24Sn68ZYiieaurC+Z1VGlB6uoZU D2MLAE3jrwKd7tGpOc4E8i9H4O\n2D8ipOlWMC1utq/lWAUhaKxDDgIZKty7D/648aRCpotluJT1UuqBWUSnA/h9 Ssop\neQIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwYSiPeJLSi6k8J4/ msjqtUwCbfzerOiCQ2b5a2I5AtBO8M2n\nmN06a1pNN0tvb1M1bhDlx10F2W4oYKYNpun82pFpvf8KY8xPZ8ufsZ DxlR+Fp8M+\n8iuZvEtGoC0/enEQUlp1pqJzlnWNBilc54tAgPoshrnYKxSpuxGnv79fKF63/Nir\nTgBjuMRtCh NlimB7E9X8d3PcWYZVz/3ly4b9NPpRqdFlcPT24Sn68ZYiieaurC+Z\n1VGlB6uoZUD2MLAE3jrwKd7tGpOc4E8i 9H4O2D8ipOlWMC1utq/lWAUhaKxDDgIZ\nKty7D/648aRCpotluJT1UuqBWUSnA/h9SsopeQIDAQABAoIBAEAybN QUtx9T2/nK\ntZT2pA4iugecxI4dz+DmT0XVXs5VJmrx/nBSq6ejXExEpSIMO4RY7LE3ZdJcnd56\nF7tQkkY7yR VzfxHeXFU1krOIPuxWebNOrRoPZr+1RSer+wv2aBC525+88pVuR6tM\nm3pgkrR2ycCj9FdOUoQxdjHBHaM5PDmJ 9aSxCKdg3nReepeGwsR2TQA+m2vVxWk7\nou0+91eTOP+/QfP7P8ZjOIkO2XivlRcVDyN/E4QXPKuIkM/8vS8VK+ E9pATQ0MtB\n2lw8R/YU5AJd6jlEXAMPLEGU2UzRzInNWiLtkPPPqgqXXhxOf+mxByjcMalVJk0L\nhOG2ROUCgY EA+ROcHNHy/XbsP7FihOhEh+6Q2QxQ2ncBUPYbBazrR8Hn+7SCICQK\nVyYfd8Ajfq3e7RsKVL5SlMBp7Slidxak bIn28fKfPn62DaemGCIoyDgLpF+eUxBx\ngzbCiBZga8brfurza43UZjKZLpg3hq721+FeAiXi1Nma4Yr9YWEHEN 8CgYEAxuWt\npzdWWmsiFzfsAw0sy9ySDA/xr5WRWzJyAqUsjsks6rxNzWebpufnYHcmtW7pLdqM\nkboHwN2pXa kmZvrk2nKkEMq5brBYGDXuxDe+V369Bianx8aZFyIsckA7OwXW1w1h\ngRC5rQ4XOgp3+Jmw7eAO8LRYDjaN846+ QbtO2KcCgYAWS0UL51bijQR0ZwI0dz27\nFQVuCAYsp748aurcRTACCj8jbnK/QbqTNlxWsaH7ssBjZKo2D5sAqY BRtASWODab\naHXsDhVm2Jye+ESLoHMaCLoyCkT3ll8yqXIcEDStMO7fO1Ryag164EiJvSIrMfny\nNL/fXVjCSH /udCxdzPt+7QKBgQC+LAD7rxdr4J9538hTqpc4XK9vxRbrMXEH55XH\nHbMa2xONZXpmeTgEQBukyohCVceyRhK9 i0e6irZTjVXghOeoTpC8VXkzcnzouTiQ\neFQQSGfnp7Ioe6UIz23715pKduzSNkMSKrG924ktv7CyDBF1gBQI5g aDoHnddJBJ\nPRTIZQKBgA8MASXtTxQntRwXXzR92U0vAighiuRkB/mx9jQpUcK1qiqHbkAMqgNF\nPFCBYIUbFT iYKKKeJNbyJQvjfsJCkAnaFJ+RnTxk0Q6Wjm20peJ/ii4QiDdnigoE\nvdlc5cFQewWb4/zqAtPdinkPlN94ileI 79XQdc7RlJ0jpgTimL+V\n-----END RSA PRIVATE KEY-----\n" }, "expiration": 1595955066.0 }
詳細については、「 IoT Core デベロッパーガイド」の「信頼できるユーザーによるプロビジョニングAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateProvisioningClaim
」の「」を参照してください。
-
次の例は、create-provisioning-template-version
を使用する方法を説明しています。
- AWS CLI
-
プロビジョニングテンプレートバージョンを作成するには
次の例では、指定されたプロビジョニングテンプレートのバージョンを作成します。新しいバージョンの本文は、 ファイル で提供されます
template.json
。aws iot create-provisioning-template-version \ --template-name
widget-template
\ --template-bodyfile://template.json
template.json
の内容:{ "Parameters" : { "DeviceLocation": { "Type": "String" } }, "Mappings": { "LocationTable": { "Seattle": { "LocationUrl": "https://example.aws" } } }, "Resources" : { "thing" : { "Type" : "AWS::IoT::Thing", "Properties" : { "AttributePayload" : { "version" : "v1", "serialNumber" : "serialNumber" }, "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]}, "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]}, "ThingGroups" : ["widgets", "WA"], "BillingGroup": "BillingGroup" }, "OverrideSettings" : { "AttributePayload" : "MERGE", "ThingTypeName" : "REPLACE", "ThingGroups" : "DO_NOTHING" } }, "certificate" : { "Type" : "AWS::IoT::Certificate", "Properties" : { "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"}, "Status" : "Active" } }, "policy" : { "Type" : "AWS::IoT::Policy", "Properties" : { "PolicyDocument" : { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action":["iot:Publish"], "Resource": ["arn:aws:iot:us-east-1:123456789012:topic/foo/bar"] }] } } } }, "DeviceConfiguration": { "FallbackUrl": "https://www.example.com/test-site", "LocationUrl": { "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]} } } }
出力:
{ "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "versionId": 2, "isDefaultVersion": false }
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateProvisioningTemplateVersion
」の「」を参照してください。
-
次の例は、create-provisioning-template
を使用する方法を説明しています。
- AWS CLI
-
プロビジョニングテンプレートを作成するには
次の
create-provisioning-template
例では、 ファイル で定義されるプロビジョニングテンプレートを作成しますtemplate.json
。aws iot create-provisioning-template \ --template-name
widget-template
\ --description"A provisioning template for widgets"
\ --provisioning-role-arnarn:aws:iam::123456789012:role/Provision_role
\ --template-bodyfile://template.json
template.json
の内容:{ "Parameters" : { "DeviceLocation": { "Type": "String" } }, "Mappings": { "LocationTable": { "Seattle": { "LocationUrl": "https://example.aws" } } }, "Resources" : { "thing" : { "Type" : "AWS::IoT::Thing", "Properties" : { "AttributePayload" : { "version" : "v1", "serialNumber" : "serialNumber" }, "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]}, "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]}, "ThingGroups" : ["widgets", "WA"], "BillingGroup": "BillingGroup" }, "OverrideSettings" : { "AttributePayload" : "MERGE", "ThingTypeName" : "REPLACE", "ThingGroups" : "DO_NOTHING" } }, "certificate" : { "Type" : "AWS::IoT::Certificate", "Properties" : { "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"}, "Status" : "Active" } }, "policy" : { "Type" : "AWS::IoT::Policy", "Properties" : { "PolicyDocument" : { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action":["iot:Publish"], "Resource": ["arn:aws:iot:us-east-1:504350838278:topic/foo/bar"] }] } } } }, "DeviceConfiguration": { "FallbackUrl": "https://www.example.com/test-site", "LocationUrl": { "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]} } } }
出力:
{ "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "defaultVersionId": 1 }
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateProvisioningTemplate
」の「」を参照してください。
-
次のコード例は、create-role-alias
を使用する方法を示しています。
- AWS CLI
-
ロールエイリアスを作成するには
次の
create-role-alias
例では、指定されたロールLightBulbRole
に というロールエイリアスを作成します。aws iot create-role-alias \ --role-alias
LightBulbRole
\ --role-arnarn:aws:iam::123456789012:role/lightbulbrole-001
出力:
{ "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" }
詳細については、AWS IoT APIリファレンスのCreateRoleAlias「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateRoleAlias
」の「」を参照してください。
-
次の例は、create-scheduled-audit
を使用する方法を説明しています。
- AWS CLI
-
スケジュールされた監査を作成するには
次の
create-scheduled-audit
例では、CA 証明書またはデバイス証明書の有効期限が切れているかどうかを確認するために、毎週水曜日に実行されるスケジュールされた監査を作成します。aws iot create-scheduled-audit \ --scheduled-audit-name
WednesdayCertCheck
\ --frequencyWEEKLY
\ --day-of-weekWED
\ --target-check-namesCA_CERTIFICATE_EXPIRING_CHECK
DEVICE_CERTIFICATE_EXPIRING_CHECK
出力:
{ "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" }
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateScheduledAudit
」の「」を参照してください。
-
次の例は、create-security-profile
を使用する方法を説明しています。
- AWS CLI
-
セキュリティプロファイルを作成するには
次の
create-security-profile
例では、セルラー帯域幅がしきい値を超えているか、または 5 分以内に 10 件を超える認証エラーが発生したかを確認するセキュリティプロファイルを作成します。aws iot create-security-profile \ --security-profile-name
PossibleIssue
\ --security-profile-description"Check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128"
\ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":10},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"出力:
{ "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue" }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateSecurityProfile
」の「」を参照してください。
-
次の例は、create-stream
を使用する方法を説明しています。
- AWS CLI
-
1 つ以上の大きなファイルをチャンクで配信するためのストリームを作成するには MQTT
次の
create-stream
例では、 を介してチャンクで 1 つ以上の大きなファイルを配信するためのストリームを作成しますMQTT。ストリームは、S3 などのソースからのMQTTメッセージとしてパッケージ化されたチャンクまたはブロックでデータバイトを転送します。1 つ以上のファイルをストリームに関連付けることができます。aws iot create-stream \ --cli-input-json
file://create-stream.json
create-stream.json
の内容:{ "streamId": "stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "files": [ { "fileId": 123, "s3Location": { "bucket":"codesign-ota-bucket", "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ], "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" }
出力:
{ "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "streamVersion": "1" }
詳細については、AWS IoT APIリファレンスのCreateStream「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateStream
」の「」を参照してください。
-
次のコード例は、create-thing-group
を使用する方法を示しています。
- AWS CLI
-
例 1: モノのグループを作成するには
次の
create-thing-group
例では、説明と 2 つの属性LightBulbs
を持つ という名前のモノのグループを作成します。aws iot create-thing-group \ --thing-group-name
LightBulbs
\ --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"出力:
{ "thingGroupName": "LightBulbs", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs", "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331" }
例 2: 親グループの一部であるモノのグループを作成するには
次に、 という名前
HalogenBulbs
の親モノグループを持つ という名前のモノグループcreate-thing-group
を作成しますLightBulbs
。aws iot create-thing-group \ --thing-group-name
HalogenBulbs
\ --parent-group-nameLightBulbs
出力:
{ "thingGroupName": "HalogenBulbs", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e" }
詳細については、「 IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateThingGroup
」の「」を参照してください。
-
次のコード例は、create-thing-type
を使用する方法を示しています。
- AWS CLI
-
モノのタイプを定義するには
次の
create-thing-type
例では、モノのタイプと関連する属性を定義します。aws iot create-thing-type \ --thing-type-name
"LightBulb"
\ --thing-type-properties"thingTypeDescription=light bulb type, searchableAttributes=wattage,model"
出力:
{ "thingTypeName": "LightBulb", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190" }
詳細については、IoT デベロッパーガイドの「モノのタイプ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateThingType
」の「」を参照してください。
-
次の例は、create-thing
を使用する方法を説明しています。
- AWS CLI
-
例 1: レジストリにモノのレコードを作成するには
次の
create-thing
例では、 AWS IoT モノのレジストリにデバイスのエントリを作成します。aws iot create-thing \ --thing-name
SampleIoTThing
出力:
{ "thingName": "SampleIoTThing", "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing", "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE " }
例 2: モノのタイプに関連付けられているモノを定義するには
次の
create-thing
例では、指定されたモノのタイプとその属性を持つモノを作成します。aws iot create-thing \ --thing-name
"MyLightBulb"
\ --thing-type-name"LightBulb"
\ --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"出力:
{ "thingName": "MyLightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797" }
詳細については、IoT デベロッパーガイドの「レジストリとモノのタイプでモノを管理する方法」を参照してください。 https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateThing
」の「」を参照してください。
-
次の例は、create-topic-rule-destination
を使用する方法を説明しています。
- AWS CLI
-
トピックルールの送信先を作成するには
次の
create-topic-rule-destination
例では、HTTPエンドポイントのトピックルールの送信先を作成します。aws iot create-topic-rule-destination \ --destination-configuration
httpUrlConfiguration={confirmationUrl=https://example.com}
出力:
{ "topicRuleDestination": { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "IN_PROGRESS", "statusReason": "Awaiting confirmation. Confirmation message sent on 2020-07-09T22:47:54.154Z; no response received from the endpoint.", "httpUrlProperties": { "confirmationUrl": "https://example.com" } } }
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先の作成」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateTopicRuleDestination
」の「」を参照してください。
-
次のコード例は、create-topic-rule
を使用する方法を示しています。
- AWS CLI
-
Amazon SNSアラートを送信するルールを作成するには
次の
create-topic-rule
例では、デバイスシャドウにある土壌湿度レベルの測定値が低い場合に Amazon SNS メッセージを送信するルールを作成します。aws iot create-topic-rule \ --rule-name
"LowMoistureRule"
\ --topic-rule-payloadfile://plant-rule.json
この例では、次のJSONコードを という名前のファイルに保存する必要があります
plant-rule.json
。{ "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n", "description": "Sends an alert whenever soil moisture level readings are too low.", "ruleDisabled": false, "awsIotSqlVersion": "2016-03-23", "actions": [{ "sns": { "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", "messageFormat": "RAW" } }] }
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「IoT ルールの作成AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateTopicRule
」の「」を参照してください。
-
次の例は、delete-account-audit-configuration
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントのすべての監査チェックを無効にするには
次の
delete-account-audit-configuration
例では、このアカウントの AWS IoT Device Defender のデフォルト設定を復元し、すべての監査チェックを無効にして設定データを消去します。また、このアカウントのスケジュールされた監査も削除されます。このコマンドは慎重に使用してください。aws iot delete-account-audit-configuration \ --delete-scheduled-audits
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteAccountAuditConfiguration
」の「」を参照してください。
-
次のコード例は、delete-audit-suppression
を使用する方法を示しています。
- AWS CLI
-
監査結果の抑制を削除するには
次の
delete-audit-suppression
例では、DEVICE_CERTIFICATE_EXPIRING_ の監査結果抑制を削除しますCHECK。aws iot delete-audit-suppression \ --check-name
DEVICE_CERTIFICATE_EXPIRING_CHECK
\ --resource-identifier deviceCertificateId="c7691e<shortened>"このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「監査結果の抑制」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteAuditSuppression
」の「」を参照してください。
-
次の例は、delete-authorizer
を使用する方法を説明しています。
- AWS CLI
-
カスタムオーソライザーを削除するには
次の
delete-authorizer
例では、 という名前のオーソライザーを削除しますCustomAuthorizer
。カスタムオーソライザーは、削除する前にINACTIVE
状態にある必要があります。aws iot delete-authorizer \ --authorizer-name
CustomAuthorizer
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイドDeleteAuthorizer」の「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteAuthorizer
」の「」を参照してください。
-
次のコード例は、delete-billing-group
を使用する方法を示しています。
- AWS CLI
-
請求グループを削除するには
次の
delete-billing-group
例では、指定された請求グループを削除します。請求グループには 1 つ以上のモノが含まれている場合でも、削除できます。aws iot delete-billing-group \ --billing-group-name
BillingGroupTwo
このコマンドでは、出力が生成されません。
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteBillingGroup
」の「」を参照してください。
-
次の例は、delete-ca-certificate
を使用する方法を説明しています。
- AWS CLI
-
CA 証明書を削除するには
次の
delete-ca-certificate
例では、指定された証明書 ID を持つ CA 証明書を削除します。aws iot delete-ca-certificate \ --certificate-id
f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467
このコマンドでは何も出力されません。
詳細については、IoT リファレンス の「DeleteCACertificate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteCaCertificate
」の「」を参照してください。
-
次の例は、delete-certificate
を使用する方法を説明しています。
- AWS CLI
-
デバイス証明書を削除するには
次の
delete-certificate
例では、指定された ID のデバイス証明書を削除します。aws iot delete-certificate \ --certificate-id
c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9
このコマンドでは何も出力されません。
詳細については、AWS IoT APIリファレンスのDeleteCertificate「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteCertificate
」の「」を参照してください。
-
次の例は、delete-custom-metric
を使用する方法を説明しています。
- AWS CLI
-
カスタムメトリクスを削除するには
次の
delete-custom-metric
例では、カスタムメトリクスを削除します。aws iot delete-custom-metric \ --metric-name
batteryPercentage
\ --regionus-east-1
出力:
HTTP 200
詳細については、「 IoT Core デベロッパーガイド」の「カスタムメトリクス」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteCustomMetric
」の「」を参照してください。
-
次の例は、delete-dimension
を使用する方法を説明しています。
- AWS CLI
-
ディメンションを削除するには
次の
delete-dimension
例では、 というディメンションを削除しますTopicFilterForAuthMessages
。aws iot delete-dimension \ --name
TopicFilterForAuthMessages
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteDimension
」の「」を参照してください。
-
次の例は、delete-domain-configuration
を使用する方法を説明しています。
- AWS CLI
-
ドメイン設定を削除するには
次の
delete-domain-configuration
例では、 という名前のドメイン設定を AWS アカウントadditionalDataDomain
から削除します。aws iot delete-domain-configuration \ --domain-configuration-name
"additionalDataDomain"
\ --domain-configuration-status"OK"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「設定可能なエンドポイント」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteDomainConfiguration
」の「」を参照してください。
-
次の例は、delete-dynamic-thing-group
を使用する方法を説明しています。
- AWS CLI
-
動的モノのグループを削除するには
次の
delete-dynamic-thing-group
例では、指定された動的モノのグループを削除します。aws iot delete-dynamic-thing-group \ --thing-group-name
"RoomTooWarm"
このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「Dynamic Thing Groups」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteDynamicThingGroup
」の「」を参照してください。
-
次のコード例は、delete-job-execution
を使用する方法を示しています。
- AWS CLI
-
ジョブ実行を削除するには
次の
delete-job-execution
例では、デバイス上の指定されたジョブのジョブ実行を削除します。describe-job-execution
を使用して実行番号を取得します。aws iot delete-job-execution --job-id
"example-job-02"
--thing-name"MyRaspberryPi"
--execution-number1
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteJobExecution
」の「」を参照してください。
-
次の例は、delete-job
を使用する方法を説明しています。
- AWS CLI
-
ジョブを削除するには
次の
delete-job
例では、指定されたジョブを削除します。--force
オプションを指定することで、ステータスが であってもジョブは削除されますIN_PROGRESS
。aws iot delete-job \ --job-id
"example-job-04"
\ --forceこのコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteJob
」の「」を参照してください。
-
次のコード例は、delete-mitigation-action
を使用する方法を示しています。
- AWS CLI
-
緩和アクションを削除するには
次の
delete-mitigation-action
例では、指定された緩和アクションを削除します。aws iot delete-mitigation-action \ --action-name
AddThingsToQuarantineGroup1Action
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドのDeleteMitigationAction 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteMitigationAction
」の「」を参照してください。
-
次のコード例は、delete-ota-update
を使用する方法を示しています。
- AWS CLI
-
OTA 更新を削除するには
次の
delete-ota-update
例では、指定されたOTA更新を削除します。aws iot delete-ota-update \ --ota-update-id
ota12345
\ --delete-stream \ --force-delete-aws-jobこのコマンドでは何も出力されません。
詳細については、IoT リファレンス の「DeleteOTAUpdate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteOtaUpdate
」の「」を参照してください。
-
次の例は、delete-policy-version
を使用する方法を説明しています。
- AWS CLI
-
ポリシーのバージョンを削除するには
次の
delete-policy-version
例では、指定されたポリシーのバージョン 2 を AWS アカウントから削除します。aws iot delete-policy-version \ --policy-name
UpdateDeviceCertPolicy
\ --policy-version-id2
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「IoT ポリシー」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeletePolicyVersion
」の「」を参照してください。
-
次のコード例は、delete-policy
を使用する方法を示しています。
- AWS CLI
-
ポリシーを削除するには
次の
delete-policy
例では、指定されたポリシーを AWS アカウントから削除します。aws iot delete-policy --policy-name
UpdateDeviceCertPolicy
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeletePolicy
」の「」を参照してください。
-
次のコード例は、delete-provisioning-template-version
を使用する方法を示しています。
- AWS CLI
-
プロビジョニングテンプレートのバージョンを削除するには
次の
delete-provisioning-template-version
例では、指定されたプロビジョニングテンプレートのバージョン 2 を削除します。aws iot delete-provisioning-template-version \ --version-id
2
\ --template-name"widget-template"
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteProvisioningTemplateVersion
」の「」を参照してください。
-
次の例は、delete-provisioning-template
を使用する方法を説明しています。
- AWS CLI
-
プロビジョニングテンプレートを削除するには
次の
delete-provisioning-template
例では、指定されたプロビジョニングテンプレートを削除します。aws iot delete-provisioning-template \ --template-name
widget-template
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteProvisioningTemplate
」の「」を参照してください。
-
次の例は、delete-registration-code
を使用する方法を説明しています。
- AWS CLI
-
登録コードを削除するには
次の
delete-registration-code
例では、 AWS IoT アカウント固有の登録コードを削除します。aws iot delete-registration-code
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「独自の証明書を使用する」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteRegistrationCode
」の「」を参照してください。
-
次の例は、delete-role-alias
を使用する方法を説明しています。
- AWS CLI
-
AWS IoT ロールエイリアスを削除するには
次の
delete-role-alias
例では、 という名前の AWS IoT ロールエイリアスを削除しますLightBulbRole
。aws iot delete-role-alias \ --role-alias
LightBulbRole
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイド」のAWS 「サービスへの直接呼び出しの承認」を参照してください。
-
API 詳細については、「 コマンドリファレンスDeleteRoleAlias
」の「」を参照してください。 AWS CLI
-
次の例は、delete-scheduled-audit
を使用する方法を説明しています。
- AWS CLI
-
スケジュールされた監査を削除するには
次の
delete-scheduled-audit
例では、 という名前の AWS IoT Device Defender スケジュールされた監査を削除しますAWSIoTDeviceDefenderDailyAudit
。aws iot delete-scheduled-audit \ --scheduled-audit-name
AWSIoTDeviceDefenderDailyAudit
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、「 コマンドリファレンスDeleteScheduledAudit
」の「」を参照してください。 AWS CLI
-
次の例は、delete-security-profile
を使用する方法を説明しています。
- AWS CLI
-
セキュリティプロファイルを削除するには
次の
delete-security-profile
例では、 という名前のセキュリティプロファイルを削除しますPossibleIssue
。aws iot delete-security-profile \ --security-profile-name
PossibleIssue
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteSecurityProfile
」の「」を参照してください。
-
次の例は、delete-stream
を使用する方法を説明しています。
- AWS CLI
-
ストリームを削除するには
次の
delete-stream
例では、指定されたストリームを削除します。aws iot delete-stream \ --stream-id
stream12345
このコマンドでは何も出力されません。
詳細については、AWS IoT APIリファレンスのDeleteStream「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteStream
」の「」を参照してください。
-
次のコード例は、delete-thing-group
を使用する方法を示しています。
- AWS CLI
-
モノのグループを削除するには
次の
delete-thing-group
例では、指定されたモノのグループを削除します。モノの子グループが含まれている場合、モノのグループを削除することはできません。aws iot delete-thing-group \ --thing-group-name
DefectiveBulbs
このコマンドでは何も出力されません。
詳細については、「 IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteThingGroup
」の「」を参照してください。
-
次の例は、delete-thing-type
を使用する方法を説明しています。
- AWS CLI
-
例 1: モノのタイプを削除するには
次の
delete-thing-type
例では、非推奨のモノのタイプを削除します。aws iot delete-thing-type \ --thing-type-name
"obsoleteThingType"
このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「モノのタイプ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteThingType
」の「」を参照してください。
-
次のコード例は、delete-thing
を使用する方法を示しています。
- AWS CLI
-
モノに関する詳細情報を表示するには
次の
delete-thing
例では、 AWS アカウントの AWS IoT レジストリからモノを削除します。aws iot delete-thing --thing-nameFourthBulb「」
このコマンドでは何も出力されません。
詳細については、「AWS IoT ディベロッパーガイド」の「レジストリによるモノの管理方法」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteThing
」の「」を参照してください。
-
次のコード例は、delete-topic-rule-destination
を使用する方法を示しています。
- AWS CLI
-
トピックルールの送信先を削除するには
次の
delete-topic-rule-destination
例では、指定されたトピックルールの送信先を削除します。aws iot delete-topic-rule-destination \ --arn
"arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先の削除」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteTopicRuleDestination
」の「」を参照してください。
-
次の例は、delete-topic-rule
を使用する方法を説明しています。
- AWS CLI
-
ルールを削除するには
次の
delete-topic-rule
例では、指定されたルールを削除します。aws iot delete-topic-rule \ --rule-name
"LowMoistureRule"
このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「ルールの削除」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteTopicRule
」の「」を参照してください。
-
次の例は、delete-v2-logging-level
を使用する方法を説明しています。
- AWS CLI
-
モノのグループのログ記録レベルを削除するには
次の
delete-v2-logging-level
例では、指定されたモノのグループのログ記録レベルを削除します。aws iot delete-v2-logging-level \ --target-type
THING_GROUP
\ --target-nameLightBulbs
このコマンドでは何も出力されません。
-
API 詳細については、「 コマンドリファレンス」のDeleteV2LoggingLevel
」を参照してください。 AWS CLI
-
次の例は、deprecate-thing-type
を使用する方法を説明しています。
- AWS CLI
-
例 1: モノのタイプを非推奨にするには
次の
deprecate-thing-type
例では、ユーザーが新しいモノを関連付けられないように、モノのタイプを廃止しています。aws iot deprecate-thing-type \ --thing-type-name
"obsoleteThingType"
このコマンドでは何も出力されません。
例 2: モノのタイプの非推奨を元に戻すには
次の
deprecate-thing-type
例では、モノタイプの非推奨化を取り消し、ユーザーが新しいモノを再度関連付けることができます。aws iot deprecate-thing-type \ --thing-type-name
"obsoleteThingType"
\ --undo-deprecateこのコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「モノのタイプ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeprecateThingType
」の「」を参照してください。
-
次のコード例は、describe-account-audit-configuration
を使用する方法を示しています。
- AWS CLI
-
現在の監査設定を表示するには
次の
describe-account-audit-configuration
例では、 AWS IoT Device Defender 監査設定の現在の設定を一覧表示します。aws iot describe-account-audit-configuration
出力:
{ "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit_1551201085996", "auditNotificationTargetConfigurations": { "SNS": { "targetArn": "arn:aws:sns:us-west-2:123456789012:ddaudits", "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit", "enabled": true } }, "auditCheckConfigurations": { "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { "enabled": true }, "CA_CERTIFICATE_EXPIRING_CHECK": { "enabled": true }, "CONFLICTING_CLIENT_IDS_CHECK": { "enabled": true }, "DEVICE_CERTIFICATE_EXPIRING_CHECK": { "enabled": true }, "DEVICE_CERTIFICATE_SHARED_CHECK": { "enabled": true }, "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { "enabled": true }, "LOGGING_DISABLED_CHECK": { "enabled": true }, "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { "enabled": true }, "REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK": { "enabled": true }, "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { "enabled": true } } }
詳細については、AWS IoT デベロッパーガイドの「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAccountAuditConfiguration
」の「」を参照してください。
-
次の例は、describe-audit-finding
を使用する方法を説明しています。
- AWS CLI
-
監査結果の詳細を一覧表示するには
次の
describe-audit-finding
例では、指定された AWS IoT Device Defender 監査結果の詳細を一覧表示します。監査は複数の検出結果を生成できます。list-audit-findings
コマンドを使用して、監査から検出結果のリストを取得し、 を取得しますfindingId
。aws iot describe-audit-finding \ --finding-id
"ef4826b8-e55a-44b9-b460-5c485355371b"
出力:
{ "finding": { "findingId": "ef4826b8-e55a-44b9-b460-5c485355371b", "taskId": "873ed69c74a9ec8fa9b8e88e9abc4661", "checkName": "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", "taskStartTime": 1576012045.745, "findingTime": 1576012046.168, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "IOT_POLICY", "resourceIdentifier": { "policyVersionIdentifier": { "policyName": "smp-ggrass-group_Core-policy", "policyVersionId": "1" } } }, "reasonForNonCompliance": "Policy allows broad access to IoT data plane actions: [iot:Subscribe, iot:Connect, iot:GetThingShadow, iot:DeleteThingShadow, iot:UpdateThingShadow, iot:Publish].", "reasonForNonComplianceCode": "ALLOWS_BROAD_ACCESS_TO_IOT_DATA_PLANE_ACTIONS" } }
詳細については、AWS IoT デベロッパーガイドの「監査結果の確認 (監査コマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAuditFinding
」の「」を参照してください。
-
次のコード例は、describe-audit-mitigation-actions-task
を使用する方法を示しています。
- AWS CLI
-
監査緩和アクションタスクの詳細を表示するには
次の
describe-audit-mitigation-actions-task
例は、 が検出結果に適用ResetPolicyVersionAction
された、指定されたタスクの詳細を示しています。結果には、タスクの開始と終了のタイミング、ターゲットとなった結果の数 (および結果)、このタスクの一部として適用されるアクションの定義が含まれます。aws iot describe-audit-mitigation-actions-task \ --task-id
ResetPolicyTask01
出力:
{ "taskStatus": "COMPLETED", "startTime": "2019-12-10T15:13:19.457000-08:00", "endTime": "2019-12-10T15:13:19.947000-08:00", "taskStatistics": { "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { "totalFindingsCount": 1, "failedFindingsCount": 0, "succeededFindingsCount": 1, "skippedFindingsCount": 0, "canceledFindingsCount": 0 } }, "target": { "findingIds": [ "ef4826b8-e55a-44b9-b460-5c485355371b" ] }, "auditCheckToActionsMapping": { "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": [ "ResetPolicyVersionAction" ] }, "actionsDefinition": [ { "name": "ResetPolicyVersionAction", "id": "1ea0b415-bef1-4a01-bd13-72fb63c59afb", "roleArn": "arn:aws:iam::123456789012:role/service-role/ReplacePolicyVersionRole", "actionParams": { "replaceDefaultPolicyVersionParams": { "templateName": "BLANK_POLICY" } } } ] }
詳細については、AWS IoT デベロッパーガイドのDescribeAuditMitigationActionsTask 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAuditMitigationActionsTask
」の「」を参照してください。
-
次の例は、describe-audit-suppression
を使用する方法を説明しています。
- AWS CLI
-
監査結果の抑制に関する詳細を取得するには
次の
describe-audit-suppression
例では、監査結果の抑制の詳細を一覧表示します。aws iot describe-audit-task \ --task-id
"787ed873b69cb4d6cdbae6ddd06996c5"
出力:
{ "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK", "taskStartTime": 1596168096.157, "taskStatistics": { "totalChecks": 1, "inProgressChecks": 0, "waitingForDataCollectionChecks": 0, "compliantChecks": 0, "nonCompliantChecks": 1, "failedChecks": 0, "canceledChecks": 0 }, "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", "auditDetails": { "DEVICE_CERTIFICATE_EXPIRING_CHECK": { "checkRunStatus": "COMPLETED_NON_COMPLIANT", "checkCompliant": false, "totalResourcesCount": 195, "nonCompliantResourcesCount": 2 } } }
詳細については、「 IoT デベロッパーガイド」の「監査結果の抑制AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAuditSuppression
」の「」を参照してください。
-
次のコード例は、describe-audit-task
を使用する方法を示しています。
- AWS CLI
-
監査インスタンスに関する情報を取得するには
次の
describe-audit-task
例では、 AWS IoT Device Defender 監査のインスタンスに関する情報を取得します。監査が完了すると、実行のサマリー統計が結果に含まれます。aws iot describe-audit-task \ --task-id
a3aea009955e501a31b764abe1bebd3d
出力:
{ "taskStatus": "COMPLETED", "taskType": "ON_DEMAND_AUDIT_TASK", "taskStartTime": 1560356923.434, "taskStatistics": { "totalChecks": 3, "inProgressChecks": 0, "waitingForDataCollectionChecks": 0, "compliantChecks": 3, "nonCompliantChecks": 0, "failedChecks": 0, "canceledChecks": 0 }, "auditDetails": { "CA_CERTIFICATE_EXPIRING_CHECK": { "checkRunStatus": "COMPLETED_COMPLIANT", "checkCompliant": true, "totalResourcesCount": 0, "nonCompliantResourcesCount": 0 }, "DEVICE_CERTIFICATE_EXPIRING_CHECK": { "checkRunStatus": "COMPLETED_COMPLIANT", "checkCompliant": true, "totalResourcesCount": 6, "nonCompliantResourcesCount": 0 }, "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { "checkRunStatus": "COMPLETED_COMPLIANT", "checkCompliant": true, "totalResourcesCount": 0, "nonCompliantResourcesCount": 0 } } }
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAuditTask
」の「」を参照してください。
-
次の例は、describe-authorizer
を使用する方法を説明しています。
- AWS CLI
-
カスタムオーソライザーに関する情報を取得するには
次の
describe-authorizer
例では、指定されたカスタムオーソライザーの詳細を表示します。aws iot describe-authorizer \ --authorizer-name
CustomAuthorizer
出力:
{ "authorizerDescription": { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer", "authorizerFunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction", "tokenKeyName": "MyAuthToken", "tokenSigningPublicKeys": { "FIRST_KEY": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo\nZ+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y\nZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p\nzwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ\n+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx\n50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1\nlQIDAQAB\n-----END PUBLIC KEY-----" }, "status": "ACTIVE", "creationDate": 1571245658.069, "lastModifiedDate": 1571245658.069 } }
詳細については、 AWS IoT APIリファレンスのDescribeAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAuthorizer
」の「」を参照してください。
-
次の例は、describe-billing-group
を使用する方法を説明しています。
- AWS CLI
-
請求グループに関する情報を取得するには
次の
describe-billing-group
例では、指定された請求グループの情報を取得します。aws iot describe-billing-group --billing-group-name
GroupOne
出力:
{ "billingGroupName": "GroupOne", "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562", "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", "version": 1, "billingGroupProperties": {}, "billingGroupMetadata": { "creationDate": 1560199355.378 } }
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeBillingGroup
」の「」を参照してください。
-
次の例は、describe-ca-certificate
を使用する方法を説明しています。
- AWS CLI
-
CA 証明書の詳細を取得するには
次の
describe-ca-certificate
例では、指定された CA 証明書の詳細を表示します。aws iot describe-ca-certificate \ --certificate-id
f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467
出力:
{ "certificateDescription": { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "status": "INACTIVE", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIICzzCCAbegEXAMPLEJANVEPWXl8taPMA0GCSqGSIb3DQEBBQUAMB4xCzAJBgNV\nBAYTAlVTMQ8wDQYDVQQKDAZBbWF6b24wHhcNMTkwOTI0MjEzMTE1WhcNMjkwOTIx\nMjEzMTE1WjAeMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGQW1hem9uMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzd3R3ioalCS0MhFWfBrVGR036EK07UAf\nVdz9EXAMPLE1VczICbADnATK522kEIB51/18VzlFtAhQL5V5eybXKnB7QebNer5m\n4Yibx7shR5oqNzFsrXWxuugN5+w5gEfqNMawOjhF4LsculKG49yuqjcDU19/13ua\n3B2gxs1Pe7TiWWvUskzxnbO1F2WCshbEJvqY8fIWtGYCjTeJAgQ9hvZx/69XhKen\nwV9LJwOQxrsUS0Ty8IHwbB8fRy72VM3u7fJoaU+nO4jD5cqaoEPtzoeFUEXAMPLE\nyVAJpqHwgbYbcUfn7V+AB6yh1+0Fa1rEQGuZDPGyJslxwr5vh8nRewIDAQABoxAw\nDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQA+3a5CV3IJgOnd0AgI\nBgVMtmYzTvqAngx26aG9/spvCjXckh2SBF+EcBlCFwH1yakwjJL1dR4yarnrfxgI\nEqP4AOYVimAVoQ5FBwnloHe16+3qtDiblU9DeXBUCtS55EcfrEXAMPLEYtXdqU5C\nU9ia4KAjV0dxW1+EFYMwX5eGeb0gDTNHBylV6B/fOSZiQAwDYp4x3B+gAP+a/bWB\nu1umOqtBdWe6L6/83L+JhaTByqV25iVJ4c/UZUnG8926wUlDM9zQvEXuEVvzZ7+m\n4PSNqst/nVOvnLpoG4e0WgcJgANuB33CSWtjWSuYsbhmqQRknGhREXAMPLEZT4fm\nfo0e\n-----END CERTIFICATE-----\n", "ownedBy": "123456789012", "creationDate": 1569365372.053, "autoRegistrationStatus": "DISABLE", "lastModifiedDate": 1569365372.053, "customerVersion": 1, "generationId": "c5c2eb95-140b-4f49-9393-6aaac85b2a90", "validity": { "notBefore": 1569360675.0, "notAfter": 1884720675.0 } } }
詳細については、IoT リファレンス の「DescribeCACertificate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeCaCertificate
」の「」を参照してください。
-
次の例は、describe-certificate
を使用する方法を説明しています。
- AWS CLI
-
証明書に関する情報を取得するには
次の
describe-certificate
例では、指定された証明書の詳細を表示します。aws iot describe-certificate \ --certificate-id
"4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e"
出力:
{ "certificateDescription": { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "status": "ACTIVE", "certificatePem": "-----BEGIN CERTIFICATE----- MIICiTEXAMPLEQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBEXAMPLEMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDEXAMPLElMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5EXAMPLEcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNEXAMPLEdBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBEXAMPLEz b2xEXAMPLEYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8EXAMPLEZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYEXAMPLEpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7EXAMPLEGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFEXAMPLEAtCu4 nUhVVxYUnEXAMPLE8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----", "ownedBy": "123456789012", "creationDate": 1541022751.983, "lastModifiedDate": 1541022751.983, "customerVersion": 1, "transferData": {}, "generationId": "6974fbed-2e61-4114-bc5e-4204cc79b045", "validity": { "notBefore": 1541022631.0, "notAfter": 2524607999.0 } } }
詳細については、AWS IoT APIリファレンスのDescribeCertificate「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeCertificate
」の「」を参照してください。
-
次のコード例は、describe-custom-metric
を使用する方法を示しています。
- AWS CLI
-
Device Defender カスタムメトリクスに関する情報を取得するには
次の
describe-custom-metric
例では、 という名前のカスタムメトリクスに関する情報を取得しますmyCustomMetric
。aws iot describe-custom-metric \ --metric-name
myCustomMetric
出力:
{ "metricName": "myCustomMetric", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/myCustomMetric", "metricType": "number", "displayName": "My custom metric", "creationDate": 2020-11-17T23:02:12.879000-09:00, "lastModifiedDate": 2020-11-17T23:02:12.879000-09:00 }
詳細については、「 IoT Core デベロッパーガイド」の「カスタムメトリクス」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeCustomMetric
」の「」を参照してください。
-
次の例は、describe-default-authorizer
を使用する方法を説明しています。
- AWS CLI
-
デフォルトのカスタムオーソライザーに関する情報を取得するには
次の
describe-default-authorizer
例では、デフォルトのカスタムオーソライザーの詳細を表示します。aws iot describe-default-authorizer
出力:
{ "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" }
詳細については、 AWS IoT APIリファレンスのDescribeDefaultAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeDefaultAuthorizer
」の「」を参照してください。
-
次の例は、describe-dimension
を使用する方法を説明しています。
- AWS CLI
-
ディメンションに関する情報を取得するには
次の
describe-dimension
例では、 という名前のディメンションに関する情報を取得しますTopicFilterForAuthMessages
。aws iot describe-dimension \ --name
TopicFilterForAuthMessages
出力:
{ "name": "TopicFilterForAuthMessages", "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages", "type": "TOPIC_FILTER", "stringValues": [ "device/+/auth" ], "creationDate": 1578620223.255, "lastModifiedDate": 1578620223.255 }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeDimension
」の「」を参照してください。
-
次のコード例は、describe-domain-configuration
を使用する方法を示しています。
- AWS CLI
-
ドメイン設定を記述するには
次の
describe-domain-configuration
例では、指定されたドメイン設定の詳細を表示します。aws iot describe-domain-configuration \ --domain-configuration-name
"additionalDataDomain"
出力:
{ "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-east-1:758EXAMPLE143:domainconfiguration/additionalDataDomain/norpw", "domainName": "d055exampleed74y71zfd-ats.beta.us-east-1.iot.amazonaws.com", "serverCertificates": [], "domainConfigurationStatus": "ENABLED", "serviceType": "DATA", "domainType": "AWS_MANAGED", "lastStatusChangeDate": 1601923783.774 }
詳細については、AWS IoT デベロッパーガイドの「設定可能なエンドポイント」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeDomainConfiguration
」の「」を参照してください。
-
次の例は、describe-endpoint
を使用する方法を説明しています。
- AWS CLI
-
例 1: 現在の AWS エンドポイントを取得するには
次の
describe-endpoint
例では、すべてのコマンドが適用されるデフォルトの AWS エンドポイントを取得します。aws iot describe-endpoint
出力:
{ "endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com" }
詳細については、AWS 「 IoT デベロッパーガイドDescribeEndpoint」の「」を参照してください。
例 2: ATSエンドポイントを取得するには
次の
describe-endpoint
例では、Amazon Trust Services (ATS) エンドポイントを取得します。aws iot describe-endpoint \ --endpoint-type
iot:Data-ATS
出力:
{ "endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com" }
詳細については、AWS IoT デベロッパーガイドの「X.509 証明書と AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEndpoint
」の「」を参照してください。
-
次の例は、describe-event-configurations
を使用する方法を説明しています。
- AWS CLI
-
公開されるイベントタイプを表示するには
次の
describe-event-configurations
例では、何かを追加、更新、または削除したときに生成されるイベントを制御する設定を一覧表示します。aws iot describe-event-configurations
出力:
{ "eventConfigurations": { "CA_CERTIFICATE": { "Enabled": false }, "CERTIFICATE": { "Enabled": false }, "JOB": { "Enabled": false }, "JOB_EXECUTION": { "Enabled": false }, "POLICY": { "Enabled": false }, "THING": { "Enabled": false }, "THING_GROUP": { "Enabled": false }, "THING_GROUP_HIERARCHY": { "Enabled": false }, "THING_GROUP_MEMBERSHIP": { "Enabled": false }, "THING_TYPE": { "Enabled": false }, "THING_TYPE_ASSOCIATION": { "Enabled": false } } }
詳細については、AWS IoT デベロッパーガイドの「イベントメッセージ」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEventConfigurations
」の「」を参照してください。
-
次の例は、describe-index
を使用する方法を説明しています。
- AWS CLI
-
モノインデックスの現在のステータスを取得するには
次の
describe-index
例では、モノインデックスの現在のステータスを取得します。aws iot describe-index \ --index-name
"AWS_Things"
出力:
{ "indexName": "AWS_Things", "indexStatus": "ACTIVE", "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS" }
詳細については、AWS IoT デベロッパーガイドの「モノのインデックス作成の管理」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeIndex
」の「」を参照してください。
-
次の例は、describe-job-execution
を使用する方法を説明しています。
- AWS CLI
-
デバイス上のジョブの実行の詳細を取得するには
次の
describe-job-execution
例では、指定されたジョブの実行の詳細を取得します。aws iot describe-job-execution \ --job-id
"example-job-01"
\ --thing-name"MyRaspberryPi"
出力:
{ "execution": { "jobId": "example-job-01", "status": "QUEUED", "statusDetails": {}, "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi", "queuedAt": 1560787023.636, "lastUpdatedAt": 1560787023.636, "executionNumber": 1, "versionNumber": 1 } }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeJobExecution
」の「」を参照してください。
-
次の例は、describe-job
を使用する方法を説明しています。
- AWS CLI
-
ジョブの詳細なステータスを取得するには
次の
describe-job
例では、ID が のジョブの詳細ステータスを取得しますexample-job-01
。aws iot describe-job \ --job-id
"example-job-01"
出力:
{ "job": { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "targetSelection": "SNAPSHOT", "status": "IN_PROGRESS", "targets": [ "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" ], "description": "example job test", "presignedUrlConfig": {}, "jobExecutionsRolloutConfig": {}, "createdAt": 1560787022.733, "lastUpdatedAt": 1560787026.294, "jobProcessDetails": { "numberOfCanceledThings": 0, "numberOfSucceededThings": 0, "numberOfFailedThings": 0, "numberOfRejectedThings": 0, "numberOfQueuedThings": 1, "numberOfInProgressThings": 0, "numberOfRemovedThings": 0, "numberOfTimedOutThings": 0 }, "timeoutConfig": {} } }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeJob
」の「」を参照してください。
-
次のコード例は、describe-mitigation-action
を使用する方法を示しています。
- AWS CLI
-
定義された緩和アクションの詳細を表示するには
次の
describe-mitigation-action
例では、指定された緩和アクションの詳細を表示します。aws iot describe-mitigation-action \ --action-name
AddThingsToQuarantineGroupAction
出力:
{ "actionName": "AddThingsToQuarantineGroupAction", "actionType": "ADD_THINGS_TO_THING_GROUP", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa", "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole", "actionParams": { "addThingsToThingGroupParams": { "thingGroupNames": [ "QuarantineGroup1" ], "overrideDynamicGroups": true } }, "creationDate": "2019-12-10T11:09:35.999000-08:00", "lastModifiedDate": "2019-12-10T11:09:35.999000-08:00" }
詳細については、AWS IoT デベロッパーガイドのDescribeMitigationAction 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeMitigationAction
」の「」を参照してください。
-
次の例は、describe-provisioning-template-version
を使用する方法を説明しています。
- AWS CLI
-
プロビジョニングテンプレートのバージョンを記述するには
次の
describe-provisioning-template-version
例では、プロビジョニングテンプレートのバージョンについて説明します。aws iot describe-provisioning-template-version \ --template-name
MyTestProvisioningTemplate
\ --version-id1
出力:
{ "versionId": 1, "creationDate": 1589308310.574, "templateBody": "{ \"Parameters\":{ \"SerialNumber\":{ \"Type\":\"String\" }, \"AWS::IoT::Certificate::Id\":{ \"Type\":\"String\" } }, \"Resources\":{ \"certificate\":{ \"Properties\":{ \"CertificateId\":{ \"Ref\":\"AWS::IoT::Certificate::Id\" }, \"Status\":\"Active\" }, \"Type\":\"AWS::IoT::Certificate\" }, \"policy\":{ \"Properties\":{ \"PolicyName\":\"MyIotPolicy\" }, \"Type\":\"AWS::IoT::Policy\" }, \"thing\":{ \"OverrideSettings\":{ \"AttributePayload\":\"MERGE\", \"ThingGroups\":\"DO_NOTHING\", \"ThingTypeName\":\"REPLACE\" }, \"Properties\":{ \"AttributePayload\":{}, \"ThingGroups\":[], \"ThingName\":{ \"Fn::Join\":[ \"\", [ \"DemoGroup_\", {\"Ref\":\"SerialNumber\"} ] ] }, \"ThingTypeName\":\"VirtualThings\" }, \"Type\":\"AWS::IoT::Thing\" } } }", "isDefaultVersion": true }
詳細については、「 IoT Core デベロッパーガイド」の「フリートプロビジョニングを使用したデバイス証明書がないデバイスのプロビジョニング」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeProvisioningTemplateVersion
」の「」を参照してください。
-
次のコード例は、describe-provisioning-template
を使用する方法を示しています。
- AWS CLI
-
プロビジョニングテンプレートを記述するには
次の
describe-provisioning-template
例では、プロビジョニングテンプレートについて説明します。aws iot describe-provisioning-template \ --template-name
MyTestProvisioningTemplate
出力:
{ "templateArn": "arn:aws:iot:us-west-2:57EXAMPLE833:provisioningtemplate/MyTestProvisioningTemplate", "templateName": "MyTestProvisioningTemplate", "creationDate": 1589308310.574, "lastModifiedDate": 1589308345.539, "defaultVersionId": 1, "templateBody": "{ \"Parameters\":{ \"SerialNumber\":{ \"Type\":\"String\" }, \"AWS::IoT::Certificate::Id\":{ \"Type\":\"String\" } }, \"Resources\":{ \"certificate\":{ \"Properties\":{ \"CertificateId\":{ \"Ref\":\"AWS::IoT::Certificate::Id\" }, \"Status\":\"Active\" }, \"Type\":\"AWS::IoT::Certificate\" }, \"policy\":{ \"Properties\":{ \"PolicyName\":\"MyIotPolicy\" }, \"Type\":\"AWS::IoT::Policy\" }, \"thing\":{ \"OverrideSettings\":{ \"AttributePayload\":\"MERGE\", \"ThingGroups\":\"DO_NOTHING\", \"ThingTypeName\":\"REPLACE\" }, \"Properties\":{ \"AttributePayload\":{}, \"ThingGroups\":[], \"ThingName\":{ \"Fn::Join\":[ \"\", [ \"DemoGroup_\", {\"Ref\":\"SerialNumber\"} ] ] }, \"ThingTypeName\":\"VirtualThings\" }, \"Type\":\"AWS::IoT::Thing\" } } }", "enabled": true, "provisioningRoleArn": "arn:aws:iam::571032923833:role/service-role/IoT_access" }
詳細については、「 IoT Core デベロッパーガイド」の「フリートプロビジョニングを使用したデバイス証明書がないデバイスのプロビジョニング」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeProvisioningTemplate
」の「」を参照してください。
-
次のコード例は、describe-role-alias
を使用する方法を示しています。
- AWS CLI
-
AWS IoT ロールエイリアスに関する情報を取得するには
次の
describe-role-alias
例では、指定されたロールエイリアスの詳細を表示します。aws iot describe-role-alias \ --role-alias
LightBulbRole
出力:
{ "roleAliasDescription": { "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole", "roleArn": "arn:aws:iam::123456789012:role/light_bulb_role_001", "owner": "123456789012", "credentialDurationSeconds": 3600, "creationDate": 1570558643.221, "lastModifiedDate": 1570558643.221 } }
詳細については、AWS IoT APIリファレンスのDescribeRoleAlias「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeRoleAlias
」の「」を参照してください。
-
次のコード例は、describe-scheduled-audit
を使用する方法を示しています。
- AWS CLI
-
スケジュールされた監査に関する情報を取得するには
次の
describe-scheduled-audit
例では、 という名前の AWS IOT Device Defender スケジュールされた監査に関する詳細情報を取得しますAWSIoTDeviceDefenderDailyAudit
。aws iot describe-scheduled-audit \ --scheduled-audit-name
AWSIoTDeviceDefenderDailyAudit
出力:
{ "frequency": "DAILY", "targetCheckNames": [ "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK", "CONFLICTING_CLIENT_IDS_CHECK", "DEVICE_CERTIFICATE_SHARED_CHECK", "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK", "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK" ], "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit" }
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeScheduledAudit
」の「」を参照してください。
-
次の例は、describe-security-profile
を使用する方法を説明しています。
- AWS CLI
-
セキュリティプロファイルに関する情報を取得するには
次の
describe-security-profile
例では、 という名前の AWS IoT Device Defender セキュリティプロファイルに関する情報を取得します。PossibleIssue.
aws iot describe-security-profile \ --security-profile-name
PossibleIssue
出力:
{ "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", "securityProfileDescription": "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128", "behaviors": [ { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } } ], "version": 1, "creationDate": 1560278102.528, "lastModifiedDate": 1560278102.528 }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeSecurityProfile
」の「」を参照してください。
-
次の例は、describe-stream
を使用する方法を説明しています。
- AWS CLI
-
ストリームに関する情報を取得するには
次の
describe-stream
例では、指定されたストリームの詳細を表示します。aws iot describe-stream \ --stream-id
stream12345
出力:
{ "streamInfo": { "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "streamVersion": 1, "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "files": [ { "fileId": "123", "s3Location": { "bucket":"codesign-ota-bucket", "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ], "createdAt": 1557863215.995, "lastUpdatedAt": 1557863215.995, "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" } }
詳細については、AWS IoT APIリファレンスのDescribeStream「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeStream
」の「」を参照してください。
-
次の例は、describe-thing-group
を使用する方法を説明しています。
- AWS CLI
-
モノのグループに関する情報を取得するには
次の
describe-thing-group
例では、 という名前のモノのグループに関する情報を取得しますHalogenBulbs
。aws iot describe-thing-group \ --thing-group-name
HalogenBulbs
出力:
{ "thingGroupName": "HalogenBulbs", "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", "version": 1, "thingGroupProperties": {}, "thingGroupMetadata": { "parentGroupName": "LightBulbs", "rootToParentThingGroups": [ { "groupName": "LightBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" } ], "creationDate": 1559927609.897 } }
詳細については、「 IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeThingGroup
」の「」を参照してください。
-
次の例は、describe-thing-type
を使用する方法を説明しています。
- AWS CLI
-
モノのタイプに関する情報を取得するには
次の
describe-thing-type
例では、 AWS アカウントで定義されている指定されたモノのタイプに関する情報を表示します。aws iot describe-thing-type \ --thing-type-name
"LightBulb"
出力:
{ "thingTypeName": "LightBulb", "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeProperties": { "thingTypeDescription": "light bulb type", "searchableAttributes": [ "model", "wattage" ] }, "thingTypeMetadata": { "deprecated": false, "creationDate": 1559772562.498 } }
詳細については、IoT デベロッパーガイドの「モノのタイプ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeThingType
」の「」を参照してください。
-
次のコード例は、describe-thing
を使用する方法を示しています。
- AWS CLI
-
モノに関する詳細情報を表示するには
次の
describe-thing
例では、 AWS アカウントの AWS IoT レジストリで定義されているモノ (デバイス) に関する情報を表示します。aws iot describe-thing --thing-nameMyLightBulb「」
出力:
{ "defaultClientId": "MyLightBulb", "thingName": "MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "thingTypeName": "LightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 1 }
詳細については、「AWS IoT ディベロッパーガイド」の「レジストリによるモノの管理方法」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeThing
」の「」を参照してください。
-
次のコード例は、detach-policy
を使用する方法を示しています。
- AWS CLI
-
例 1: IoT AWS IoT ポリシーをモノのグループからデタッチするには
次の
detach-policy
例では、指定されたポリシーをモノのグループからデタッチし、さらにそのグループ内のすべてのモノとグループの子グループからデタッチします。aws iot detach-policy \ --target
"arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
\ --policy-name"MyFirstGroup_Core-policy"
このコマンドでは何も出力されません。
詳細については、「IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
例 2: デバイス証明書から AWS IoT ポリシーをデタッチするには
次の
detach-policy
例では、 によって識別されたデバイス証明書から TemperatureSensorPolicy ポリシーをデタッチしますARN。aws iot detach-policy \ --policy-name
TemperatureSensorPolicy
\ --targetarn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142
このコマンドでは何も出力されません。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDetachPolicy
」の「」を参照してください。
-
次のコード例は、detach-security-profile
を使用する方法を示しています。
- AWS CLI
-
ターゲットからセキュリティプロファイルの関連付けを解除するには
次の
detach-security-profile
例では、 という名前の AWS IoT Device Defender セキュリティプロファイルTestprofile
と、登録されたすべてのモノのターゲットとの関連付けを削除します。aws iot detach-security-profile \ --security-profile-name
Testprofile
\ --security-profile-target-arn"arn:aws:iot:us-west-2:123456789012:all/registered-things"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDetachSecurityProfile
」の「」を参照してください。
-
次のコード例は、detach-thing-principal
を使用する方法を示しています。
- AWS CLI
-
モノから証明書/プリンシパルをデタッチするには
次の
detach-thing-principal
例では、指定されたモノからプリンシパルを表す証明書を削除します。aws iot detach-thing-principal \ --thing-name
"MyLightBulb"
\ --principal"arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36"
このコマンドでは何も出力されません。
詳細については、「AWS IoT ディベロッパーガイド」の「レジストリによるモノの管理方法」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDetachThingPrincipal
」の「」を参照してください。
-
次のコード例は、disable-topic-rule
を使用する方法を示しています。
- AWS CLI
-
トピックルールを無効にするには
次の
disable-topic-rule
例では、指定されたトピックルールを無効にします。aws iot disable-topic-rule \ --rule-name
"MyPlantPiMoistureAlertRule"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「ルールの表示」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDisableTopicRule
」の「」を参照してください。
-
次の例は、enable-topic-rule
を使用する方法を説明しています。
- AWS CLI
-
トピックルールを有効にするには
次の
enable-topic-rule
例では、指定されたトピックルールを有効化 (または再有効化) します。aws iot enable-topic-rule \ --rule-name
"MyPlantPiMoistureAlertRule"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「ルールの表示」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスEnableTopicRule
」の「」を参照してください。
-
次の例は、get-behavior-model-training-summaries
を使用する方法を説明しています。
- AWS CLI
-
Device Defender の ML Detect Security Profile トレーニングモデルのステータスを一覧表示するには
次の
get-behavior-model-training-summaries
例では、選択したセキュリティプロファイルで設定された動作のモデルトレーニングステータスを一覧表示します。動作ごとに、名前、モデルステータス、収集されたデータポイントの割合が一覧表示されます。aws iot get-behavior-model-training-summaries \ --security-profile-name
MySecuirtyProfileName
出力:
{ "summaries": [ { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Messages_sent_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Messages_received_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Authorization_failures_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Message_size_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Connection_attempts_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySPNoALerts", "behaviorName": "Disconnects_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 } ] }
詳細については、AWS IoT デベロッパーガイドのGetBehaviorModelTrainingSummaries 「 (コマンドの検出)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetBehaviorModelTrainingSummaries
」の「」を参照してください。
-
次のコード例は、get-cardinality
を使用する方法を示しています。
- AWS CLI
-
クエリに一致する一意の値の概算数を返すには
次のセットアップスクリプトを使用して、10 個の温度センサーを表す 10 個のモノを作成できます。新しいモノには 3 つの属性があります。
# Bash script. If in other shells, type `bash` before running Temperatures=(70 71 72 73 74 75 47 97 98 99) Racks=(Rack1 Rack1 Rack2 Rack2 Rack3 Rack4 Rack5 Rack6 Rack6 Rack6) IsNormal=(true true true true true true false false false false) for ((i=0; i<10 ; i++)) do thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]},rackId=${Racks[i]},stateNormal=${IsNormal[i]}}") aws iot describe-thing --thing-name "TempSensor$i" done
セットアップスクリプトの出力例:
{ "version": 1, "thingName": "TempSensor0", "defaultClientId": "TempSensor0", "attributes": { "rackId": "Rack1", "stateNormal": "true", "temperature": "70" }, "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0", "thingId": "example1-90ab-cdef-fedc-ba987example" }
次の
get-cardinality
例では、セットアップスクリプトによって作成された 10 個のセンサーをクエリし、異常な温度値をレポートする温度センサーを持つラックの数を返します。温度値が 60 未満または 80 を超える場合、温度センサーは異常な状態になります。aws iot get-cardinality \ --aggregation-field
"attributes.rackId"
\ --query-string"thingName:TempSensor* AND attributes.stateNormal:false"
出力:
{ "cardinality": 2 }
詳細については、AWS IoT デベロッパーガイドの「集計データのクエリ<https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html>」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetCardinality
」の「」を参照してください。
-
次のコード例は、get-effective-policies
を使用する方法を示しています。
- AWS CLI
-
モノに影響を与えるポリシーを一覧表示するには
次の
get-effective-policies
例では、指定されたモノに影響を与えるポリシーを一覧表示します。これには、それが属するすべてのグループにアタッチされたポリシーが含まれます。aws iot get-effective-policies \ --thing-name
TemperatureSensor-001
\ --principalarn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142
出力:
{ "effectivePolicies": [ { "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": [ \"iot:Publish\", \"iot:Receive\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Subscribe\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Connect\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" ] } ] }" } ] }
詳細については、「IoT デベロッパーガイド」の「モノの効果的なポリシーを取得する」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetEffectivePolicies
」の「」を参照してください。
-
次の例は、get-indexing-configuration
を使用する方法を説明しています。
- AWS CLI
-
モノのインデックス設定を取得するには
次の
get-indexing-configuration
例では、 AWS IoT フリートインデックス作成の現在の設定データを取得します。aws iot get-indexing-configuration
出力:
{ "thingIndexingConfiguration": { "thingIndexingMode": "OFF", "thingConnectivityIndexingMode": "OFF" }, "thingGroupIndexingConfiguration": { "thingGroupIndexingMode": "OFF" } }
詳細については、IoT デベロッパーガイドの「モノのインデックス作成の管理」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetIndexingConfiguration
」の「」を参照してください。
-
次の例は、get-job-document
を使用する方法を説明しています。
- AWS CLI
-
ジョブのドキュメントを取得するには
次の
get-job-document
例では、ID が のジョブのドキュメントの詳細を表示しますexample-job-01
。aws iot get-job-document \ --job-id
"example-job-01"
出力:
{ "document": "\n{\n \"operation\":\"customJob\",\n \"otherInfo\":\"someValue\"\n}\n" }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetJobDocument
」の「」を参照してください。
-
次のコード例は、get-logging-options
を使用する方法を示しています。
- AWS CLI
-
ログ記録オプションを取得するには
次の
get-logging-options
例では、 AWS アカウントの現在のログ記録オプションを取得します。aws iot get-logging-options
出力:
{ "roleArn": "arn:aws:iam::123456789012:role/service-role/iotLoggingRole", "logLevel": "ERROR" }
詳細については、AWS 「 IoT デベロッパーガイド」の「タイトル」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetLoggingOptions
」の「」を参照してください。
-
次の例は、get-ota-update
を使用する方法を説明しています。
- AWS CLI
-
OTA 更新に関する情報を取得するには
次の
get-ota-update
例では、指定されたOTA更新の詳細を表示します。aws iot get-ota-update \ --ota-update-id
ota12345
出力:
{ "otaUpdateInfo": { "otaUpdateId": "ota12345", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "creationDate": 1557863215.995, "lastModifiedDate": 1557863215.995, "description": "A critical update needed right away.", "targets": [ "device1", "device2", "device3", "device4" ], "targetSelection": "SNAPSHOT", "protocols": ["HTTP"], "awsJobExecutionsRolloutConfig": { "maximumPerMinute": 10 }, "otaUpdateFiles": [ { "fileName": "firmware.bin", "fileLocation": { "stream": { "streamId": "004", "fileId":123 } }, "codeSigning": { "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ], "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" "otaUpdateStatus": "CREATE_COMPLETE", "awsIotJobId": "job54321", "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/job54321", "errorInfo": { } } }
詳細については、IoT リファレンスの「GetOTAUpdate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetOtaUpdate
」の「」を参照してください。
-
次の例は、get-percentiles
を使用する方法を説明しています。
- AWS CLI
-
クエリに一致する集計値をパーセンタイルグループにグループ化するには
次のセットアップスクリプトを使用して、10 個の温度センサーを表す 10 個のモノを作成できます。新しいモノには 1 つの属性があります。
# Bash script. If in other shells, type `bash` before running Temperatures=(70 71 72 73 74 75 47 97 98 99) for ((i=0; i<10 ; i++)) do thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]}}") aws iot describe-thing --thing-name "TempSensor$i" done
セットアップスクリプトの出力例:
{ "version": 1, "thingName": "TempSensor0", "defaultClientId": "TempSensor0", "attributes": { "temperature": "70" }, "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0", "thingId": "example1-90ab-cdef-fedc-ba987example" }
次の
get-percentiles
例では、セットアップスクリプトによって作成された 10 個のセンサーをクエリし、指定された各パーセンタイルグループの値を返します。パーセンタイルグループ「10」には、クエリに一致する値の約 10% で発生する集計フィールド値が含まれます。次の出力では、{「パーセント」: 10.0、「値」: 67.7} は、温度値の約 10.0% が 67.7 未満であることを意味します。aws iot get-percentiles \ --aggregation-field
"attributes.temperature"
\ --query-string"thingName:TempSensor*"
\ --percents10
25
50
75
90
出力:
{ "percentiles": [ { "percent": 10.0, "value": 67.7 }, { "percent": 25.0, "value": 71.25 }, { "percent": 50.0, "value": 73.5 }, { "percent": 75.0, "value": 91.5 }, { "percent": 90.0, "value": 98.1 } ] }
詳細については、AWS IoT デベロッパーガイドの「集計データのクエリ」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetPercentiles
」の「」を参照してください。
-
次のコード例は、get-policy-version
を使用する方法を示しています。
- AWS CLI
-
ポリシーの特定のバージョンに関する情報を取得するには
次の
get-policy-version
例では、指定されたポリシーの最初のバージョンに関する情報を取得します。aws iot get-policy \ --policy-name
UpdateDeviceCertPolicy
--policy-version-id"1"
出力:
{ "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", "policyName": "UpdateDeviceCertPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", "policyVersionId": "1", "isDefaultVersion": false, "creationDate": 1559925941.924, "lastModifiedDate": 1559926175.458, "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" }
詳細については、AWS IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetPolicyVersion
」の「」を参照してください。
-
次のコード例は、get-policy
を使用する方法を示しています。
- AWS CLI
-
ポリシーのデフォルトバージョンに関する情報を取得するには
次の
get-policy
例では、指定されたポリシーのデフォルトバージョンに関する情報を取得します。aws iot get-policy \ --policy-name
UpdateDeviceCertPolicy
出力:
{ "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", "defaultVersionId": "2", "creationDate": 1559925941.924, "lastModifiedDate": 1559925941.924, "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" }
詳細については、AWS IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetPolicy
」の「」を参照してください。
-
次のコード例は、get-registration-code
を使用する方法を示しています。
- AWS CLI
-
AWS アカウント固有の登録コードを取得するには
次の
get-registration-code
例では、 AWS アカウント固有の登録コードを取得します。aws iot get-registration-code
出力:
{ "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c" }
詳細については、AWS IoT デベロッパーガイドの「独自の証明書を使用する」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetRegistrationCode
」の「」を参照してください。
-
次の例は、get-statistics
を使用する方法を説明しています。
- AWS CLI
-
デバイスインデックスで集計データを検索するには
次の
get-statistics
例では、 というプロパティがデバイスシャドウでconnectivity.connected
に設定されているモノの数false
(つまり、接続されていないデバイスの数) を返します。aws iot get-statistics \ --index-name
AWS_Things
\ --query-string"connectivity.connected:false"
出力:
{ "statistics": { "count": 6 } }
詳細については、AWS IoT デベロッパーガイドの「デバイスフリートに関する統計の取得」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetStatistics
」の「」を参照してください。
-
次の例は、get-topic-rule-destination
を使用する方法を説明しています。
- AWS CLI
-
トピックルールの送信先を取得するには
次の
get-topic-rule-destination
例では、トピックルールの送信先に関する情報を取得します。aws iot get-topic-rule-destination \ --arn
"arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
出力:
{ "topicRuleDestination": { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "DISABLED", "httpUrlProperties": { "confirmationUrl": "https://example.com" } } }
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先の使用」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetTopicRuleDestination
」の「」を参照してください。
-
次のコード例は、get-topic-rule
を使用する方法を示しています。
- AWS CLI
-
ルールに関する情報を取得するには
次の
get-topic-rule
例では、指定されたルールに関する情報を取得します。aws iot get-topic-rule \ --rule-name
MyRPiLowMoistureAlertRule
出力:
{ "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", "rule": { "ruleName": "MyRPiLowMoistureAlertRule", "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n ", "description": "Sends an alert whenever soil moisture level readings are too low.", "createdAt": 1558624363.0, "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", "messageFormat": "RAW" } } ], "ruleDisabled": false, "awsIotSqlVersion": "2016-03-23" } }
詳細については、「 IoT デベロッパーガイド」の「ルールの表示AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetTopicRule
」の「」を参照してください。
-
次の例は、get-v2-logging-options
を使用する方法を説明しています。
- AWS CLI
-
現在のログ記録オプションを一覧表示するには
次の
get-v2-logging-options
例では、 AWS IoT の現在のログ記録オプションを一覧表示します。aws iot get-v2-logging-options
出力:
{ "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole", "defaultLogLevel": "WARN", "disableAllLogs": false }
詳細については、AWS 「 IoT デベロッパーガイド」の「タイトル」を参照してください。
-
API 詳細については、「 コマンドリファレンス」のGetV2LoggingOptions
」を参照してください。 AWS CLI
-
次の例は、list-active-violations
を使用する方法を説明しています。
- AWS CLI
-
アクティブな違反を一覧表示するには
次の
list-active-violations
例では、指定されたセキュリティプロファイルに対するすべての違反を一覧表示します。aws iot list-active-violations \ --security-profile-name
Testprofile
出力:
{ "activeViolations": [ { "violationId": "174db59167fa474c80a652ad1583fd44", "thingName": "iotconsole-1560269126751-1", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 0 }, "lastViolationTime": 1560293700.0, "violationStartTime": 1560279000.0 }, { "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 110 }, "lastViolationTime": 1560369000.0, "violationStartTime": 1560276600.0 }, { "violationId": "74aa393adea02e6648f3ac362beed55e", "thingName": "iotconsole-1560269232412-2", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 0 }, "lastViolationTime": 1560276600.0, "violationStartTime": 1560276600.0 }, { "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 0 }, "lastViolationTime": 1560369000.0, "violationStartTime": 1560276600.0 } ] }
-
API 詳細については、AWS CLI 「 コマンドリファレンスListActiveViolations
」の「」を参照してください。
-
次のコード例は、list-attached-policies
を使用する方法を示しています。
- AWS CLI
-
例 1: グループにアタッチされたポリシーを一覧表示するには
次の
list-attached-policies
例では、指定されたグループにアタッチされているポリシーを一覧表示します。aws iot list-attached-policies \ --target
"arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
出力:
{ "policies": [ { "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" } ] }
詳細については、IoT デベロッパーガイドの「モノのグループ」を参照してください。 AWS IoT
例 2: デバイス証明書にアタッチされたポリシーを一覧表示するには
次の
list-attached-policies
例では、デバイス証明書にアタッチされた AWS IoT ポリシーを一覧表示します。証明書は によって識別されますARN。aws iot list-attached-policies \ --target
arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142
出力:
{ "policies": [ { "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy" } ] }
詳細については、「 IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAttachedPolicies
」の「」を参照してください。
-
次のコード例は、list-audit-findings
を使用する方法を示しています。
- AWS CLI
-
例 1: 監査のすべての結果を一覧表示するには
次の
list-audit-findings
例では、指定されたタスク ID を持つ AWS IoT Device Defender 監査のすべての検出結果を一覧表示します。aws iot list-audit-findings \ --task-id
a3aea009955e501a31b764abe1bebd3d
出力:
{ "findings": [] }
例 2: 監査チェックタイプの結果を一覧表示するには
次の
list-audit-findings
例は、デバイスがデバイス証明書を共有している 2019 年 6 月 5 日から 2019 年 6 月 19 日の間に実行された AWS IoT Device Defender 監査の結果を示しています。チェック名を指定するときは、開始時刻と終了時刻を指定する必要があります。aws iot list-audit-findings \ --check-name
DEVICE_CERTIFICATE_SHARED_CHECK
\ --start-time1559747125
\ --end-time1560962028
出力:
{ "findings": [ { "taskId": "eeef61068b0eb03c456d746c5a26ee04", "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", "taskStartTime": 1560161017.172, "findingTime": 1560161017.592, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "DEVICE_CERTIFICATE", "resourceIdentifier": { "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" } }, "relatedResources": [ { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "ZipxgAIl" }, "additionalInfo": { "CONNECTION_TIME": "1560086374068" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "ZipxgAIl" }, "additionalInfo": { "CONNECTION_TIME": "1560081552187", "DISCONNECTION_TIME": "1560086371552" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "ZipxgAIl" }, "additionalInfo": { "CONNECTION_TIME": "1559289863631", "DISCONNECTION_TIME": "1560081532716" } } ], "reasonForNonCompliance": "Certificate shared by one or more devices.", "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" }, { "taskId": "bade6b5efd2e1b1569822f6021b39cf5", "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", "taskStartTime": 1559988217.27, "findingTime": 1559988217.655, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "DEVICE_CERTIFICATE", "resourceIdentifier": { "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" } }, "relatedResources": [ { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "xShGENLW" }, "additionalInfo": { "CONNECTION_TIME": "1559972350825" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "xShGENLW" }, "additionalInfo": { "CONNECTION_TIME": "1559255062002", "DISCONNECTION_TIME": "1559972350616" } } ], "reasonForNonCompliance": "Certificate shared by one or more devices.", "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" }, { "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", "taskStartTime": 1559901817.31, "findingTime": 1559901817.767, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "DEVICE_CERTIFICATE", "resourceIdentifier": { "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" } }, "relatedResources": [ { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "TvnQoEoU" }, "additionalInfo": { "CONNECTION_TIME": "1559826729768" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "TvnQoEoU" }, "additionalInfo": { "CONNECTION_TIME": "1559345920964", "DISCONNECTION_TIME": "1559826728402" } } ], "reasonForNonCompliance": "Certificate shared by one or more devices.", "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" } ] }
詳細については、AWS IoT デベロッパーガイドの「Audit Commands」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAuditFindings
」の「」を参照してください。
-
次の例は、list-audit-mitigation-actions-executions
を使用する方法を説明しています。
- AWS CLI
-
監査緩和アクションの実行の詳細を一覧表示するには
監査緩和アクションタスクは、 AWS IoT Device Defender 監査からの 1 つ以上の検出結果に緩和アクションを適用します。次の
list-audit-mitigation-actions-executions
例では、taskId
と が指定された結果の緩和アクションタスクの詳細を一覧表示します。aws iot list-audit-mitigation-actions-executions \ --task-id
myActionsTaskId
\ --finding-id0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464
出力:
{ "actionsExecutions": [ { "taskId": "myActionsTaskId", "findingId": "0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464", "actionName": "ResetPolicyVersionAction", "actionId": "1ea0b415-bef1-4a01-bd13-72fb63c59afb", "status": "COMPLETED", "startTime": "2019-12-10T15:19:13.279000-08:00", "endTime": "2019-12-10T15:19:13.337000-08:00" } ] }
詳細については、AWS IoT デベロッパーガイドのListAuditMitigationActionsExecutions 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAuditMitigationActionsExecutions
」の「」を参照してください。
-
次のコード例は、list-audit-mitigation-actions-tasks
を使用する方法を示しています。
- AWS CLI
-
監査緩和アクションタスクを一覧表示するには
次の
list-audit-mitigation-actions-tasks
例では、指定された期間内に結果に適用された緩和アクションを一覧表示します。aws iot list-audit-mitigation-actions-tasks \ --start-time
1594157400
\ --end-time1594157430
出力:
{ "tasks": [ { "taskId": "0062f2d6-3999-488f-88c7-bef005414103", "startTime": "2020-07-07T14:30:15.172000-07:00", "taskStatus": "COMPLETED" } ] }
詳細については、AWS IoT デベロッパーガイドのListAuditMitigationActionsTasks 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAuditMitigationActionsTasks
」の「」を参照してください。
-
次の例は、list-audit-suppressions
を使用する方法を説明しています。
- AWS CLI
-
すべての監査結果の抑制を一覧表示するには
次の
list-audit-suppressions
例では、アクティブな監査結果の抑制をすべて一覧表示します。aws iot list-audit-suppressions
出力:
{ "suppressions": [ { "checkName": "DEVICE_CERTIFICATE_EXPIRING_CHECK", "resourceIdentifier": { "deviceCertificateId": "c7691e<shortened>" }, "expirationDate": 1597881600.0, "suppressIndefinitely": false } ] }
詳細については、「 IoT デベロッパーガイド」の「監査結果の抑制AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAuditSuppressions
」の「」を参照してください。
-
次のコード例は、list-audit-tasks
を使用する方法を示しています。
- AWS CLI
-
監査のすべての結果を一覧表示するには
次の
list-audit-tasks
例では、2019 年 6 月 5 日から 2019 年 6 月 12 日の間に実行された監査タスクを一覧表示します。aws iot list-audit-tasks \ --start-time
1559747125
\ --end-time1560357228
出力:
{ "tasks": [ { "taskId": "a3aea009955e501a31b764abe1bebd3d", "taskStatus": "COMPLETED", "taskType": "ON_DEMAND_AUDIT_TASK" }, { "taskId": "f76b4b5102b632cd9ae38a279c266da1", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "51d9967d9f9ff4d26529505f6d2c444a", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "eeef61068b0eb03c456d746c5a26ee04", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "041c49557b7c7b04c079a49514b55589", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "82c7f2afac1562d18a4560be73998acc", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "bade6b5efd2e1b1569822f6021b39cf5", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "ac9086b7222a2f5e2e17bb6fd30b3aeb", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" } ] }
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAuditTasks
」の「」を参照してください。
-
次のコード例は、list-authorizers
を使用する方法を示しています。
- AWS CLI
-
カスタムオーソライザーを一覧表示するには
次の
list-authorizers
例では、 AWS アカウントのカスタムオーソライザーを一覧表示します。aws iot list-authorizers
出力:
{ "authorizers": [ { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" }, { "authorizerName": "CustomAuthorizer2", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" }, { "authorizerName": "CustomAuthorizer3", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer3" } ] }
詳細については、AWS IoT APIリファレンスのListAuthorizers「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListAuthorizers
」の「」を参照してください。
-
次の例は、list-billing-groups
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントとリージョンの請求グループを一覧表示するには
次の
list-billing-groups
例では、 AWS アカウントと AWS リージョンに定義されているすべての請求グループを一覧表示します。aws iot list-billing-groups
出力:
{ "billingGroups": [ { "groupName": "GroupOne", "groupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" } ] }
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListBillingGroups
」の「」を参照してください。
-
次のコード例は、list-ca-certificates
を使用する方法を示しています。
- AWS CLI
-
AWS アカウントに登録されている CA 証明書を一覧表示するには
次の
list-ca-certificates
例では、 AWS アカウントに登録されている CA 証明書を一覧表示します。aws iot list-ca-certificates
出力:
{ "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "status": "INACTIVE", "creationDate": 1569365372.053 } ] }
詳細については、AWS IoT デベロッパーガイドの「独自の証明書を使用する」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListCaCertificates
」の「」を参照してください。
-
次のコード例は、list-certificates-by-ca
を使用する方法を示しています。
- AWS CLI
-
CA 証明書で署名されたすべてのデバイス証明書を一覧表示するには
次の
list-certificates-by-ca
例では、指定された CA 証明書で署名された AWS アカウント内のすべてのデバイス証明書を一覧表示します。aws iot list-certificates-by-ca \ --ca-certificate-id
f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467
出力:
{ "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "status": "ACTIVE", "creationDate": 1569363250.557 } ] }
詳細については、IoT リファレンスのListCertificatesBy「CA」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスListCertificatesByCa
」の「」を参照してください。
-
次のコード例は、list-certificates
を使用する方法を示しています。
- AWS CLI
-
例 1: AWS アカウントに登録されている証明書を一覧表示するには
次の
list-certificates
例では、アカウントに登録されているすべての証明書を一覧表示します。デフォルトのページング制限が 25 を超える場合は、このコマンドのnextMarker
レスポンス値を使用して次のコマンドに指定し、結果の次のバッチを取得できます。が値なしでnextMarker
を返すまで繰り返します。aws iot list-certificates
出力:
{ "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", "certificateId": "604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", "status": "ACTIVE", "creationDate": 1556810537.617 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", "certificateId": "262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", "status": "ACTIVE", "creationDate": 1546447050.885 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", "certificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", "status": "ACTIVE", "creationDate": 1546292258.322 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", "certificateId": "7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", "status": "ACTIVE", "creationDate": 1541457693.453 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", "certificateId": "54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", "status": "ACTIVE", "creationDate": 1541113568.611 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "status": "ACTIVE", "creationDate": 1541022751.983 } ] }
-
API 詳細については、AWS CLI 「 コマンドリファレンスListCertificates
」の「」を参照してください。
-
次の例は、list-custom-metrics
を使用する方法を説明しています。
- AWS CLI
-
カスタムメトリクスを一覧表示するには
次の
list-custom-metrics
例では、すべてのカスタムメトリクスを一覧表示します。aws iot list-custom-metrics \ --region
us-east-1
出力:
{ "metricNames": [ "batteryPercentage" ] }
詳細については、「 IoT Core デベロッパーガイド」の「カスタムメトリクス」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListCustomMetrics
」の「」を参照してください。
-
次の例は、list-dimensions
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントのディメンションを一覧表示するには
次の
list-dimensions
例では、 AWS アカウントで定義されているすべての AWS IoT Device Defender ディメンションを一覧表示します。aws iot list-dimensions
出力:
{ "dimensionNames": [ "TopicFilterForAuthMessages", "TopicFilterForActivityMessages" ] }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListDimensions
」の「」を参照してください。
-
次のコード例は、list-domain-configurations
を使用する方法を示しています。
- AWS CLI
-
ドメイン設定を一覧表示するには
次の
list-domain-configurations
例では、指定されたサービスタイプを持つ AWS アカウントのドメイン設定を一覧表示します。aws iot list-domain-configurations \ --service-type
"DATA"
出力:
{ "domainConfigurations": [ { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh", "serviceType": "DATA" }, { "domainConfigurationName": "iot:Jobs", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Jobs", "serviceType": "JOBS" }, { "domainConfigurationName": "iot:Data-ATS", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Data-ATS", "serviceType": "DATA" }, { "domainConfigurationName": "iot:CredentialProvider", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:CredentialProvider", "serviceType": "CREDENTIAL_PROVIDER" } ] }
詳細については、AWS IoT デベロッパーガイドの「設定可能なエンドポイント」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListDomainConfigurations
」の「」を参照してください。
-
次のコード例は、list-indices
を使用する方法を示しています。
- AWS CLI
-
設定された検索インデックスを一覧表示するには
次の
list-indices
例では、 AWS アカウントに設定されているすべての検索インデックスを一覧表示します。モノのインデックス作成を有効にしていない場合は、インデックスがない可能性があります。aws iot list-indices
出力:
{ "indexNames": [ "AWS_Things" ] }
詳細については、AWS IoT デベロッパーガイドの「モノのインデックス作成の管理」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListIndices
」の「」を参照してください。
-
次の例は、list-job-executions-for-job
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントのジョブを一覧表示するには
次の
list-job-executions-for-job
例では、 で指定された AWS 、アカウント内のジョブのすべてのジョブ実行を一覧表示しますjobId。aws iot list-job-executions-for-job \ --job-id
my-ota-job
出力:
{ "executionSummaries": [ { "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/my_thing", "jobExecutionSummary": { "status": "QUEUED", "queuedAt": "2022-03-07T15:58:42.195000-08:00", "lastUpdatedAt": "2022-03-07T15:58:42.195000-08:00", "executionNumber": 1, "retryAttempt": 0 } } ] }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListJobExecutionsForJob
」の「」を参照してください。
-
次のコード例は、list-job-executions-for-thing
を使用する方法を示しています。
- AWS CLI
-
モノに対して実行されたジョブを一覧表示するには
次の
list-job-executions-for-thing
例では、 という名前のモノに対して実行されたすべてのジョブを一覧表示しますMyRaspberryPi
。aws iot list-job-executions-for-thing \ --thing-name
"MyRaspberryPi"
出力:
{ "executionSummaries": [ { "jobId": "example-job-01", "jobExecutionSummary": { "status": "QUEUED", "queuedAt": 1560787023.636, "lastUpdatedAt": 1560787023.636, "executionNumber": 1 } } ] }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListJobExecutionsForThing
」の「」を参照してください。
-
次の例は、list-jobs
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントのジョブを一覧表示するには
次の
list-jobs
例では、 AWS アカウント内のすべてのジョブをジョブステータスでソートして一覧表示します。aws iot list-jobs
出力:
{ "jobs": [ { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "targetSelection": "SNAPSHOT", "status": "IN_PROGRESS", "createdAt": 1560787022.733, "lastUpdatedAt": 1560787026.294 } ] }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListJobs
」の「」を参照してください。
-
次のコード例は、list-mitigation-actions
を使用する方法を示しています。
- AWS CLI
-
定義されたすべての緩和アクションを一覧表示するには
次の
list-mitigation-actions
例では、 AWS アカウントとリージョンに対して定義されたすべての緩和アクションを一覧表示します。アクションごとに、名前、ARN、および作成日が一覧表示されます。aws iot list-mitigation-actions
出力:
{ "actionIdentifiers": [ { "actionName": "DeactivateCACertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction", "creationDate": "2019-12-10T11:12:47.574000-08:00" }, { "actionName": "ResetPolicyVersionAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction", "creationDate": "2019-12-10T11:11:48.920000-08:00" }, { "actionName": "PublishFindingToSNSAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction", "creationDate": "2019-12-10T11:10:49.546000-08:00" }, { "actionName": "AddThingsToQuarantineGroupAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "creationDate": "2019-12-10T11:09:35.999000-08:00" }, { "actionName": "UpdateDeviceCertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction", "creationDate": "2019-12-10T11:08:44.263000-08:00" }, { "actionName": "SampleMitigationAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction", "creationDate": "2019-12-10T11:03:41.840000-08:00" } ] }
詳細については、AWS IoT デベロッパーガイドのListMitigationActions 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListMitigationActions
」の「」を参照してください。
-
次の例は、list-mitigations-actions
を使用する方法を説明しています。
- AWS CLI
-
定義されたすべての緩和アクションを一覧表示するには
次の
list-mitigations-actions
例では、 AWS アカウントとリージョンに対して定義されたすべての緩和アクションを一覧表示します。アクションごとに、名前、ARN、および作成日が一覧表示されます。aws iot list-mitigation-actions
出力:
{ "actionIdentifiers": [ { "actionName": "DeactivateCACertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction", "creationDate": "2019-12-10T11:12:47.574000-08:00" }, { "actionName": "ResetPolicyVersionAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction", "creationDate": "2019-12-10T11:11:48.920000-08:00" }, { "actionName": "PublishFindingToSNSAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction", "creationDate": "2019-12-10T11:10:49.546000-08:00" }, { "actionName": "AddThingsToQuarantineGroupAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "creationDate": "2019-12-10T11:09:35.999000-08:00" }, { "actionName": "UpdateDeviceCertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction", "creationDate": "2019-12-10T11:08:44.263000-08:00" }, { "actionName": "SampleMitigationAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction", "creationDate": "2019-12-10T11:03:41.840000-08:00" } ] }
詳細については、AWS IoT デベロッパーガイドのListMitigationActions 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListMitigationsActions
」の「」を参照してください。
-
次のコード例は、list-ota-updates
を使用する方法を示しています。
- AWS CLI
-
アカウントのOTA更新を一覧表示するには
次の
list-ota-updates
例では、利用可能なOTA更新を一覧表示します。aws iot list-ota-updates
出力:
{ "otaUpdates": [ { "otaUpdateId": "itsaupdate", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "creationDate": 1557863215.995 } ] }
詳細については、IoT リファレンス の「ListOTAUpdates」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスListOtaUpdates
」の「」を参照してください。
-
次のコード例は、list-outgoing-certificates
を使用する方法を示しています。
- AWS CLI
-
別の AWS アカウントに転送される証明書を一覧表示するには
次の
list-outgoing-certificates
例では、transfer-certificate
コマンドを使用して別の AWS アカウントに転送されているすべてのデバイス証明書を一覧表示します。aws iot list-outgoing-certificates
出力:
{ "outgoingCertificates": [ { "certificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "transferredTo": "030714055129", "transferDate": 1569427780.441, "creationDate": 1569363250.557 } ] }
詳細については、AWS IoT APIリファレンスのListOutgoingCertificates「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListOutgoingCertificates
」の「」を参照してください。
-
次の例は、list-policies
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントで定義されているポリシーを一覧表示するには
次の
list-policies
例では、 AWS アカウントで定義されているすべてのポリシーを一覧表示します。aws iot list-policies
出力:
{ "policies": [ { "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" }, { "policyName": "PlantIoTPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/PlantIoTPolicy" }, { "policyName": "MyPiGroup_Core-policy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/MyPiGroup_Core-policy" } ] }
詳細については、AWS 「 IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListPolicies
」の「」を参照してください。
-
次の例は、list-policy-versions
を使用する方法を説明しています。
- AWS CLI
-
例 1: ポリシーのすべてのバージョンを表示するには
次の
list-policy-versions
例では、指定されたポリシーのすべてのバージョンとその作成日を一覧表示します。aws iot list-policy-versions \ --policy-name
LightBulbPolicy
出力:
{ "policyVersions": [ { "versionId": "2", "isDefaultVersion": true, "createDate": 1559925941.924 }, { "versionId": "1", "isDefaultVersion": false, "createDate": 1559925941.924 } ] }
詳細については、AWS 「 IoT デベロッパーガイド」の「IoT ポリシーAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListPolicyVersions
」の「」を参照してください。
-
次の例は、list-principal-things
を使用する方法を説明しています。
- AWS CLI
-
プリンシパルにアタッチされたモノを一覧表示するには
次の
list-principal-things
例では、 によって指定されたプリンシパルにアタッチされたモノを一覧表示しますARN。aws iot list-principal-things \ --principal
arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8
出力:
{ "things": [ "DeskLamp", "TableLamp" ] }
詳細については、 AWS IoT APIリファレンスのListPrincipalThings「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListPrincipalThings
」の「」を参照してください。
-
次の例は、list-provisioning-template-versions
を使用する方法を説明しています。
- AWS CLI
-
プロビジョニングテンプレートのバージョンを一覧表示するには
次の
list-provisioning-template-versions
例では、指定されたプロビジョニングテンプレートの使用可能なバージョンを一覧表示します。aws iot list-provisioning-template-versions \ --template-name
"widget-template"
出力:
{ "versions": [ { "versionId": 1, "creationDate": 1574800471.339, "isDefaultVersion": true }, { "versionId": 2, "creationDate": 1574801192.317, "isDefaultVersion": false } ] }
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListProvisioningTemplateVersions
」の「」を参照してください。
-
次のコード例は、list-provisioning-templates
を使用する方法を示しています。
- AWS CLI
-
プロビジョニングテンプレートを一覧表示するには
次の
list-provisioning-templates
例では、 AWS アカウント内のすべてのプロビジョニングテンプレートを一覧表示します。aws iot list-provisioning-templates
出力:
{ "templates": [ { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "description": "A provisioning template for widgets", "creationDate": 1574800471.367, "lastModifiedDate": 1574801192.324, "enabled": false } ] }
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListProvisioningTemplates
」の「」を参照してください。
-
次の例は、list-role-aliases
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントの AWS IoT ロールエイリアスを一覧表示するには
次の
list-role-aliases
例では、 AWS アカウントの AWS IoT ロールエイリアスを一覧表示します。aws iot list-role-aliases
出力:
{ "roleAliases": [ "ResidentAlias", "ElectricianAlias" ] }
詳細については、AWS IoT APIリファレンスのListRoleAliases「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListRoleAliases
」の「」を参照してください。
-
次のコード例は、list-scheduled-audits
を使用する方法を示しています。
- AWS CLI
-
AWS アカウントのスケジュールされた監査を一覧表示するには
次の
list-scheduled-audits
例では、 AWS アカウントにスケジュールされた監査を一覧表示します。aws iot list-scheduled-audits
出力:
{ "scheduledAudits": [ { "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit", "frequency": "DAILY" }, { "scheduledAuditName": "AWSDeviceDefenderWeeklyAudit", "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSDeviceDefenderWeeklyAudit", "frequency": "WEEKLY", "dayOfWeek": "SUN" } ] }
詳細については、AWS IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListScheduledAudits
」の「」を参照してください。
-
次の例は、list-security-profiles-for-target
を使用する方法を説明しています。
- AWS CLI
-
ターゲットにアタッチされたセキュリティプロファイルを一覧表示するには
次の
list-security-profiles-for-target
例では、未登録のデバイスにアタッチされている AWS IoT Device Defender セキュリティプロファイルを一覧表示します。aws iot list-security-profiles-for-target \ --security-profile-target-arn
"arn:aws:iot:us-west-2:123456789012:all/unregistered-things"
出力:
{ "securityProfileTargetMappings": [ { "securityProfileIdentifier": { "name": "Testprofile", "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" }, "target": { "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" } } ] }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListSecurityProfilesForTarget
」の「」を参照してください。
-
次の例は、list-security-profiles
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントのセキュリティプロファイルを一覧表示するには
次の
list-security-profiles
例では、 AWS アカウントで定義されているすべての AWS IoT Device Defender セキュリティプロファイルを一覧表示します。aws iot list-security-profiles
出力:
{ "securityProfileIdentifiers": [ { "name": "Testprofile", "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" } ] }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListSecurityProfiles
」の「」を参照してください。
-
次の例は、list-streams
を使用する方法を説明しています。
- AWS CLI
-
アカウントのストリームを一覧表示するには
次の
list-streams
例では、 AWS アカウント内のすべてのストリームを一覧表示します。aws iot list-streams
出力:
{ "streams": [ { "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "streamVersion": 1, "description": "This stream is used for Amazon FreeRTOS OTA Update 12345." }, { "streamId": "stream54321", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream54321", "streamVersion": 1, "description": "This stream is used for Amazon FreeRTOS OTA Update 54321." } ] }
詳細については、AWS IoT APIリファレンスのListStreams「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListStreams
」の「」を参照してください。
-
次の例は、list-tags-for-resource
を使用する方法を説明しています。
- AWS CLI
-
リソースに関連付けられたタグとその値を表示するには
次の
list-tags-for-resource
例では、モノのグループ に関連付けられたタグと値を表示しますLightBulbs
。aws iot list-tags-for-resource \ --resource-arn
"arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs"
出力:
{ "tags": [ { "Key": "Assembly", "Value": "Fact1NW" }, { "Key": "MyTag", "Value": "777" } ] }
詳細については、AWS IoT デベロッパーガイド」の「IoT リソースのタグ付け」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListTagsForResource
」の「」を参照してください。
-
次の例は、list-targets-for-policy
を使用する方法を説明しています。
- AWS CLI
-
AWS IoT ポリシーに関連付けられているプリンシパルを一覧表示するには
次の
list-targets-for-policy
例では、指定されたポリシーがアタッチされているデバイス証明書を一覧表示します。aws iot list-targets-for-policy \ --policy-name
UpdateDeviceCertPolicy
出力:
{ "targets": [ "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be" ] }
詳細については、IoT デベロッパーガイドの「モノのグループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListTargetsForPolicy
」の「」を参照してください。
-
次の例は、list-targets-for-security-profile
を使用する方法を説明しています。
- AWS CLI
-
セキュリティプロファイルが適用されるターゲットを一覧表示するには
次の
list-targets-for-security-profile
例では、 という名前の AWS IoT Device Defender セキュリティプロファイルPossibleIssue
が適用されるターゲットを一覧表示します。aws iot list-targets-for-security-profile \ --security-profile-name
Testprofile
出力:
{ "securityProfileTargets": [ { "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" }, { "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things" } ] }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListTargetsForSecurityProfile
」の「」を参照してください。
-
次の例は、list-thing-groups-for-thing
を使用する方法を説明しています。
- AWS CLI
-
モノが属するグループを一覧表示するには
次の
list-thing-groups-for-thing
例では、指定されたモノが属するグループを一覧表示します。aws iot list-thing-groups-for-thing \ --thing-name
MyLightBulb
出力:
{ "thingGroups": [ { "groupName": "DeadBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" }, { "groupName": "LightBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" } ] }
詳細については、「IoT デベロッパーガイド」の「モノのグループAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThingGroupsForThing
」の「」を参照してください。
-
次の例は、list-thing-groups
を使用する方法を説明しています。
- AWS CLI
-
AWS アカウントで定義されているモノのグループを一覧表示するには
次の
describe-thing-group
例では、 AWS アカウントで定義されているすべてのモノのグループを一覧表示します。aws iot list-thing-groups
出力:
{ "thingGroups": [ { "groupName": "HalogenBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs" }, { "groupName": "LightBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" } ] }
詳細については、IoT デベロッパーガイドの「モノのグループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThingGroups
」の「」を参照してください。
-
次のコード例は、list-thing-principals
を使用する方法を示しています。
- AWS CLI
-
モノに関連付けられたプリンシパルを一覧表示するには
次の
list-thing-principals
例では、指定されたモノに関連付けられているプリンシパル (X.509 証明書、IAMユーザー、グループ、ロール、Amazon Cognito ID、またはフェデレーティッド ID) を一覧表示します。aws iot list-thing-principals \ --thing-name
MyRaspberryPi
出力:
{ "principals": [ "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893" ] }
詳細については、AWS IoT APIリファレンスのListThingPrincipals「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThingPrincipals
」の「」を参照してください。
-
次のコード例は、list-thing-types
を使用する方法を示しています。
- AWS CLI
-
定義されたモノのタイプを一覧表示するには
次の
list-thing-types
例では、 AWS アカウントで定義されているモノのタイプのリストを表示します。aws iot list-thing-types
出力:
{ "thingTypes": [ { "thingTypeName": "LightBulb", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeProperties": { "thingTypeDescription": "light bulb type", "searchableAttributes": [ "model", "wattage" ] }, "thingTypeMetadata": { "deprecated": false, "creationDate": 1559772562.498 } } ] }
詳細については、IoT デベロッパーガイドの「モノのタイプ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThingTypes
」の「」を参照してください。
-
次の例は、list-things-in-billing-group
を使用する方法を説明しています。
- AWS CLI
-
請求グループ内のモノを一覧表示するには
次の
list-things-in-billing-group
例では、指定された請求グループにあるモノを一覧表示します。aws iot list-things-in-billing-group \ --billing-group-name
GroupOne
出力:
{ "things": [ "MyOtherLightBulb", "MyLightBulb" ] }
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThingsInBillingGroup
」の「」を参照してください。
-
次のコード例は、list-things-in-thing-group
を使用する方法を示しています。
- AWS CLI
-
グループに属するモノを一覧表示するには
次の
list-things-in-thing-group
例では、指定されたモノのグループに属するモノを一覧表示します。aws iot list-things-in-thing-group \ --thing-group-name
LightBulbs
出力:
{ "things": [ "MyLightBulb" ] }
詳細については、IoT デベロッパーガイドの「モノのグループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThingsInThingGroup
」の「」を参照してください。
-
次のコード例は、list-things
を使用する方法を示しています。
- AWS CLI
-
例 1: レジストリ内のすべてのモノを一覧表示するには
次の
list-things
例では、 AWS アカウントの AWS IoT レジストリで定義されているモノ (デバイス) を一覧表示します。aws iot list-things
出力:
{ "things": [ { "thingName": "ThirdBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/ThirdBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 2 }, { "thingName": "MyOtherLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 3 }, { "thingName": "MyLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 1 }, { "thingName": "SampleIoTThing", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/SampleIoTThing", "attributes": {}, "version": 1 } ] }
例 2: 特定の属性を持つ定義済みのモノを一覧表示するには
次の
list-things
の例は、wattage
という名前の属性を持つモノのリストを表示します。aws iot list-things \ --attribute-name
wattage
出力:
{ "things": [ { "thingName": "MyLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 1 }, { "thingName": "MyOtherLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 3 } ] }
詳細については、「AWS IoT ディベロッパーガイド」の「レジストリによるモノの管理方法」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListThings
」の「」を参照してください。
-
次の例は、list-topic-rule-destinations
を使用する方法を説明しています。
- AWS CLI
-
トピックルールの送信先を一覧表示するには
次の
list-topic-rule-destinations
例では、現在の AWS リージョンで定義したすべてのトピックルールの送信先を一覧表示します。aws iot list-topic-rule-destinations
出力:
{ "destinationSummaries": [ { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "ENABLED", "httpUrlSummary": { "confirmationUrl": "https://example.com" } } ] }
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先の使用」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListTopicRuleDestinations
」の「」を参照してください。
-
次のコード例は、list-topic-rules
を使用する方法を示しています。
- AWS CLI
-
ルールを一覧表示するには
次の
list-topic-rules
例では、定義したすべてのルールを一覧表示します。aws iot list-topic-rules
出力:
{ "rules": [ { "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", "ruleName": "MyRPiLowMoistureAlertRule", "topicPattern": "$aws/things/MyRPi/shadow/update/accepted", "createdAt": 1558624363.0, "ruleDisabled": false }, { "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyPlantPiMoistureAlertRule", "ruleName": "MyPlantPiMoistureAlertRule", "topicPattern": "$aws/things/MyPlantPi/shadow/update/accepted", "createdAt": 1541458459.0, "ruleDisabled": false } ] }
詳細については、「 IoT デベロッパーガイド」の「ルールの表示AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListTopicRules
」の「」を参照してください。
-
次の例は、list-v2-logging-levels
を使用する方法を説明しています。
- AWS CLI
-
ログ記録レベルを一覧表示するには
次の
list-v2-logging-levels
例では、設定されたログ記録レベルを一覧表示します。ログ記録レベルが設定されていない場合、このコマンドを実行するとNotConfiguredException
が発生します。aws iot list-v2-logging-levels
出力:
{ "logTargetConfigurations": [ { "logTarget": { "targetType": "DEFAULT" }, "logLevel": "ERROR" } ] }
-
API 詳細については、「 コマンドリファレンス」のListV2LoggingLevels
」を参照してください。 AWS CLI
-
次のコード例は、list-violation-events
を使用する方法を示しています。
- AWS CLI
-
期間中のセキュリティプロファイル違反を一覧表示するには
次の
list-violation-events
例では、現在の AWS アカウントと AWS リージョンのすべての AWS IoT Device Defender セキュリティプロファイルについて、2019 年 6 月 5 日から 2019 年 6 月 12 日の間に発生した違反を一覧表示します。aws iot list-violation-events \ --start-time
1559747125
\ --end-time1560351925
出力:
{ "violationEvents": [ { "violationId": "174db59167fa474c80a652ad1583fd44", "thingName": "iotconsole-1560269126751-1", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 0 }, "violationEventType": "in-alarm", "violationEventTime": 1560279000.0 }, { "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 110 }, "violationEventType": "in-alarm", "violationEventTime": 1560276600.0 }, { "violationId": "74aa393adea02e6648f3ac362beed55e", "thingName": "iotconsole-1560269232412-2", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 0 }, "violationEventType": "in-alarm", "violationEventTime": 1560276600.0 }, { "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 0 }, "violationEventType": "in-alarm", "violationEventTime": 1560276600.0 } ] }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListViolationEvents
」の「」を参照してください。
-
次のコード例は、register-ca-certificate
を使用する方法を示しています。
- AWS CLI
-
認証局 (CA) 証明書を登録するには
次の
register-ca-certificate
例では、CA 証明書を登録します。コマンドは、CA 証明書と、CA 証明書に関連付けられたプライベートキーを所有していることを証明するキー検証証明書を提供します。aws iot register-ca-certificate \ --ca-certificate
file://rootCA.pem
\ --verification-certfile://verificationCert.pem
出力:
{ "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467" }
詳細については、IoT リファレンスの「RegisterCACertificate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスRegisterCaCertificate
」の「」を参照してください。
-
次の例は、register-certificate
を使用する方法を説明しています。
- AWS CLI
-
自己署名デバイス証明書を登録するには
次の
register-certificate
例では、rootCA.pem
CA 証明書によって署名されたdeviceCert.pem
デバイス証明書を登録します。CA 証明書は、自己署名デバイス証明書の登録に使用する前に登録する必要があります。自己署名証明書は、このコマンドに渡すのと同じ CA 証明書で署名する必要があります。aws iot register-certificate \ --certificate-pem
file://deviceCert.pem
\ --ca-certificate-pemfile://rootCA.pem
出力:
{ "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" }
詳細については、AWS IoT APIリファレンスのRegisterCertificate「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスRegisterCertificate
」の「」を参照してください。
-
次の例は、register-thing
を使用する方法を説明しています。
- AWS CLI
-
モノを登録するには
次の
register-thing
例では、プロビジョニングテンプレートを使用してモノを登録します。aws iot register-thing \ --template-body '
{"Parameters":{"ThingName":{"Type":"String"},"AWS::IoT::Certificate::Id":{"Type":"String"}},"Resources": {"certificate":{"Properties":{"CertificateId":{"Ref":"AWS::IoT::Certificate::Id"},"Status":"Active"},"Type":"AWS::IoT::Certificate"},"policy":{"Properties":{"PolicyName":"MyIotPolicy"},"Type":"AWS::IoT::Policy"},"thing":{"OverrideSettings":{"AttributePayload":"MERGE","ThingGroups":"DO_NOTHING","ThingTypeName":"REPLACE"},"Properties":{"AttributePayload":{},"ThingGroups":[],"ThingName":{"Ref":"ThingName"},"ThingTypeName":"VirtualThings"},"Type":"AWS::IoT::Thing"}}}
' \ --parameters '{"ThingName":"Register-thing-trial-1","AWS::IoT::Certificate::Id":"799a9ea048a1e6aea42b55EXAMPLEf8697b4bafcd77a318a3068e30404b9233c"}
'出力:
{ "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCCAkGgAwIBAgIUYLk81I35cIppobpw HiOJ2jNjboIwDQYJKoZIhvcNAQEL\nBQAwTTFLMEkGA1UECwxCQW1hem9uIFdlYiBTZXJ2aWNlcyBPPUFtYXpvbi 5jb20g\nSW5jLiBMPVNlYXR0bGUgU1Q9V2FzaGluZ3RvbiBDPVVTMB4XDTIwMDcyMzE2NDUw\nOVoXDTQ5MTIzMT IzNTk1OVowHjEcMBoGA1UEAwwTQVdTIElvVCBDZXJ0aWZpY2F0\nZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC AQoCggEBAO71uADhdBajqTmgrMV5\nmCFfBZQRMo1MdtVoZr2X+M4MzL+RARrtUzH9a2SMAckeX8KeblIOTKzORI RDXnyE\n6lVOwjgAsd0ku22rFxex4eG2ikha7pYYkvuToqA7L3TxItRvfKrxRI4ZfJoFPip4\nKqiuBJVNOGKTcQ Hd1RNOrddwwu6kFJLeKDmEXAMPLEdUF0N+qfR9yKnZQkm+g6Q2\nGXu7u0W3hn6nlRN8qVoka0uW12p53xM7oHVz Gf+cxKBxlbOhGkp6yCfTSkUBm3Sp\n9zLw35kiHXVm4EVpwgNlnk6XcIGIkw8a/iy4pzmvuGAANY1/uU/zgCjymw ZT5S30\nBV0CAwEAAaNgMF4wHwYDVR0jBBgwFoAUGx0tCcU3q2n1WXAuUCv6hugXjKswHQYD\nVR0OBBYEFOVtvZ 9Aj2RYFnkX7Iu01XTRUdxgMAwGA1UdEwEB/wQCMAAwDgYDVR0P\nAQH/BAQDAgeAMA0GCSqGSIb3DQEBCwUAA4IB AQCXCQcpOtubS5ftOsDMTcpP/jNX\nDHyArxmjpSc2aCdmm7WX59lTKWyAdxGAvqaDVWqTo0oXI7tZ8w7aINlGi5 pXnifx\n3SBebMUoBbTktrC97yUaeL025mCFv8emDnTR/fE7PTsBKjW0g/rrfpwBxZLXDFwN\nnqkQjy3EDfifj2 6j0xYIqqWMPogyn4srOCKynS5wMJuQZlHQOnabVwnwK4Y0Mflp\np9+4susFUR9aT3BT1AcIwqSpzhlKhh4Iz7ND kRn4amsUT210jg/zOO1Ow+BTHcVQ\nJly8XDu0CWSu04q6SnaBzHmlySIajxuRTP/AdfRouP1OXe+qlbPOBcvVvF 8o\n-----END CERTIFICATE-----\n", "resourceArns": { "certificate": "arn:aws:iot:us-west-2:571032923833:cert/799a9ea048a1e6aea42b55EXAMPLEf8697b4bafcd77a318a3068e30404b9233c", "thing": "arn:aws:iot:us-west-2:571032923833:thing/Register-thing-trial-1" } }
詳細については、「 IoT Core デベロッパーガイド」の「信頼できるユーザーによるプロビジョニングAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスRegisterThing
」の「」を参照してください。
-
次のコード例は、reject-certificate-transfer
を使用する方法を示しています。
- AWS CLI
-
証明書の転送を拒否するには
次の
reject-certificate-transfer
例では、別の AWS アカウントからの指定されたデバイス証明書の転送を拒否します。aws iot reject-certificate-transfer \ --certificate-id
f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8
このコマンドでは何も出力されません。
詳細については、「 IoT Core デベロッパーガイド」の「証明書を別のアカウントに転送するAWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスRejectCertificateTransfer
」の「」を参照してください。
-
次のコード例は、remove-thing-from-billing-group
を使用する方法を示しています。
- AWS CLI
-
請求グループからモノを削除するには
次の
remove-thing-from-billing-group
例では、指定されたモノを請求グループから削除します。aws iot remove-thing-from-billing-group \ --billing-group-name
GroupOne
\ --thing-nameMyOtherLightBulb
このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスRemoveThingFromBillingGroup
」の「」を参照してください。
-
次の例は、remove-thing-from-thing-group
を使用する方法を説明しています。
- AWS CLI
-
モノをモノグループから削除するには
次の
remove-thing-from-thing-group
例では、モノグループから指定されたモノを削除します。aws iot remove-thing-from-thing-group \ --thing-name
bulb7
\ --thing-group-nameDeadBulbs
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「Thing Groups <https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html >」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスRemoveThingFromThingGroup
」の「」を参照してください。
-
次の例は、replace-topic-rule
を使用する方法を説明しています。
- AWS CLI
-
トピックのルール定義を更新するには
次の
replace-topic-rule
例では、土壌湿度レベルの測定値が低すぎるとSNSアラートを送信するように指定されたルールを更新します。aws iot replace-topic-rule \ --rule-name
MyRPiLowMoistureAlertRule
\ --topic-rule-payload "{\"sql\": \"SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\", \"description\": \"Sends an alert when soil moisture level readings are too low.\",\"actions\": [{\"sns\":{\"targetArn\":\"arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic\",\"roleArn\":\"arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole\",\"messageFormat\": \"RAW\"}}],\"ruleDisabled\": false,\"awsIotSqlVersion\":\"2016-03-23\"}"このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「IoT ルールの作成」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスReplaceTopicRule
」の「」を参照してください。
-
次の例は、search-index
を使用する方法を説明しています。
- AWS CLI
-
モノのインデックスをクエリするには
次の
search-index
例では、 タイプの を持つモノについてAWS_Things
インデックスをクエリしますLightBulb
。aws iot search-index \ --index-name
"AWS_Things"
\ --query-string"thingTypeName:LightBulb"
出力:
{ "things": [ { "thingName": "MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797", "thingTypeName": "LightBulb", "thingGroupNames": [ "LightBulbs", "DeadBulbs" ], "attributes": { "model": "123", "wattage": "75" }, "connectivity": { "connected": false } }, { "thingName": "ThirdBulb", "thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af", "thingTypeName": "LightBulb", "attributes": { "model": "123", "wattage": "75" }, "connectivity": { "connected": false } }, { "thingName": "MyOtherLightBulb", "thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11", "thingTypeName": "LightBulb", "attributes": { "model": "123", "wattage": "75" }, "connectivity": { "connected": false } } ] }
詳細については、AWS IoT デベロッパーガイドの「モノのインデックス作成の管理」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスSearchIndex
」の「」を参照してください。
-
次のコード例は、set-default-authorizer
を使用する方法を示しています。
- AWS CLI
-
デフォルトのオーソライザーを設定するには
次の
set-default-authorizer
例では、 という名前のカスタムオーソライザーをデフォルトのオーソライザーCustomAuthorizer
として設定します。aws iot set-default-authorizer \ --authorizer-name
CustomAuthorizer
出力:
{ "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" }
詳細については、AWS IoT APIリファレンスのCreateDefaultAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスSetDefaultAuthorizer
」の「」を参照してください。
-
次のコード例は、set-default-policy-version
を使用する方法を示しています。
- AWS CLI
-
ポリシーのデフォルトバージョンを設定するには
次の
set-default-policy-version
例では、 という名前のポリシー2
のデフォルトバージョンを に設定しますUpdateDeviceCertPolicy
。aws iot set-default-policy-version \ --policy-name
UpdateDeviceCertPolicy
\ --policy-version-id2
このコマンドでは何も出力されません。
-
API 詳細については、AWS CLI 「 コマンドリファレンスSetDefaultPolicyVersion
」の「」を参照してください。
-
次の例は、set-v2-logging-level
を使用する方法を説明しています。
- AWS CLI
-
モノのグループのログ記録レベルを設定するには
次の
set-v2-logging-level
例では、指定したモノのグループの警告をログに記録するようにログ記録レベルを設定します。aws iot set-v2-logging-level \ --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \ --log-level
WARN
このコマンドでは何も出力されません。
-
API 詳細については、「 コマンドリファレンス」のSetV2LoggingLevel
」を参照してください。 AWS CLI
-
次のコード例は、set-v2-logging-options
を使用する方法を示しています。
- AWS CLI
-
ログ記録オプションを設定するには
次の
set-v2-logging-options
例では、デフォルトのログ記録の詳細レベルを に設定ERRORしARN、ログ記録に使用する を指定します。aws iot set-v2-logging-options \ --default-log-level
ERROR
\ --role-arn"arn:aws:iam::094249569039:role/service-role/iotLoggingRole"
このコマンドでは何も出力されません。
-
API 詳細については、「 コマンドリファレンス」のSetV2LoggingOptions
」を参照してください。 AWS CLI
-
次の例は、start-audit-mitigation-actions-task
を使用する方法を説明しています。
- AWS CLI
-
監査の結果に緩和アクションを適用するには
次の
start-audit-mitigation-actions-task
例では、ResetPolicyVersionAction
アクション (ポリシーをクリア) を指定された単一の検出結果に適用します。aws iot start-audit-mitigation-actions-task \ --task-id
"myActionsTaskId"
\ --target "findingIds=[\"0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464\"]" \ --audit-check-to-actions-mapping "IOT_POLICY_OVERLY_PERMISSIVE_CHECK=[\"ResetPolicyVersionAction\"]" \ --client-request-token"adhadhahda"
出力:
{ "taskId": "myActionsTaskId" }
詳細については、AWS IoT デベロッパーガイドのStartAuditMitigationActionsTask 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスStartAuditMitigationActionsTask
」の「」を参照してください。
-
次のコード例は、start-on-demand-audit-task
を使用する方法を示しています。
- AWS CLI
-
監査をすぐに開始するには
次の
start-on-demand-audit-task
例では、 AWS IoT Device Defender 監査を開始し、3 つの証明書チェックを実行します。aws iot start-on-demand-audit-task \ --target-check-names
CA_CERTIFICATE_EXPIRING_CHECK
DEVICE_CERTIFICATE_EXPIRING_CHECK
REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
出力:
{ "taskId": "a3aea009955e501a31b764abe1bebd3d" }
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスStartOnDemandAuditTask
」の「」を参照してください。
-
次の例は、tag-resource
を使用する方法を説明しています。
- AWS CLI
-
リソースのタグキーと値を指定するには
次の
tag-resource
例では、 キーAssembly
と 値を持つ タグをモノのグループ に適用Fact1NW
しますLightBulbs
。aws iot tag-resource \ --tags Key=Assembly,Value="Fact1NW" \ --resource-arn
"arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs"
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイド」の「IoT リソースのタグ付け」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスTagResource
」の「」を参照してください。
-
次の例は、test-authorization
を使用する方法を説明しています。
- AWS CLI
-
AWS IoT ポリシーをテストするには
次の
test-authorization
例では、指定されたプリンシパルに関連付けられた AWS IoT ポリシーをテストします。aws iot test-authorization \ --auth-infos
actionType=CONNECT,resources=arn:aws:iot:us-east-1:123456789012:client/client1
\ --principalarn:aws:iot:us-west-2:123456789012:cert/aab1068f7f43ac3e3cae4b3a8aa3f308d2a750e6350507962e32c1eb465d9775
出力:
{ "authResults": [ { "authInfo": { "actionType": "CONNECT", "resources": [ "arn:aws:iot:us-east-1:123456789012:client/client1" ] }, "allowed": { "policies": [ { "policyName": "TestPolicyAllowed", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyAllowed" } ] }, "denied": { "implicitDeny": { "policies": [ { "policyName": "TestPolicyDenied", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyDenied" } ] }, "explicitDeny": { "policies": [ { "policyName": "TestPolicyExplicitDenied", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyExplicitDenied" } ] } }, "authDecision": "IMPLICIT_DENY", "missingContextValues": [] } ] }
詳細については、AWS IoT APIリファレンスのTestAuthorization「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスTestAuthorization
」の「」を参照してください。
-
次のコード例は、test-invoke-authorizer
を使用する方法を示しています。
- AWS CLI
-
カスタムオーソライザーをテストするには
次の
test-invoke-authorizer
例ではtestSします。aws iot test-invoke-authorizer \ --authorizer-name
IoTAuthorizer
\ --tokenallow
\ --token-signature"mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ=="
出力:
{ "isAuthenticated": true, "principalId": "principalId", "policyDocuments": [ "{"Version":"2012-10-17","Statement":[{"Action":"iot:Publish","Effect":"Allow","Resource":"arn:aws:iot:us-west-2:123456789012:topic/customauthtesting"}]}" ], "refreshAfterInSeconds": 600, "disconnectAfterInSeconds": 3600 }
詳細については、AWS IoT APIリファレンスのTestInvokeAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスTestInvokeAuthorizer
」の「」を参照してください。
-
次のコード例は、transfer-certificate
を使用する方法を示しています。
- AWS CLI
-
デバイス証明書を別の AWS アカウントに転送するには
次の
transfer-certificate
例では、デバイス証明書を別の AWS アカウントに転送します。証明書と AWS アカウントは ID で識別されます。aws iot transfer-certificate \ --certificate-id
488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142
\ --target-aws-account030714055129
出力:
{ "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" }
詳細については、「 IoT Core デベロッパーガイド」の「証明書を別のアカウントに転送AWS する IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスTransferCertificate
」の「」を参照してください。
-
次のコード例は、untag-resource
を使用する方法を示しています。
- AWS CLI
-
リソースからタグキーを削除するには
次の
untag-resource
例では、モノのグループ からタグMyTag
とその値を削除しますLightBulbs
。command
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「IoT リソースのタグ付け」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUntagResource
」の「」を参照してください。
-
次のコード例は、update-account-audit-configuration
を使用する方法を示しています。
- AWS CLI
-
例 1: 監査SNS通知の Amazon 通知を有効にするには
次の
update-account-audit-configuration
例では、 AWS IoT Device Defender 監査SNS通知の Amazon 通知を有効にし、ターゲットとそのターゲットへの書き込みに使用されるロールを指定します。aws iot update-account-audit-configuration \ --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}"
このコマンドでは何も出力されません。
例 2: 監査チェックを有効にするには
次の
update-account-audit-configuration
例では、 という名前の AWS IoT Device Defender 監査チェックを有効にしますAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
。 AWS アカウントの 1 つ以上のスケジュールされた監査targetCheckNames
の の一部である場合、監査チェックを無効にすることはできません。aws iot update-account-audit-configuration \ --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}"
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateAccountAuditConfiguration
」の「」を参照してください。
-
次のコード例は、update-audit-suppression
を使用する方法を示しています。
- AWS CLI
-
監査結果の抑制を更新するには
次の
update-audit-suppression
例では、監査結果抑制の有効期限を 2020-09-21 に更新します。aws iot update-audit-suppression \ --check-name
DEVICE_CERTIFICATE_EXPIRING_CHECK
\ --resource-identifierdeviceCertificateId=c7691e<shortened>
\ --no-suppress-indefinitely \ --expiration-date2020-09-21
このコマンドでは何も出力されません。
詳細については、「 IoT デベロッパーガイド」の「監査結果の抑制AWS IoT」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateAuditSuppression
」の「」を参照してください。
-
次のコード例は、update-authorizer
を使用する方法を示しています。
- AWS CLI
-
カスタムオーソライザーを更新するには
次の
update-authorizer
例では、 の状態をCustomAuthorizer2
から にしていますINACTIVE
。aws iot update-authorizer \ --authorizer-name
CustomAuthorizer2
\ --statusINACTIVE
出力:
{ "authorizerName": "CustomAuthorizer2", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" }
詳細については、AWS IoT APIリファレンスのUpdateAuthorizer「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateAuthorizer
」の「」を参照してください。
-
次のコード例は、update-billing-group
を使用する方法を示しています。
- AWS CLI
-
請求グループに関する情報を更新するには
次の
update-billing-group
例では、指定された請求グループの説明を更新します。aws iot update-billing-group \ --billing-group-name
GroupOne
\ --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\""出力:
{ "version": 2 }
詳細については、IoT デベロッパーガイドの「請求グループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateBillingGroup
」の「」を参照してください。
-
次のコード例は、update-ca-certificate
を使用する方法を示しています。
- AWS CLI
-
認証局 (CA) 証明書を更新するには
次の
update-ca-certificate
例では、指定された CA 証明書を ACTIVEステータスに設定します。aws iot update-ca-certificate \ --certificate-id
f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467
\ --new-statusACTIVE
このコマンドでは何も出力されません。
詳細については、IoT リファレンスの「UpdateCACertificate」を参照してください。 AWS IoT API
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateCaCertificate
」の「」を参照してください。
-
次の例は、update-certificate
を使用する方法を説明しています。
- AWS CLI
-
デバイス証明書を更新するには
次の
update-certificate
例では、指定されたデバイス証明書を INACTIVEステータスに設定します。aws iot update-certificate \ --certificate-id
d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be
\ --new-statusINACTIVE
このコマンドでは何も出力されません。
詳細については、 AWS IoT APIリファレンスのUpdateCertificate「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateCertificate
」の「」を参照してください。
-
次のコード例は、update-custom-metric
を使用する方法を示しています。
- AWS CLI
-
カスタムメトリクスを更新するには
次の
update-custom-metric
例では、カスタムメトリクスを更新して新しい を取得しますdisplay-name
。aws iot update-custom-metric \ --metric-name
batteryPercentage
\ --display-name 'remaining battery percentage on device
' \ --regionus-east-1
出力:
{ "metricName": "batteryPercentage", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage", "metricType": "number", "displayName": "remaining battery percentage on device", "creationDate": "2020-11-17T23:01:35.110000-08:00", "lastModifiedDate": "2020-11-17T23:02:12.879000-08:00" }
詳細については、「 IoT Core デベロッパーガイド」の「カスタムメトリクス」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateCustomMetric
」の「」を参照してください。
-
次のコード例は、update-dimension
を使用する方法を示しています。
- AWS CLI
-
ディメンションを更新するには
次の
update-dimension
例では、ディメンションを更新します。aws iot update-dimension \ --name
TopicFilterForAuthMessages
\ --string-valuesdevice/${iot:ClientId}/auth
出力:
{ "name": "TopicFilterForAuthMessages", "lastModifiedDate": 1585866222.317, "stringValues": [ "device/${iot:ClientId}/auth" ], "creationDate": 1585854500.474, "type": "TOPIC_FILTER", "arn": "arn:aws:iot:us-west-2:1234564789012:dimension/TopicFilterForAuthMessages" }
詳細については、AWS 「 IoT Core デベロッパーガイド」の「ディメンションを使用したセキュリティプロファイルのメトリクスのスコープ」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateDimension
」の「」を参照してください。
-
次の例は、update-domain-configuration
を使用する方法を説明しています。
- AWS CLI
-
ドメイン設定を更新するには
次の
update-domain-configuration
例では、指定されたドメイン設定を無効にします。aws iot update-domain-configuration \ --domain-configuration-name
"additionalDataDomain"
\ --domain-configuration-status"DISABLED"
出力:
{ "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" }
詳細については、AWS IoT デベロッパーガイドの「設定可能なエンドポイント」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateDomainConfiguration
」の「」を参照してください。
-
次の例は、update-dynamic-thing-group
を使用する方法を説明しています。
- AWS CLI
-
動的モノのグループを更新するには
次の
update-dynamic-thing-group
例では、指定された動的モノのグループを更新します。説明を提供し、クエリ文字列を更新してグループのメンバーシップ条件を変更します。aws iot update-dynamic-thing-group \ --thing-group-name
"RoomTooWarm"
--thing-group-properties "thingGroupDescription=\"This thing group contains rooms warmer than 65F.\"" \ --query-string"attributes.temperature>65"
出力:
{ "version": 2 }
詳細については、IoT デベロッパーガイドの「Dynamic Thing Groups」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateDynamicThingGroup
」の「」を参照してください。
-
次の例は、update-event-configurations
を使用する方法を説明しています。
- AWS CLI
-
公開されるイベントタイプを表示するには
次の
update-event-configurations
例では、CA 証明書が追加、更新、または削除されたときにメッセージを有効にするように設定を更新します。aws iot update-event-configurations \ --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「イベントメッセージ」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateEventConfigurations
」の「」を参照してください。
-
次の例は、update-indexing-configuration
を使用する方法を説明しています。
- AWS CLI
-
モノのインデックス作成を有効にするには
次の
update-indexing-configuration
例では、_ AWS Things インデックスを使用して、モノのインデックス作成がレジストリデータ、シャドウデータ、モノの接続ステータスの検索をサポートできるようにします。aws iot update-indexing-configuration --thing-indexing-configuration
thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS
このコマンドでは何も出力されません。
詳細については、IoT デベロッパーガイドの「モノのインデックス作成の管理」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateIndexingConfiguration
」の「」を参照してください。
-
次のコード例は、update-job
を使用する方法を示しています。
- AWS CLI
-
ジョブの詳細ステータスを取得するには
次の
update-job
例では、ID が のジョブの詳細ステータスを取得しますexample-job-01
。aws iot describe-job \ --job-id
"example-job-01"
出力:
{ "job": { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "targetSelection": "SNAPSHOT", "status": "IN_PROGRESS", "targets": [ "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" ], "description": "example job test", "presignedUrlConfig": {}, "jobExecutionsRolloutConfig": {}, "createdAt": 1560787022.733, "lastUpdatedAt": 1560787026.294, "jobProcessDetails": { "numberOfCanceledThings": 0, "numberOfSucceededThings": 0, "numberOfFailedThings": 0, "numberOfRejectedThings": 0, "numberOfQueuedThings": 1, "numberOfInProgressThings": 0, "numberOfRemovedThings": 0, "numberOfTimedOutThings": 0 }, "timeoutConfig": {} } }
詳細については、AWS IoT デベロッパーガイドの「ジョブの作成と管理 (CLI)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateJob
」の「」を参照してください。
-
次のコード例は、update-mitigation-action
を使用する方法を示しています。
- AWS CLI
-
緩和アクションを更新するには
次の
update-mitigation-action
例では、 という名前の指定された緩和アクションを更新しAddThingsToQuarantineGroupAction
、モノのグループ名を変更し、overrideDynamicGroups
を に設定しますfalse
。describe-mitigation-action
コマンドを使用して変更を確認できます。aws iot update-mitigation-action \ --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}"
出力:
{ "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa" }
詳細については、AWS IoT デベロッパーガイドのUpdateMitigationAction 「 (緩和アクションコマンド)」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateMitigationAction
」の「」を参照してください。
-
次の例は、update-provisioning-template
を使用する方法を説明しています。
- AWS CLI
-
プロビジョニングテンプレートを更新するには
次の
update-provisioning-template
例では、指定されたプロビジョニングテンプレートの説明とロール arn を変更し、テンプレートを有効にします。aws iot update-provisioning-template \ --template-name
widget-template
\ --enabled \ --description"An updated provisioning template for widgets"
\ --provisioning-role-arnarn:aws:iam::504350838278:role/Provision_role
このコマンドでは何も出力されません。
詳細については、AWS 「 IoT Core デベロッパーガイド」の「IoT Secure Tunneling」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateProvisioningTemplate
」の「」を参照してください。
-
次のコード例は、update-role-alias
を使用する方法を示しています。
- AWS CLI
-
ロールエイリアスを更新するには
次の
update-role-alias
例では、LightBulbRole
ロールエイリアスを更新します。aws iot update-role-alias \ --role-alias
LightBulbRole
\ --role-arnarn:aws:iam::123456789012:role/lightbulbrole-001
出力:
{ "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" }
詳細については、 AWS IoT APIリファレンスのUpdateRoleAlias「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateRoleAlias
」の「」を参照してください。
-
次のコード例は、update-scheduled-audit
を使用する方法を示しています。
- AWS CLI
-
スケジュールされた監査定義を更新するには
次の
update-scheduled-audit
例では、 AWS IoT Device Defender スケジュールされた監査のターゲットチェック名を変更します。aws iot update-scheduled-audit \ --scheduled-audit-name
WednesdayCertCheck
\ --target-check-namesCA_CERTIFICATE_EXPIRING_CHECK
DEVICE_CERTIFICATE_EXPIRING_CHECK
REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
出力:
{ "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" }
詳細については、AWS 「 IoT デベロッパーガイド」の「監査コマンド」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateScheduledAudit
」の「」を参照してください。
-
次のコード例は、update-security-profile
を使用する方法を示しています。
- AWS CLI
-
セキュリティプロファイルを変更するには
次の
update-security-profile
例では、 AWS IoT Device Defender セキュリティプロファイルの説明と動作の両方を更新します。aws iot update-security-profile \ --security-profile-name
PossibleIssue
\ --security-profile-description"Check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128"
\ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"出力:
{ "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", "securityProfileDescription": "check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128", "behaviors": [ { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "less-than", "value": { "count": 12 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } } ], "version": 2, "creationDate": 1560278102.528, "lastModifiedDate": 1560352711.207 }
詳細については、AWS IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateSecurityProfile
」の「」を参照してください。
-
次の例は、update-stream
を使用する方法を説明しています。
- AWS CLI
-
ストリームを更新するには
次の
update-stream
例では、既存のストリームを更新します。ストリームバージョンは 1 ずつ増加します。aws iot update-stream \ --cli-input-json
file://update-stream.json
update-stream.json
の内容:{ "streamId": "stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "files": [ { "fileId": 123, "s3Location": { "bucket":"codesign-ota-bucket", "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ] "roleArn": "arn:aws:iam:us-west-2:123456789012:role/service-role/my_ota_stream_role" }
出力:
{ "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "streamVersion": 2 }
詳細については、AWS IoT APIリファレンスのUpdateStream「」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateStream
」の「」を参照してください。
-
次の例は、update-thing-group
を使用する方法を説明しています。
- AWS CLI
-
モノのグループの定義を更新するには
次の
update-thing-group
例では、指定されたモノグループの定義を更新し、説明と 2 つの属性を変更します。aws iot update-thing-group \ --thing-group-name
HalogenBulbs
\ --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"出力:
{ "version": 2 }
詳細については、IoT デベロッパーガイドの「モノのグループ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateThingGroup
」の「」を参照してください。
-
次の例は、update-thing-groups-for-thing
を使用する方法を説明しています。
- AWS CLI
-
モノが属するグループを変更するには
次の
update-thing-groups-for-thing
例では、 という名前のモノを という名前のグループMyLightBulb
から削除DeadBulbs
し、replaceableItems
同時に という名前のグループに追加します。aws iot update-thing-groups-for-thing \ --thing-name
MyLightBulb
\ --thing-groups-to-add"replaceableItems"
\ --thing-groups-to-remove"DeadBulbs"
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイド」の「モノのグループ」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateThingGroupsForThing
」の「」を参照してください。
-
次の例は、update-thing
を使用する方法を説明しています。
- AWS CLI
-
モノをモノタイプに関連付けるには
次の
update-thing
例では、 AWS IoT レジストリ内のモノをモノタイプに関連付けます。関連付けを行うときは、モノのタイプで定義された属性の値を指定します。aws iot update-thing \ --thing-name
"MyOtherLightBulb"
\ --thing-type-name"LightBulb"
\ --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"このコマンドは出力を生成しません。
describe-thing
コマンドを使用して結果を表示します。詳細については、IoT デベロッパーガイドの「モノのタイプ」を参照してください。 AWS IoT
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateThing
」の「」を参照してください。
-
次の例は、update-topic-rule-destination
を使用する方法を説明しています。
- AWS CLI
-
例 1: トピックルールの送信先を有効にするには
次の
update-topic-rule-destination
例では、トピックルールの送信先へのトラフィックを有効にします。aws iot update-topic-rule-destination \ --arn
"arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
\ --statusENABLED
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先を有効にする」を参照してください。
例 2: トピックルールの送信先を無効にするには
次の
update-topic-rule-destination
例では、トピックルールの送信先へのトラフィックを無効にします。aws iot update-topic-rule-destination \ --arn
"arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
\ --statusDISABLED
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「トピックルールの送信先を無効にする」を参照してください。
例 3: 新しい確認メッセージを送信するには
次の
update-topic-rule-destination
例では、トピックルールの送信先に関する新しい確認メッセージを送信します。aws iot update-topic-rule-destination \ --arn
"arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
\ --statusIN_PROGRESS
このコマンドでは何も出力されません。
詳細については、AWS IoT デベロッパーガイドの「新しい確認メッセージの送信」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateTopicRuleDestination
」の「」を参照してください。
-
次の例は、validate-security-profile-behaviors
を使用する方法を説明しています。
- AWS CLI
-
例 1: セキュリティプロファイルの動作パラメータを検証するには
次の
validate-security-profile-behaviors
例では、 AWS IoT Device Defender セキュリティプロファイルに対して、適切に形成された正しい動作セットを検証します。aws iot validate-security-profile-behaviors \ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"
出力:
{ "valid": true, "validationErrors": [] }
例 2: セキュリティプロファイルの不正な動作パラメータを検証するには
次の
validate-security-profile-behaviors
例では、 AWS IoT Device Defender セキュリティプロファイルのエラーを含む一連の動作を検証します。aws iot validate-security-profile-behaviors \ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":100000,\"consecutiveDatapointsToClear\":1}}]"
出力:
{ "valid": false, "validationErrors": [ { "errorMessage": "Behavior Authorization is malformed. consecutiveDatapointsToAlarm 100000 should be in range[1,10]" } ] }
詳細については、AWS 「 IoT デベロッパーガイド」の「コマンドの検出」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスValidateSecurityProfileBehaviors
」の「」を参照してください。
-