AWS IoT SiteWise ejemplos que utilizan AWS CLI - AWS Command Line Interface
Acciones

Esta documentación es AWS CLI únicamente para la versión 1 de la versión. Para ver la documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

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.

AWS IoT SiteWise ejemplos que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with AWS IoT SiteWise.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código se muestra cómo usarloassociate-assets.

AWS CLI

Para asociar un activo secundario a un activo principal

El siguiente associate-assets ejemplo asocia un activo de turbina eólica a un activo de parque eólico, donde el modelo de activos de turbina eólica existe como una jerarquía en el modelo de activos de parque eólico.

aws iotsitewise associate-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \
    --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Asociar activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte AssociateAssetsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlobatch-associate-project-assets.

AWS CLI

Para asociar un activo a un proyecto

El siguiente batch-associate-project-assets ejemplo asocia un activo de parque eólico a un proyecto.

aws iotsitewise batch-associate-project-assets \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Añadir activos a los proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

El siguiente ejemplo de código muestra cómo usarlobatch-disassociate-project-assets.

AWS CLI

Para desasociar un activo de un proyecto

El siguiente batch-disassociate-project-assets ejemplo desvincula un activo de parque eólico de un proyecto.

aws iotsitewise batch-disassociate-project-assets \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Añadir activos a los proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

El siguiente ejemplo de código muestra cómo usarlobatch-put-asset-property-value.

AWS CLI

Para enviar datos a las propiedades de los activos

En el siguiente batch-put-asset-property-value ejemplo, se envían datos de potencia y temperatura a las propiedades de los activos identificadas por los alias de las propiedades.

aws iotsitewise batch-put-asset-property-value \
    --cli-input-json file://batch-put-asset-property-value.json

Contenidos de batch-put-asset-property-value.json:

{
    "entries": [
        {
            "entryId": "1575691200-company-windfarm-3-turbine-7-power",
            "propertyAlias": "company-windfarm-3-turbine-7-power",
            "propertyValues": [
                {
                    "value": {
                        "doubleValue": 4.92
                    },
                    "timestamp": {
                        "timeInSeconds": 1575691200
                    },
                    "quality": "GOOD"
                }
            ]
        },
        {
            "entryId": "1575691200-company-windfarm-3-turbine-7-temperature",
            "propertyAlias": "company-windfarm-3-turbine-7-temperature",
            "propertyValues": [
                {
                    "value": {
                        "integerValue": 38
                    },
                    "timestamp": {
                        "timeInSeconds": 1575691200
                    }
                }
            ]
        }
    ]
}

Salida:

{
    "errorEntries": []
}

Para obtener más información, consulte Ingesta de datos mediante el AWS IoT SiteWise API en la Guía del SiteWise usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarlocreate-access-policy.

AWS CLI

Ejemplo 1: conceder a un usuario acceso administrativo a un portal

El siguiente create-access-policy ejemplo crea una política de acceso que concede a un usuario acceso administrativo a un portal web de una empresa de parques eólicos.

aws iotsitewise create-access-policy \
    --cli-input-json file://create-portal-administrator-access-policy.json

Contenidos de create-portal-administrator-access-policy.json:

{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyResource": {
        "portal": {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
        }
    }
}

Salida:

{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE"
}

Para obtener más información, consulte Añadir o eliminar administradores de portales en la Guía del SiteWise usuario de AWS IoT.

Ejemplo 2: Para conceder a un usuario acceso de solo lectura a un proyecto

El siguiente create-access-policy ejemplo crea una política de acceso que concede a un usuario acceso de solo lectura a un proyecto de parque eólico.

aws iotsitewise create-access-policy \
    --cli-input-json file://create-project-viewer-access-policy.json

Contenidos de create-project-viewer-access-policy.json:

{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "VIEWER",
    "accessPolicyResource": {
        "project": {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
        }
    }
}

Salida:

{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE"
}

Para obtener más información, consulte Asignación de espectadores de proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte CreateAccessPolicyla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-asset-model.

AWS CLI

Para crear un modelo de activos

El siguiente create-asset-model ejemplo crea un modelo de activos que define un aerogenerador con las siguientes propiedades:

Número de serie - El número de serie de una turbineGenerated central eólica - El flujo de datos de potencia generada por un viento turbineTemperature C - El flujo de datos de temperatura de una turbina eólica en CelsiusTemperature F - Los puntos de datos de temperatura mapeados de grados Celsius a Fahrenheit

aws iotsitewise create-asset-model \
    --cli-input-json file://create-wind-turbine-model.json

Contenidos de create-wind-turbine-model.json:

{
    "assetModelName": "Wind Turbine Model",
    "assetModelDescription": "Represents a wind turbine",
    "assetModelProperties": [
        {
            "name": "Serial Number",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "name": "Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature C",
            "dataType": "DOUBLE",
            "unit": "Celsius",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature F",
            "dataType": "DOUBLE",
            "unit": "Fahrenheit",
            "type": {
                "transform": {
                    "expression": "temp_c * 9 / 5 + 32",
                    "variables": [
                        {
                            "name": "temp_c",
                            "value": {
                                "propertyId": "Temperature C"
                            }
                        }
                    ]
                }
            }
        },
        {
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "propertyId": "Generated Power"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ]
}

Salida:

{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "assetModelStatus": {
        "state": "CREATING"
    }
}

Para obtener más información, consulte Definir modelos de activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte CreateAssetModella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-asset.

AWS CLI

Para crear un activo

El siguiente create-asset ejemplo crea un activo de turbina eólica a partir de un modelo de activos de turbina eólica.

aws iotsitewise create-asset \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --asset-name "Wind Turbine 1"

Salida:

{
    "assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
    "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
    "assetStatus": {
        "state": "CREATING"
    }
}

Para obtener más información, consulte Creación de activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte CreateAssetla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-dashboard.

AWS CLI

Para crear un panel

En el siguiente create-dashboard ejemplo, se crea un cuadro de mando con un gráfico de líneas que muestra la potencia total generada por un parque eólico.

aws iotsitewise create-dashboard \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --dashboard-name "Wind Farm" \
    --dashboard-definition file://create-wind-farm-dashboard.json

Contenidos de create-wind-farm-dashboard.json:

{
    "widgets": [
        {
            "type": "monitor-line-chart",
            "title": "Generated Power",
            "x": 0,
            "y": 0,
            "height": 3,
            "width": 3,
            "metrics": [
                {
                    "label": "Power",
                    "type": "iotsitewise",
                    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
                    "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE"
                }
            ]
        }
    ]
}

Salida:

{
    "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
    "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE"
}

Para obtener más información, consulte Creación de paneles (CLI) en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte CreateDashboardla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-gateway.

AWS CLI

Para crear una puerta de enlace

El siguiente create-gateway ejemplo crea una puerta de enlace que se ejecuta en AWS IoT Greengrass.

aws iotsitewise create-gateway \
    --gateway-name ExampleCorpGateway \
    --gateway-platform greengrass={groupArn=arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE}

Salida:

{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE"
}

Para obtener más información, consulte Configuración de una puerta de enlace en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte CreateGatewayla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-portal.

AWS CLI

Para crear un portal

El siguiente create-portal ejemplo crea un portal web para una empresa de parques eólicos. Solo puede crear portales en la misma región en la que haya activado el inicio de sesión AWS único.

aws iotsitewise create-portal \
    --portal-name WindFarmPortal \
    --portal-description "A portal that contains wind farm projects for Example Corp." \
    --portal-contact-email support@example.com \
    --role-arn arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole

Salida:

{
    "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws",
    "portalStatus": {
        "state": "CREATING"
    },
    "ssoApplicationId": "ins-a1b2c3d4-EXAMPLE"
}

Para obtener más información, consulte Introducción a AWS IoT SiteWise Monitor en la Guía del SiteWise usuario de AWS IoT y Habilitación AWS SSO en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte CreatePortalla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-project.

AWS CLI

Para crear un proyecto

El siguiente create-project ejemplo crea un proyecto de parque eólico.

aws iotsitewise create-project \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \
    --project-name "Wind Farm 1" \
    --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp."

Salida:

{
    "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
}

Para obtener más información, consulte Creación de proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte CreateProjectla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-access-policy.

AWS CLI

Para revocar el acceso de un usuario a un proyecto o portal

En el siguiente delete-access-policy ejemplo, se elimina una política de acceso que concede a un usuario acceso administrativo a un portal.

aws iotsitewise delete-access-policy \
    --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Añadir o eliminar administradores de portales en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DeleteAccessPolicyla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-asset-model.

AWS CLI

Para eliminar un modelo de activos

En el siguiente delete-asset-model ejemplo, se elimina un modelo de activos de una turbina eólica.

aws iotsitewise delete-asset-model \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Salida:

{
    "assetModelStatus": {
        "state": "DELETING"
    }
}

Para obtener más información, consulte Eliminar modelos de activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DeleteAssetModella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-asset.

AWS CLI

Para eliminar un activo

En el siguiente delete-asset ejemplo, se elimina un activo de aerogenerador.

aws iotsitewise delete-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

Salida:

{
    "assetStatus": {
        "state": "DELETING"
    }
}

Para obtener más información, consulte Eliminar activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DeleteAssetla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-dashboard.

AWS CLI

Para eliminar un panel

En el siguiente delete-dashboard ejemplo, se elimina el panel de control de un aerogenerador.

aws iotsitewise delete-dashboard \
    --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar paneles en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte DeleteDashboardla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-gateway.

AWS CLI

Para eliminar una puerta de enlace

En el siguiente delete-gateway ejemplo, se elimina una puerta de enlace.

aws iotsitewise delete-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Ingesta de datos mediante una puerta de enlace en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DeleteGatewayla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-portal.

AWS CLI

Para eliminar un portal

En el siguiente delete-portal ejemplo, se elimina un portal web de una empresa de parques eólicos.

aws iotsitewise delete-portal \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

Salida:

{
    "portalStatus": {
        "state": "DELETING"
    }
}

Para obtener más información, consulte Eliminar un portal en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DeletePortalla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-project.

AWS CLI

Para eliminar un proyecto

En el siguiente delete-project ejemplo, se elimina un proyecto de parque eólico.

aws iotsitewise delete-project \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte DeleteProjectla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-access-policy.

AWS CLI

Para describir una política de acceso

El siguiente describe-access-policy ejemplo describe una política de acceso que concede a un usuario acceso administrativo a un portal web de una empresa de parques eólicos.

aws iotsitewise describe-access-policy \
    --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE

Salida:

{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyResource": {
        "portal": {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyCreationDate": "2020-02-20T22:35:15.552880124Z",
    "accessPolicyLastUpdateDate": "2020-02-20T22:35:15.552880124Z"
}

Para obtener más información, consulte Añadir o eliminar administradores de portales en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DescribeAccessPolicyla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-asset-model.

AWS CLI

Para describir un modelo de activos

El siguiente describe-asset-model ejemplo describe un modelo de activos de parque eólico.

aws iotsitewise describe-asset-model \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Salida:

{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelName": "Wind Farm Model",
    "assetModelDescription": "Represents a wind farm that comprises many wind turbines",
    "assetModelProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE",
                                "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING",
            "type": {
                "attribute": {
                    "defaultValue": " "
                }
            }
        }
    ],
    "assetModelHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines",
            "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
        }
    ],
    "assetModelCreationDate": 1575671284.0,
    "assetModelLastUpdateDate": 1575671988.0,
    "assetModelStatus": {
        "state": "ACTIVE"
    }
}

Para obtener más información, consulte Descripción de un modelo de activo específico en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DescribeAssetModella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-asset-property.

AWS CLI

Para describir una propiedad de un activo

El siguiente describe-asset-property ejemplo describe la propiedad de potencia total generada de un activo de parque eólico.

aws iotsitewise describe-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-99999EXAMPLE

Salida:

{
    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetName": "Wind Farm 1",
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetProperty": {
        "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
        "name": "Total Generated Power",
        "notification": {
            "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "state": "DISABLED"
        },
        "dataType": "DOUBLE",
        "unit": "kW",
        "type": {
            "metric": {
                "expression": "sum(power)",
                "variables": [
                    {
                        "name": "power",
                        "value": {
                            "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE",
                            "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
                        }
                    }
                ],
                "window": {
                    "tumbling": {
                        "interval": "1h"
                    }
                }
            }
        }
    }
}

Para obtener más información, consulte Descripción de una propiedad de activo específica en la Guía del SiteWise usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarlodescribe-asset.

AWS CLI

Para describir un activo

El siguiente describe-asset ejemplo describe un activo de parque eólico.

aws iotsitewise describe-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

Salida:

{
    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetName": "Wind Farm 1",
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING"
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW"
        }
    ],
    "assetHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines"
        }
    ],
    "assetCreationDate": 1575672453.0,
    "assetLastUpdateDate": 1575672453.0,
    "assetStatus": {
        "state": "ACTIVE"
    }
}

Para obtener más información, consulte Descripción de un activo específico en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DescribeAssetla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-dashboard.

AWS CLI

Para describir un panel

El siguiente describe-dashboard ejemplo describe el panel de control del parque eólico especificado.

aws iotsitewise describe-dashboard \
    --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE

Salida:

{
    "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
    "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
    "dashboardName": "Wind Farm",
    "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "dashboardDefinition": "{\"widgets\":[{\"type\":\"monitor-line-chart\",\"title\":\"Generated Power\",\"x\":0,\"y\":0,\"height\":3,\"width\":3,\"metrics\":[{\"label\":\"Power\",\"type\":\"iotsitewise\",\"assetId\":\"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE\",\"propertyId\":\"a1b2c3d4-5678-90ab-cdef-99999EXAMPLE\"}]}]}",
    "dashboardCreationDate": "2020-05-01T20:32:12.228476348Z",
    "dashboardLastUpdateDate": "2020-05-01T20:32:12.228476348Z"
}

Para obtener más información, consulte Visualización de paneles en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte DescribeDashboardla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-gateway-capability-configuration.

AWS CLI

Para describir la capacidad de una puerta de enlace

El siguiente describe-gateway-capability-configuration ejemplo describe una capacidad de fuente OPC -UA.

aws iotsitewise describe-gateway-capability-configuration \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
    --capability-namespace "iotsitewise:opcuacollector:1"

Salida:

{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "capabilityNamespace": "iotsitewise:opcuacollector:1",
    "capabilityConfiguration": "{\"sources\":[{\"name\":\"Wind Farm #1\",\"endpoint\":{\"certificateTrust\":{\"type\":\"TrustAny\"},\"endpointUri\":\"opc.tcp://203.0.113.0:49320\",\"securityPolicy\":\"BASIC256\",\"messageSecurityMode\":\"SIGN_AND_ENCRYPT\",\"identityProvider\":{\"type\":\"Username\",\"usernameSecretArn\":\"arn:aws:secretsmanager:us-east-1:123456789012:secret:greengrass-factory1-auth-3QNDmM\"},\"nodeFilterRules\":[]},\"measurementDataStreamPrefix\":\"\"}]}",
    "capabilitySyncStatus": "IN_SYNC"
}

Para obtener más información, consulte Configuración de fuentes de datos en la Guía del SiteWise usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarlodescribe-gateway.

AWS CLI

Para describir una puerta de enlace

El siguiente describe-gateway ejemplo describe una puerta de enlace.

aws iotsitewise describe-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE

Salida:

{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayName": "ExampleCorpGateway",
    "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayPlatform": {
        "greengrass": {
            "groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE"
        }
    },
    "gatewayCapabilitySummaries": [
        {
            "capabilityNamespace": "iotsitewise:opcuacollector:1",
            "capabilitySyncStatus": "IN_SYNC"
        }
    ],
    "creationDate": 1588369971.457,
    "lastUpdateDate": 1588369971.457
}

Para obtener más información, consulte Ingesta de datos mediante una puerta de enlace en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DescribeGatewayla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-logging-options.

AWS CLI

Para recuperar las opciones de SiteWise registro de AWS IoT actuales

El siguiente describe-logging-options ejemplo recupera las opciones de SiteWise registro de AWS IoT actuales para su AWS cuenta en la región actual.

aws iotsitewise describe-logging-options

Salida:

{
    "loggingOptions": {
        "level": "INFO"
    }
}

Para obtener más información, consulte Supervisión de AWS IoT SiteWise con Amazon CloudWatch Logs en la Guía del SiteWise usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarlodescribe-portal.

AWS CLI

Para describir un portal

El siguiente describe-portal ejemplo describe un portal web para una empresa de parques eólicos.

aws iotsitewise describe-portal \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

Salida:

{
    "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalName": "WindFarmPortal",
    "portalDescription": "A portal that contains wind farm projects for Example Corp.",
    "portalClientId": "E-a1b2c3d4e5f6_a1b2c3d4e5f6EXAMPLE",
    "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws",
    "portalContactEmail": "support@example.com",
    "portalStatus": {
        "state": "ACTIVE"
    },
    "portalCreationDate": "2020-02-04T23:01:52.90248068Z",
    "portalLastUpdateDate": "2020-02-04T23:01:52.90248078Z",
    "roleArn": "arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole"
}

Para obtener más información, consulte Administrar sus portales en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DescribePortalla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodescribe-project.

AWS CLI

Para describir un proyecto

El siguiente describe-project ejemplo describe un proyecto de parque eólico.

aws iotsitewise describe-project \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

Salida:

{
    "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "projectName": "Wind Farm 1",
    "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "projectDescription": "Contains asset visualizations for Wind Farm #1 for Example Corp.",
    "projectCreationDate": "2020-02-20T21:58:43.362246001Z",
    "projectLastUpdateDate": "2020-02-20T21:58:43.362246095Z"
}

Para obtener más información, consulte Visualización de los detalles del proyecto en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte DescribeProjectla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodisassociate-assets.

AWS CLI

Para desasociar un activo secundario de un activo principal

El siguiente disassociate-assets ejemplo disocia un activo de turbina eólica de un activo de parque eólico.

aws iotsitewise disassociate-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \
    --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Asociar activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte DisassociateAssetsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-asset-property-aggregates.

AWS CLI

Para recuperar el promedio agregado y los valores de recuento de una propiedad

El siguiente get-asset-property-aggregates ejemplo recupera la potencia total media de un activo de turbina eólica y el recuento de los puntos de datos de potencia total durante un período de 1 hora.

aws iotsitewise get-asset-property-aggregates \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --start-date 1580849400 \
    --end-date 1580853000 \
    --aggregate-types AVERAGE COUNT \
    --resolution 1h

Salida:

{
    "aggregatedValues": [
        {
            "timestamp": 1580850000.0,
            "quality": "GOOD",
            "value": {
                "average": 8723.46538886233,
                "count": 12.0
            }
        }
    ]
}

Para obtener más información, consulte Consulta los agregados de propiedades de los activos en la Guía SiteWise del usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarloget-asset-property-value-history.

AWS CLI

Para recuperar los valores históricos de una propiedad de un activo

El siguiente get-asset-property-value-history ejemplo recupera los valores de potencia total de un activo de turbina eólica durante un período de 20 minutos.

aws iotsitewise get-asset-property-value-history \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --start-date 1580851800 \
    --end-date 1580853000

Salida:

{
    "assetPropertyValueHistory": [
        {
            "value": {
                "doubleValue": 7217.787046814844
            },
            "timestamp": {
                "timeInSeconds": 1580852100,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        },
        {
            "value": {
                "doubleValue": 6941.242811875451
            },
            "timestamp": {
                "timeInSeconds": 1580852400,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        },
        {
            "value": {
                "doubleValue": 6976.797662266717
            },
            "timestamp": {
                "timeInSeconds": 1580852700,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        },
        {
            "value": {
                "doubleValue": 6890.8677520453875
            },
            "timestamp": {
                "timeInSeconds": 1580853000,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        }
    ]
}

Para obtener más información, consulte Consulta los valores históricos de las propiedades de los activos en la Guía del SiteWise usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarloget-asset-property-value.

AWS CLI

Para recuperar el valor actual de una propiedad de un activo

El siguiente get-asset-property-value ejemplo recupera la potencia total actual de un activo de turbina eólica.

aws iotsitewise get-asset-property-value \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE

Salida:

{
    "propertyValue": {
        "value": {
            "doubleValue": 6890.8677520453875
        },
        "timestamp": {
            "timeInSeconds": 1580853000,
            "offsetInNanos": 0
        },
        "quality": "GOOD"
    }
}

Para obtener más información, consulte Consulta los valores actuales de las propiedades de los activos en la Guía del SiteWise usuario de AWS IoT.

El siguiente ejemplo de código muestra cómo usarlolist-access-policies.

AWS CLI

Para enumerar todas las políticas de acceso

En el siguiente list-access-policies ejemplo, se enumeran todas las políticas de acceso de un usuario que es administrador del portal.

aws iotsitewise list-access-policies \
    --identity-type USER \
    --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE

Salida:

{
    "accessPolicySummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
            "identity": {
                "user": {
                    "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
                }
            },
            "resource": {
                "portal": {
                    "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
                }
            },
            "permission": "ADMINISTRATOR"
        }
    ]
}

Para obtener más información, consulte Administrar sus portales en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListAccessPoliciesla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-asset-models.

AWS CLI

Para enumerar todos los modelos de activos

El siguiente list-asset-models ejemplo muestra todos los modelos de activos que están definidos en su AWS cuenta en la región actual.

aws iotsitewise list-asset-models

Salida:

{
    "assetModelSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "name": "Wind Farm Model",
            "description": "Represents a wind farm that comprises many wind turbines",
            "creationDate": 1575671284.0,
            "lastUpdateDate": 1575671988.0,
            "status": {
                "state": "ACTIVE"
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "name": "Wind Turbine Model",
            "description": "Represents a wind turbine manufactured by Example Corp",
            "creationDate": 1575671207.0,
            "lastUpdateDate": 1575686273.0,
            "status": {
                "state": "ACTIVE"
            }
        }
    ]
}

Para obtener más información, consulte Listar todos los modelos de activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListAssetModelsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-assets.

AWS CLI

Ejemplo 1: Para enumerar todos los activos de nivel superior

En el siguiente list-assets ejemplo, se enumeran todos los activos que ocupan el primer nivel del árbol jerárquico de activos y están definidos en su AWS cuenta en la región actual.

aws iotsitewise list-assets \
    --filter TOP_LEVEL

Salida:

{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
            "name": "Wind Farm 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "creationDate": 1575672453.0,
            "lastUpdateDate": 1575672453.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": [
                {
                    "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
                    "name": "Wind Turbines"
                }
            ]
        }
    ]
}

Para obtener más información, consulta Cómo enumerar activos en la Guía del SiteWise usuario de AWS IoT.

Ejemplo 2: Para enumerar todos los activos en función de un modelo de activos

En el siguiente list-assets ejemplo, se enumeran todos los activos según un modelo de activos y definidos en su AWS cuenta en la región actual.

aws iotsitewise list-assets \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Salida:

{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "name": "Wind Turbine 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "creationDate": 1575671550.0,
            "lastUpdateDate": 1575686308.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": []
        }
    ]
}

Para obtener más información, consulta Cómo enumerar activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListAssetsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-associated-assets.

AWS CLI

Para enumerar todos los activos asociados a un activo en una jerarquía específica

En el siguiente list-associated-assets ejemplo, se enumeran todos los activos de aerogeneradores asociados al activo de parque eólico especificado.

aws iotsitewise list-associated-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE

Salida:

{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "name": "Wind Turbine 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "creationDate": 1575671550.0,
            "lastUpdateDate": 1575686308.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": []
        }
    ]
}

Para obtener más información, consulte Listar los activos asociados a un activo específico en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListAssociatedAssetsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-dashboards.

AWS CLI

Para enumerar todos los paneles de un proyecto

En el siguiente list-dashboards ejemplo, se enumeran todos los paneles que están definidos en un proyecto.

aws iotsitewise list-dashboards \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

Salida:

{
    "dashboardSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
            "name": "Wind Farm",
            "creationDate": "2020-05-01T20:32:12.228476348Z",
            "lastUpdateDate": "2020-05-01T20:32:12.228476348Z"
        }
    ]
}

Para obtener más información, consulte Visualización de paneles en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte ListDashboardsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-gateways.

AWS CLI

Para enumerar todas las puertas de enlace

En el siguiente list-gateways ejemplo, se enumeran todas las puertas de enlace que están definidas en su AWS cuenta en la región actual.

aws iotsitewise list-gateways

Salida:

{
    "gatewaySummaries": [
        {
            "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
            "gatewayName": "ExampleCorpGateway",
            "gatewayCapabilitySummaries": [
                {
                    "capabilityNamespace": "iotsitewise:opcuacollector:1",
                    "capabilitySyncStatus": "IN_SYNC"
                }
            ],
            "creationDate": 1588369971.457,
            "lastUpdateDate": 1588369971.457
        }
    ]
}

Para obtener más información, consulte Ingesta de datos mediante una puerta de enlace en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListGatewaysla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-portals.

AWS CLI

Para enumerar todos los portales

En el siguiente list-portals ejemplo, se enumeran todos los portales que están definidos en su AWS cuenta en la región actual.

aws iotsitewise list-portals

Salida:

{
    "portalSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
            "name": "WindFarmPortal",
            "description": "A portal that contains wind farm projects for Example Corp.",
            "startUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws",
            "creationDate": "2020-02-04T23:01:52.90248068Z",
            "lastUpdateDate": "2020-02-04T23:01:52.90248078Z",
            "roleArn": "arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole"
        }
    ]
}

Para obtener más información, consulte Administrar sus portales en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListPortalsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlolist-project-assets.

AWS CLI

Para enumerar todos los activos asociados a un proyecto

El siguiente list-project-assets ejemplo muestra todos los activos que están asociados a un proyecto de parque eólico.

aws iotsitewise list-projects \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

Salida:

{
    "assetIds": [
        "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"
    ]
}

Para obtener más información, consulte Añadir activos a los proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte ListProjectAssetsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlolist-projects.

AWS CLI

Para enumerar todos los proyectos de un portal

En el siguiente list-projects ejemplo, se enumeran todos los proyectos que están definidos en un portal.

aws iotsitewise list-projects \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

Salida:

{
    "projectSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
            "name": "Wind Farm 1",
            "description": "Contains asset visualizations for Wind Farm #1 for Example Corp.",
            "creationDate": "2020-02-20T21:58:43.362246001Z",
            "lastUpdateDate": "2020-02-20T21:58:43.362246095Z"
        }
    ]
}

Para obtener más información, consulte Visualización de los detalles del proyecto en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte ListProjectsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlolist-tags-for-resource.

AWS CLI

Para enumerar todas las etiquetas de un recurso

En el siguiente list-tags-for-resource ejemplo, se enumeran todas las etiquetas de un activo de turbina eólica.

aws iotsitewise list-tags-for-resource \
    --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

Salida:

{
    "tags": {
        "Owner": "richard-roe"
    }
}

Para obtener más información, consulte Etiquetar sus recursos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloput-logging-options.

AWS CLI

Para especificar el nivel de registro

El siguiente put-logging-options ejemplo habilita INFO el registro de niveles en AWS IoT SiteWise. Otros niveles incluyen DEBUG yOFF.

aws iotsitewise put-logging-options \
    --logging-options level=INFO

Este comando no genera ninguna salida.

Para obtener más información, consulte Supervisión de AWS IoT SiteWise con Amazon CloudWatch Logs en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte PutLoggingOptionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlotag-resource.

AWS CLI

Cómo añadir una etiqueta a un recurso

En el siguiente tag-resource ejemplo, se añade una etiqueta de propietario a un activo de turbina eólica. Esto le permite controlar el acceso al activo en función de quién es su propietario.

aws iotsitewise tag-resource \
    --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --tags Owner=richard-roe

Este comando no genera ninguna salida.

Para obtener más información, consulte Etiquetar sus recursos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte TagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlountag-resource.

AWS CLI

Para eliminar una etiqueta de un recurso

En el siguiente untag-resource ejemplo, se elimina una etiqueta de propietario de un activo de aerogenerador.

aws iotsitewise untag-resource \
    --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --tag-keys Owner

Este comando no genera ninguna salida.

Para obtener más información, consulte Etiquetar sus recursos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UntagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-access-policy.

AWS CLI

Para conceder a un espectador de proyectos la propiedad de un proyecto

El siguiente update-access-policy ejemplo actualiza una política de acceso que otorga a un espectador de proyectos la propiedad de un proyecto.

aws iotsitewise update-access-policy \
    --access-policy-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE \
    --cli-input-json file://update-project-viewer-access-policy.json

Contenidos de update-project-viewer-access-policy.json:

{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyResource": {
        "project": {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
        }
    }
}

Este comando no genera ninguna salida.

Para obtener más información, consulte Asignación de propietarios de proyectos en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte UpdateAccessPolicyla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-asset-model.

AWS CLI

Para actualizar un modelo de activos

El siguiente update-asset-model ejemplo actualiza la descripción del modelo de activos de un parque eólico. Este ejemplo incluye el modelo existente IDs y las definiciones, ya que update-asset-model sobrescribe el modelo existente con el nuevo modelo.

aws iotsitewise update-asset-model \
    --cli-input-json file://update-wind-farm-model.json

Contenidos de update-wind-farm-model.json:

{
    "assetModelName": "Wind Farm Model",
    "assetModelDescription": "Represents a wind farm that comprises many wind turbines",
    "assetModelProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
                                "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ],
    "assetModelHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines",
            "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
        }
    ]
}

Salida:

{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelStatus": {
        "state": "CREATING"
    }
}

Para obtener más información, consulte Actualización de modelos de activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UpdateAssetModella Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-asset-property.

AWS CLI

Ejemplo 1: Para actualizar el alias de una propiedad de un activo

El siguiente update-asset-property ejemplo actualiza el alias de la propiedad de energía de un activo de turbina eólica.

aws iotsitewise update-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-55555EXAMPLE \
    --property-alias "/examplecorp/windfarm/1/turbine/1/power" \
    --property-notification-state DISABLED

Este comando no genera ninguna salida.

Para obtener más información, consulte Asignación de flujos de datos industriales a propiedades de activos en la Guía del SiteWise usuario de AWS IoT.

Ejemplo 2: Para habilitar las notificaciones de propiedades de activos

El siguiente update-asset-property ejemplo habilita las notificaciones de actualización de propiedades de activos para la propiedad de energía de un activo de aerogenerador. Las actualizaciones del valor de las propiedades se publican en el MQTT tema$aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, donde cada identificador se sustituye por el identificador de propiedad, activo y modelo de la propiedad del activo.

aws iotsitewise update-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --property-notification-state ENABLED \
    --property-alias "/examplecorp/windfarm/1/turbine/1/power"

Este comando no genera ninguna salida.

Para obtener más información, consulte Interactuar con otros servicios en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UpdateAssetPropertyla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-asset.

AWS CLI

Para actualizar el nombre de un activo

En el siguiente update-asset ejemplo, se actualiza el nombre de un activo de aerogenerador.

aws iotsitewise update-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --asset-name "Wind Turbine 2"

Salida:

{
    "assetStatus": {
        "state": "UPDATING"
    }
}

Para obtener más información, consulte Actualización de activos en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UpdateAssetla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-dashboard.

AWS CLI

Para actualizar un panel

El siguiente update-dashboard ejemplo cambia el título del gráfico de líneas de un cuadro de mando que muestra la potencia total generada por un parque eólico.

aws iotsitewise update-dashboard \
    --project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \
    --dashboard-name "Wind Farm" \
    --dashboard-definition file://update-wind-farm-dashboard.json

Contenidos de update-wind-farm-dashboard.json:

{
    "widgets": [
        {
            "type": "monitor-line-chart",
            "title": "Total Generated Power",
            "x": 0,
            "y": 0,
            "height": 3,
            "width": 3,
            "metrics": [
                {
                    "label": "Power",
                    "type": "iotsitewise",
                    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
                    "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE"
                }
            ]
        }
    ]
}

Este comando no genera ninguna salida.

Para obtener más información, consulte Creación de paneles (CLI) en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UpdateDashboardla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-gateway-capability-configuration.

AWS CLI

Para actualizar la capacidad de una puerta de enlace

El siguiente update-gateway-capability-configuration ejemplo configura una fuente OPC -UA con las siguientes propiedades:

Confía en cualquier certificado. Utiliza el algoritmo Basic256 para proteger los mensajes. Utiliza el SignAndEncrypt modo para proteger las conexiones. Utiliza las credenciales de autenticación almacenadas en un secreto de Secrets Manager. AWS 

aws iotsitewise update-gateway-capability-configuration \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
    --capability-namespace "iotsitewise:opcuacollector:1" \
    --capability-configuration file://opc-ua-capability-configuration.json

Contenidos de opc-ua-capability-configuration.json:

{
    "sources": [
        {
            "name": "Wind Farm #1",
            "endpoint": {
                "certificateTrust": {
                    "type": "TrustAny"
                },
                "endpointUri": "opc.tcp://203.0.113.0:49320",
                "securityPolicy": "BASIC256",
                "messageSecurityMode": "SIGN_AND_ENCRYPT",
                "identityProvider": {
                    "type": "Username",
                    "usernameSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-windfarm1-auth-1ABCDE"
                },
                "nodeFilterRules": []
            },
            "measurementDataStreamPrefix": ""
        }
    ]
}

Salida:

{
    "capabilityNamespace": "iotsitewise:opcuacollector:1",
    "capabilitySyncStatus": "OUT_OF_SYNC"
}

Para obtener más información, consulte Configuración de fuentes de datos en la Guía del SiteWise usuario de AWS IoT.

En el siguiente ejemplo de código se muestra cómo usarloupdate-gateway.

AWS CLI

Para actualizar el nombre de una puerta de enlace

En el siguiente update-gateway ejemplo, se actualiza el nombre de una puerta de enlace.

aws iotsitewise update-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
    --gateway-name ExampleCorpGateway1

Este comando no genera ninguna salida.

Para obtener más información, consulte Ingesta de datos mediante una puerta de enlace en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UpdateGatewayla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-portal.

AWS CLI

Para actualizar los detalles de un portal

En el siguiente update-portal ejemplo, se actualiza el portal web de una empresa de parques eólicos.

aws iotsitewise update-portal \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \
    --portal-name WindFarmPortal \
    --portal-description "A portal that contains wind farm projects for Example Corp." \
    --portal-contact-email support@example.com \
    --role-arn arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole

Salida:

{
    "portalStatus": {
        "state": "UPDATING"
    }
}

Para obtener más información, consulte Administrar sus portales en la Guía del SiteWise usuario de AWS IoT.

  • Para API obtener más información, consulte UpdatePortalla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloupdate-project.

AWS CLI

Para actualizar los detalles de un proyecto

El siguiente update-project ejemplo actualiza un proyecto de parque eólico.

aws iotsitewise update-project \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --project-name "Wind Farm 1" \
    --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp."

Este comando no genera ninguna salida.

Para obtener más información, consulte Cambiar los detalles del proyecto en la Guía de aplicaciones de AWS IoT SiteWise Monitor.

  • Para API obtener más información, consulte UpdateProjectla Referencia de AWS CLI comandos.