# AWS IoT SiteWise Ejemplos de usando AWS CLI
En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con 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 distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `associate-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `associate-assets`.
**AWS CLI**
**Para asociar un activo secundario a un activo principal**
En el siguiente ejemplo de `associate-assets`, se 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 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 [Associating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [AssociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/associate-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `batch-associate-project-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `batch-associate-project-assets`.
**AWS CLI**
**Para asociar un activo a un proyecto**
En el siguiente ejemplo de `batch-associate-project-assets`, se 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 [Adding assets to projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [BatchAssociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-associate-project-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `batch-disassociate-project-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `batch-disassociate-project-assets`.
**AWS CLI**
**Para desasociar un activo de un proyecto**
En el siguiente ejemplo de `batch-disassociate-project-assets`, se 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 [Adding assets to projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [BatchDisassociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-disassociate-project-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `batch-put-asset-property-value`
En el siguiente ejemplo de código, se muestra cómo utilizar `batch-put-asset-property-value`.
**AWS CLI**
**Para enviar datos a propiedades de los activos**
En el siguiente ejemplo de `batch-put-asset-property-value`, 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
```
Contenido 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 [Ingesting data using the AWS IoT SiteWise API](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html) en la *Referencia de comandos de la AWS CLI*.
### `create-access-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-access-policy`.
**AWS CLI**
**Ejemplo 1: concesión a un usuario de acceso administrativo a un portal**
En el siguiente ejemplo de `create-access-policy`, se 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
```
Contenido 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 [Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) en la *Guía del usuario de AWS IoT SiteWise*.
**Ejemplo 2: concesión al usuario acceso de solo lectura a un proyecto**
En el siguiente ejemplo de `create-access-policy`, se 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
```
Contenido 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 [Assigning project viewers](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-viewers.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [CreateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-access-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `create-asset-model`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-asset-model`.
**AWS CLI**
**Para crear un modelo de activos**
En el siguiente ejemplo de `create-asset-model`, se crea un modelo de activos que define una turbina eólica con las siguientes propiedades:
Número de serie: es el número de serie de una turbina eólica. Potencia generada: es el flujo de datos de energía generada por una turbina eólica. Temperatura C: es el flujo de datos de temperatura de una turbina eólica en grados Celsius. Temperatura F: son los puntos de datos de temperatura asignados desde Celsius a Fahrenheit.
```
aws iotsitewise create-asset-model \
--cli-input-json file://create-wind-turbine-model.json
```
Contenido 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 [Defining asset models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html) en la *Referencia de comandos de la AWS CLI*.
### `create-asset`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-asset`.
**AWS CLI**
**Para crear un activo**
En el siguiente ejemplo de `create-asset`, se 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 [Creating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html) en la *Referencia de comandos de la AWS CLI*.
### `create-dashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-dashboard`.
**AWS CLI**
**Para crear un panel**
En el siguiente ejemplo de `create-dashboard`, se crea un panel 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
```
Contenido 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 [Creating dashboards (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [CreateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-dashboard.html) en la *Referencia de comandos de la AWS CLI*.
### `create-gateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-gateway`.
**AWS CLI**
**Para crear una puerta de enlace**
En el siguiente ejemplo de `create-gateway`, se 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 [Configuring a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html) en la *Referencia de comandos de la AWS CLI*.
### `create-portal`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-portal`.
**AWS CLI**
**Para crear un portal**
En el siguiente ejemplo de `create-portal`, se 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 AWS Single Sign-On.
```
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 [Getting started with AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html) en la *Guía del usuario de AWS IoT SiteWise* y [Enabling AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html#monitor-enable-sso) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [CreatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-portal.html) en la *Referencia de comandos de AWS CLI*.
### `create-project`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-project`.
**AWS CLI**
**Para crear un proyecto**
En el siguiente ejemplo de `create-project`, se crea un proyecto de parques eólicos.
```
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 [Creating projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/create-projects.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-project.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-access-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-access-policy`.
**AWS CLI**
**Para revocar el acceso de un usuario a un proyecto o portal**
En el siguiente ejemplo de `delete-access-policy`, 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 [Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DeleteAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-access-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-asset-model`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-asset-model`.
**AWS CLI**
**Para eliminar un modelo de activos**
En el siguiente ejemplo de `delete-asset-model`, se elimina un modelo de activos de 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 [Deleting asset models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-asset`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-asset`.
**AWS CLI**
**Para eliminar un activo**
En el siguiente ejemplo de `delete-asset`, se elimina un activo de turbina eólica.
```
aws iotsitewise delete-asset \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
```
Salida:
```
{
"assetStatus": {
"state": "DELETING"
}
}
```
Para obtener más información, consulte [Deleting assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-dashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-dashboard`.
**AWS CLI**
**Para eliminar un panel**
En el siguiente ejemplo de `delete-dashboard`, se elimina el panel de una turbina eólica.
```
aws iotsitewise delete-dashboard \
--dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Deleting dashboards](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [DeleteDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-dashboard.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-gateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-gateway`.
**AWS CLI**
**Para eliminar una puerta de enlace**
En el siguiente ejemplo de `delete-gateway`, 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 [Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html) en la *Referencia de comandos de AWS CLI*.
### `delete-portal`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-portal`.
**AWS CLI**
**Para eliminar un portal**
En el siguiente ejemplo de `delete-portal`, se elimina un portal web para 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 [Deleting a portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-delete-portal) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DeletePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-portal.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-project`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-project`.
**AWS CLI**
**Para eliminar un proyecto**
En el siguiente ejemplo de `delete-project`, se elimina un proyecto de parques eólicos.
```
aws iotsitewise delete-project \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Deleting projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-project.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-access-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-access-policy`.
**AWS CLI**
**Para describir una política de acceso**
En el siguiente ejemplo de `describe-access-policy`, se 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 [Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribeAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-access-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-asset-model`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-asset-model`.
**AWS CLI**
**Para describir un modelo de activos**
En el siguiente ejemplo de `describe-asset-model`, se 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 [Describing a specific asset model](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-asset-property`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-asset-property`.
**AWS CLI**
**Para describir una propiedad de un activo**
En el siguiente ejemplo de `describe-asset-property`, se 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 [Describing a specific asset property](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-property) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribeAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-property.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-asset`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-asset`.
**AWS CLI**
**Para describir un activo**
En el siguiente ejemplo de `describe-asset`, se 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 [Describing a specific asset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-dashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-dashboard`.
**AWS CLI**
**Para describir un panel**
En el siguiente ejemplo de `describe-dashboard`, se describe el panel de 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 [Viewing dashboards](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [DescribeDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-dashboard.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-gateway-capability-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-gateway-capability-configuration`.
**AWS CLI**
**Para describir la capacidad de una puerta de enlace**
En el siguiente ejemplo de `describe-gateway-capability-configuration`, se describe una capacidad de origen 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 [Configuring data sources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribeGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway-capability-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-gateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-gateway`.
**AWS CLI**
**Para describir una puerta de enlace**
En el siguiente ejemplo de `describe-gateway`, se 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 [Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-logging-options`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-logging-options`.
**AWS CLI**
**Para recuperar las opciones de registro actuales de AWS IoT SiteWise**
En el siguiente ejemplo de `describe-logging-options`, se recuperan las opciones de registro actuales de AWS IoT SiteWise para su cuenta de AWS en la región actual.
```
aws iotsitewise describe-logging-options
```
Salida:
```
{
"loggingOptions": {
"level": "INFO"
}
}
```
Para obtener más información, consulte [Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener más información sobre la API, consulte [DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-logging-options.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-portal`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-portal`.
**AWS CLI**
**Para describir un portal**
En el siguiente ejemplo de `describe-portal`, se 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 [Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DescribePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-portal.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-project`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-project`.
**AWS CLI**
**Para describir un proyecto**
En el siguiente ejemplo de `describe-project`, se 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 [Viewing project details](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [DescribeProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-project.html) en la *Referencia de comandos de la AWS CLI*.
### `disassociate-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `disassociate-assets`.
**AWS CLI**
**Para desasociar un activo secundario de un activo principal**
En el siguiente ejemplo de `disassociate-assets`, se desvincula 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 [Associating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [DisassociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/disassociate-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `get-asset-property-aggregates`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-asset-property-aggregates`.
**AWS CLI**
**Para recuperar el promedio agregado y los valores de recuento de una propiedad de un activo**
En el siguiente ejemplo de `get-asset-property-aggregates`, se 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 una 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 [Querying asset property aggregates](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [GetAssetPropertyAggregates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-aggregates.html) en la *Referencia de comandos de la AWS CLI*.
### `get-asset-property-value-history`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-asset-property-value-history`.
**AWS CLI**
**Para recuperar los valores históricos de una propiedad de un activo**
En el siguiente ejemplo de `get-asset-property-value-history`, se recuperan 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 [Querying historical asset property values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [GetAssetPropertyValueHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value-history.html) en la *Referencia de comandos de la AWS CLI*.
### `get-asset-property-value`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-asset-property-value`.
**AWS CLI**
**Para recuperar el valor actual de una propiedad de un activo**
En el siguiente ejemplo de `get-asset-property-value`, se 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 [Querying current asset property values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html) en la *Referencia de comandos de la AWS CLI*.
### `list-access-policies`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-access-policies`.
**AWS CLI**
**Para enumerar todas las políticas de acceso**
En el siguiente ejemplo de `list-access-policies`, 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 [Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-access-policies.html) en la *Referencia de comandos de la AWS CLI*.
### `list-asset-models`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-asset-models`.
**AWS CLI**
**Para enumerar todos los modelos de activos**
En el siguiente ejemplo de `list-asset-models`, se enumeran todos los modelos de activos que se definen en la cuenta de AWS 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 [Listing all asset models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html) en la *Referencia de comandos de la AWS CLI*.
### `list-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-assets`.
**AWS CLI**
**Ejemplo 1: enumeración de todos los activos de nivel superior**
En el siguiente ejemplo de `list-assets`, se enumeran todos los activos que ocupan el nivel superior del árbol jerárquico de activos y están definidos en su cuenta de AWS 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, consulte [Listing assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) en la *Guía del usuario de AWS IoT SiteWise*.
**Ejemplo 2: enumeración de todos los activos en función de un modelo de activos**
En el siguiente ejemplo de `list-assets`, se enumeran todos los activos según un modelo de activos y que están definidos en su cuenta de AWS 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, consulte [Listing assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `list-associated-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-associated-assets`.
**AWS CLI**
**Para enumerar todos los activos asociados a un activo en una jerarquía específica**
En el siguiente ejemplo de `list-associated-assets`, se enumeran todos los activos de turbinas eólicas 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 [Listing assets associated to a specific asset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-associated-assets) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [ListAssociatedAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-associated-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `list-dashboards`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-dashboards`.
**AWS CLI**
**Para enumerar todos los paneles de un proyecto**
En el siguiente ejemplo de `list-dashboards`, 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 [Viewing dashboards](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener detalles sobre la API, consulte [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-dashboards.html) en la *Referencia de comandos de la AWS CLI*.
### `list-gateways`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-gateways`.
**AWS CLI**
**Para enumerar todas las puertas de enlace**
En el siguiente ejemplo de `list-gateways`, se enumeran todas las puertas de enlace que se definen en la cuenta de AWS 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 [Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [ListGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-gateways.html) en la *Referencia de comandos de la AWS CLI*.
### `list-portals`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-portals`.
**AWS CLI**
**Para enumerar todos los portales**
En el siguiente ejemplo de `list-portals`, se enumeran todos los portales que se definen en la cuenta de AWS 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 [Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [ListPortals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-portals.html) en la *Referencia de comandos de la AWS CLI*.
### `list-project-assets`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-project-assets`.
**AWS CLI**
**Para enumerar todos los activos asociados a un proyecto**
En el siguiente ejemplo de `list-project-assets`, se enumeran 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 [Adding assets to projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [ListProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-project-assets.html) en la *Referencia de comandos de la AWS CLI*.
### `list-projects`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-projects`.
**AWS CLI**
**Para enumerar todos los proyectos de un portal**
En el siguiente ejemplo de `list-projects`, 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 [Viewing project details](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener detalles sobre la API, consulte [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-projects.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Para enumerar todas las etiquetas de un recurso**
En el siguiente ejemplo de `list-tags-for-resource`, 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 [Tagging your resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `put-logging-options`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-logging-options`.
**AWS CLI**
**Para especificar el nivel de registro**
En el siguiente ejemplo de `put-logging-options`, se habilita el registro de niveles de `INFO` en AWS IoT SiteWise. Otros niveles incluyen `DEBUG` y `OFF`.
```
aws iotsitewise put-logging-options \
--logging-options level=INFO
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener detalles sobre la API, consulte [PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/put-logging-options.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Cómo añadir una etiqueta a un recurso**
En el siguiente ejemplo de `tag-resource`, 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 sea 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 [Tagging your resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Para eliminar una etiqueta de un recurso**
En el siguiente ejemplo de `untag-resource`, se elimina una etiqueta de propietario de un activo de turbina eólica.
```
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 [Tagging your resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `update-access-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-access-policy`.
**AWS CLI**
**Para conceder a un lector del proyecto la propiedad de un proyecto**
En el siguiente ejemplo de `update-access-policy`, se actualiza una política de acceso que otorga a un lector del proyecto 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
```
Contenido 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 [Assigning project owners](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-owners.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información acerca de la API, consulte [UpdateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-access-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `update-asset-model`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-asset-model`.
**AWS CLI**
**Para actualizar un modelo de activos**
En el siguiente ejemplo de `update-asset-model`, se actualiza la descripción de un modelo de activos de parque eólico. Este ejemplo incluye los ID y las definiciones existentes del modelo, 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
```
Contenido 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 [Updating asset models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-asset-models) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [UpdateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-model.html) en la *Referencia de comandos de la AWS CLI*.
### `update-asset-property`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-asset-property`.
**AWS CLI**
**Ejemplo 1: actualización del alias de una propiedad de un activo**
En el siguiente ejemplo de `update-asset-property`, se actualiza el alias de la propiedad de potencia 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 [Mapping industrial data streams to asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) en la *Guía del usuario de AWS IoT SiteWise*.
**Ejemplo 2: activación de notificaciones de propiedad de activo**
En el siguiente ejemplo de `update-asset-property`, se habilitan las notificaciones de actualización de propiedades de un activo para la propiedad de potencia de un activo de turbina eólica. Las actualizaciones del valor de la propiedad se publican en el tema MQTT `$aws/sitewise/asset-models//assets//properties/`, donde cada ID se sustituye por el ID 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 [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [UpdateAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-property.html) en la *Referencia de comandos de la AWS CLI*.
### `update-asset`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-asset`.
**AWS CLI**
**Para actualizar el nombre de un activo**
En el siguiente ejemplo de `update-asset`, se actualiza el nombre de un activo de turbina eólica.
```
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 [Updating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-assets) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [UpdateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset.html) en la *Referencia de comandos de la AWS CLI*.
### `update-dashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-dashboard`.
**AWS CLI**
**Para actualizar un panel**
En el siguiente ejemplo de `update-dashboard`, se modifica el título de un gráfico de líneas de un panel que muestra la potencia total generada para 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
```
Contenido 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 [Creating dashboards (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [UpdateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-dashboard.html) en la *Referencia de comandos de la AWS CLI*.
### `update-gateway-capability-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-gateway-capability-configuration`.
**AWS CLI**
**Para actualizar la capacidad de una puerta de enlace**
En el siguiente ejemplo de `update-gateway-capability-configuration`, se configura el origen OPC-UA con las siguientes propiedades:
Confía en cualquier certificado. Utiliza el algoritmo Basic256 para proteger los mensajes. Utiliza el modo SignAndEncrypt para proteger las conexiones. Utiliza las credenciales de autenticación almacenadas en un secreto de AWS Secrets Manager.
```
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
```
Contenido 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 [Configuring data sources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener detalles sobre la API, consulte [UpdateGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway-capability-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `update-gateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-gateway`.
**AWS CLI**
**Para actualizar el nombre de una puerta de enlace**
En el siguiente ejemplo de `update-gateway`, 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 [Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [UpdateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway.html) en la *Referencia de comandos de la AWS CLI*.
### `update-portal`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-portal`.
**AWS CLI**
**Para actualizar los detalles de un portal**
En el siguiente ejemplo de `update-portal`, se actualiza un portal web para 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 [Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) en la *Guía del usuario de AWS IoT SiteWise*.
+ Para obtener información sobre la API, consulte [UpdatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-portal.html) en la *Referencia de comandos de la AWS CLI*.
### `update-project`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-project`.
**AWS CLI**
**Para actualizar los detalles de un proyecto**
En el siguiente ejemplo de `update-project`, se 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 [Changing project details](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/edit-project-details.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor*.
+ Para obtener información sobre la API, consulte [UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-project.html) en la *Referencia de comandos de la AWS CLI*.