Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Device Shadow REST API

Bayangan memperlihatkan hal berikut URI untuk memperbarui informasi status:

https://account-specific-prefix-ats.iot.region.amazonaws.com/things/thingName/shadow

Titik akhir khusus untuk Anda Akun AWS. Untuk menemukan titik akhir Anda, Anda dapat:

Format titik akhir adalah sebagai berikut:

identifier.iot.region.amazonaws.com

Bayangan REST API mengikuti HTTPS protokol/pemetaan port yang sama seperti yang dijelaskan dalam. Protokol komunikasi perangkat

Anda juga dapat menggunakan API untuk membuat bayangan bernama dengan menyediakan name=shadowName sebagai bagian dari parameter kueriAPI.

GetThingShadow

Mendapat bayangan untuk hal yang ditentukan.

Dokumen status respons mencakup delta antara negara reported bagian desired dan negara bagian.

Permintaan

Permintaan termasuk HTTP header standar ditambah yang berikut ini: URI

HTTP GET https://endpoint/things/thingName/shadow?name=shadowName
Request body: (none)

Parameter name kueri tidak diperlukan untuk bayangan (klasik) yang tidak disebutkan namanya.

Respons

Setelah berhasil, responsnya mencakup HTTP header standar ditambah kode dan isi berikut:

HTTP 200
Response Body: response state document

Untuk informasi selengkapnya, lihat Contoh Dokumen Status Respons.

Otorisasi

Mengambil bayangan memerlukan kebijakan yang memungkinkan pemanggil untuk melakukan tindakan. iot:GetThingShadow Layanan Device Shadow menerima dua bentuk otentikasi: Signature Version 4 dengan IAM kredensyal atau otentikasi TLS timbal balik dengan sertifikat klien.

Berikut ini adalah contoh kebijakan yang memungkinkan pemanggil untuk mengambil bayangan perangkat:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "iot:GetThingShadow",
      "Resource": [
        "arn:aws:iot:region:account:thing/thing"
      ]
    }
  ]
}

UpdateThingShadow

Memperbarui bayangan untuk hal yang ditentukan.

Pembaruan hanya memengaruhi bidang yang ditentukan dalam dokumen status permintaan. Bidang apa pun dengan nilai null dihapus dari bayangan perangkat.

Permintaan

Permintaan tersebut mencakup HTTP header standar ditambah yang berikut URI dan isi:

HTTP POST https://endpoint/things/thingName/shadow?name=shadowName
Request body: request state document

Parameter name kueri tidak diperlukan untuk bayangan (klasik) yang tidak disebutkan namanya.

Untuk informasi selengkapnya, lihat Contoh Permintaan Dokumen Negara.

Respons

Setelah berhasil, responsnya mencakup HTTP header standar ditambah kode dan isi berikut:

HTTP 200
Response body: response state document

Untuk informasi selengkapnya, lihat Contoh Dokumen Status Respons.

Otorisasi

Memperbarui bayangan memerlukan kebijakan yang memungkinkan pemanggil untuk melakukan iot:UpdateThingShadow tindakan. Layanan Device Shadow menerima dua bentuk otentikasi: Signature Version 4 dengan IAM kredensyal atau otentikasi TLS timbal balik dengan sertifikat klien.

Berikut ini adalah contoh kebijakan yang memungkinkan pemanggil memperbarui bayangan perangkat:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "iot:UpdateThingShadow",
      "Resource": [
        "arn:aws:iot:region:account:thing/thing"
      ]
    }
  ]
}

DeleteThingShadow

Menghapus bayangan untuk objek yang ditentukan.

Permintaan

Permintaan termasuk HTTP header standar ditambah yang berikut ini: URI

HTTP DELETE https://endpoint/things/thingName/shadow?name=shadowName
Request body: (none)

Parameter name kueri tidak diperlukan untuk bayangan (klasik) yang tidak disebutkan namanya.

Respons

Setelah berhasil, responsnya mencakup HTTP header standar ditambah kode dan isi berikut:

HTTP 200
Response body: Empty response state document

Perhatikan bahwa menghapus bayangan tidak mengatur ulang nomor versinya ke 0.

Otorisasi

Menghapus bayangan perangkat memerlukan kebijakan yang memungkinkan pemanggil melakukan tindakan. iot:DeleteThingShadow Layanan Device Shadow menerima dua bentuk otentikasi: Signature Version 4 dengan IAM kredensyal atau otentikasi TLS timbal balik dengan sertifikat klien.

Berikut ini adalah contoh kebijakan yang memungkinkan pemanggil menghapus bayangan perangkat:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "iot:DeleteThingShadow",
      "Resource": [
        "arn:aws:iot:region:account:thing/thing"
      ]
    }
  ]
}

ListNamedShadowsForThing

Daftar bayangan untuk hal yang ditentukan.

Permintaan

Permintaan termasuk HTTP header standar ditambah yang berikut ini: URI

HTTP GET /api/things/shadow/ListNamedShadowsForThing/thingName?nextToken=nextToken&pageSize=pageSize
Request body: (none)

Respons

Setelah berhasil, responsnya mencakup HTTP header standar ditambah kode respons berikut dan aDokumen respons daftar nama bayangan.

HTTP 200
Response body: Shadow name list document

Otorisasi

Membuat daftar bayangan perangkat memerlukan kebijakan yang memungkinkan pemanggil untuk melakukan iot:ListNamedShadowsForThing tindakan. Layanan Device Shadow menerima dua bentuk otentikasi: Signature Version 4 dengan IAM kredensyal atau otentikasi TLS timbal balik dengan sertifikat klien.

Berikut ini adalah contoh kebijakan yang memungkinkan pemanggil untuk membuat daftar bayangan bernama sesuatu:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "iot:ListNamedShadowsForThing",
      "Resource": [
        "arn:aws:iot:region:account:thing/thing"
      ]
    }
  ]
}