Device Shadow REST API - AWS IoT Core
GetThingShadowUpdateThingShadowDeleteThingShadowListNamedShadowsForThing

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Device Shadow REST API

Una sombra muestra lo siguiente URI para actualizar la información de estado:

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

El punto final es específico para usted. Cuenta de AWS Para buscar el punto de conexión, puede hacer lo siguiente:

  • Utilice el comando describe-endpoint desde la AWS CLI.

  • Utilice la configuración AWS IoT de la consola. En Configuración, el punto de conexión aparece en Punto de conexión personalizado

  • Usa la página de detalles de la AWS IoT consola. En la consola de :

    1. Abra Administrar y, en Administrar, seleccione Objetos.

    2. En la lista de cosas, elige la cosa para la que quieres obtener el punto finalURI.

    3. Seleccione la pestaña Sombras de dispositivo y seleccione la sombra. Puedes ver el terminal URI en la URL sección Device Shadow de la página de detalles de Device Shadow.

El formato del punto de enlace es el siguiente:

identifier.iot.region.amazonaws.com

La sombra REST API sigue las mismas asignaciones de HTTPS protocolos y puertos que se describen en. Protocolos de comunicación de dispositivos

nota

Para usar elAPIs, debe usarlo iotdevicegateway como nombre de servicio para la autenticación. Para obtener más información, consulte I oTData Plane.

También puede utilizar la API para crear una sombra con nombre proporcionándola name=shadowName como parte del parámetro de consulta deAPI.

GetThingShadow

Obtiene la sombra de objeto especificado.

El documento de estado de respuesta incluye el delta entre los estados desired y reported.

Solicitud

La solicitud incluye los HTTP encabezados estándar más lo siguiente: URI

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

El parámetro de consulta name no es necesario para sombras sin nombre (clásicas).

Respuesta

Si la respuesta es correcta, la respuesta incluye los HTTP encabezados estándar más el código y el cuerpo siguientes:

HTTP 200
Response Body: response state document

Para obtener más información, consulte Ejemplo de documento de estado de respuesta.

Autorización

Para recuperar una sombra, se necesita una política que permita al intermediario ejecutar la acción iot:GetThingShadow. El servicio Device Shadow acepta dos formas de autenticación: Signature Version 4 con IAM credenciales o autenticación TLS mutua con un certificado de cliente.

A continuación, se muestra una política de ejemplo que permite a un intermediario recuperar la sombra de un dispositivo:

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

UpdateThingShadow

Actualiza la sombra del objeto especificado.

Las actualizaciones solo afectan a los campos especificados en el documento de estado de la solicitud. Todos los campos que tengan el valor null se eliminarán de la sombra del dispositivo.

Solicitud

La solicitud incluye los HTTP encabezados estándar, además de lo siguiente URI y el cuerpo:

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

El parámetro de consulta name no es necesario para sombras sin nombre (clásicas).

Para obtener más información, consulte Ejemplo de documento de estado de solicitud.

Respuesta

Si la respuesta es correcta, la respuesta incluye los HTTP encabezados estándar más el código y el cuerpo siguientes:

HTTP 200
Response body: response state document

Para obtener más información, consulte Ejemplo de documento de estado de respuesta.

Autorización

Para actualizar una sombra se necesita una política que permita al intermediario ejecutar la acción iot:UpdateThingShadow. El servicio Device Shadow acepta dos formas de autenticación: Signature Version 4 con IAM credenciales o autenticación TLS mutua con un certificado de cliente.

A continuación, se muestra una política de ejemplo que permite a un intermediario actualizar la sombra de un dispositivo:

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

DeleteThingShadow

Elimina la sombra de objeto especificado.

Solicitud

La solicitud incluye los HTTP encabezados estándar además de lo siguiente: URI

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

El parámetro de consulta name no es necesario para sombras sin nombre (clásicas).

Respuesta

Si la respuesta es correcta, la respuesta incluye los HTTP encabezados estándar más el código y el cuerpo siguientes:

HTTP 200
Response body: Empty response state document

Tenga en cuenta que, al eliminar una sombra, no se restablece su número de versión a 0.

Autorización

Para eliminar la sombra de un dispositivo se necesita una política que permita al intermediario ejecutar la acción iot:DeleteThingShadow. El servicio Device Shadow acepta dos formas de autenticación: Signature Version 4 con IAM credenciales o autenticación TLS mutua con un certificado de cliente.

A continuación, se muestra una política de ejemplo que permite a un intermediario eliminar la sombra de un dispositivo:

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

ListNamedShadowsForThing

Muestra las sombras del objeto especificado.

Solicitud

La solicitud incluye los HTTP encabezados estándar además de lo siguiente: URI

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

El token para recuperar el siguiente grupo de resultados.

Este valor se devuelve en los resultados paginados y se utiliza en la llamada que devuelve la página siguiente.

pageSize

El número de nombres de sombra que devolver en cada llamada. Véase también nextToken.

thingName

El nombre del objeto para el que mostrar las sombras con nombre.

Respuesta

En caso de éxito, la respuesta incluye los HTTP encabezados estándar más el siguiente código de respuesta y un. Documento de respuesta de lista de nombres de sombra

nota

La sombra sin nombre (clásica) no aparece en esta lista. La respuesta es una lista vacía si solo tiene una sombra clásica o si el thingName que ha especificado no existe.

HTTP 200
Response body: Shadow name list document
Autorización

Para incluir la sombra de un dispositivo, se necesita una política que permita que el intermediario ejecute la acción iot:ListNamedShadowsForThing. El servicio Device Shadow acepta dos formas de autenticación: Signature Version 4 con IAM credenciales o autenticación TLS mutua con un certificado de cliente.

A continuación, se muestra una política de ejemplo que permite a un intermediario mostrar las sombras con nombre de un objeto:

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