Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# AWS IoT SiteWise exemplos usando AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS IoT SiteWise.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `associate-assets`
O código de exemplo a seguir mostra como usar `associate-assets`.
**AWS CLI**
**Para associar um ativo filho a um ativo pai**
O exemplo `associate-assets` a seguir associa um ativo de turbina eólica a um ativo de parque eólico, onde o modelo de ativo de turbina eólica existe como uma hierarquia no modelo de ativo 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 não produz saída.
Para obter mais informações, consulte [Associando ativos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [AssociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/associate-assets.html)na *Referência de AWS CLI Comandos*.
### `batch-associate-project-assets`
O código de exemplo a seguir mostra como usar `batch-associate-project-assets`.
**AWS CLI**
**Para associar um ativo a um projeto**
O exemplo `batch-associate-project-assets` a seguir associa um ativo de parque eólico a um projeto.
```
aws iotsitewise batch-associate-project-assets \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
--asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
```
Este comando não produz saída.
Para obter mais informações, consulte [Adicionar ativos a projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) no Guia de *aplicativos do AWS IoT SiteWise Monitor*.
+ Para obter detalhes da API, consulte [BatchAssociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-associate-project-assets.html)na *Referência de AWS CLI Comandos*.
### `batch-disassociate-project-assets`
O código de exemplo a seguir mostra como usar `batch-disassociate-project-assets`.
**AWS CLI**
**Para desassociar um ativo de um projeto**
O exemplo `batch-disassociate-project-assets` a seguir desassocia um ativo de parque eólico a um projeto.
```
aws iotsitewise batch-disassociate-project-assets \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
--asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
```
Este comando não produz saída.
Para obter mais informações, consulte [Adicionar ativos a projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) no Guia de *aplicativos do AWS IoT SiteWise Monitor*.
+ Para obter detalhes da API, consulte [BatchDisassociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-disassociate-project-assets.html)na *Referência de AWS CLI Comandos*.
### `batch-put-asset-property-value`
O código de exemplo a seguir mostra como usar `batch-put-asset-property-value`.
**AWS CLI**
**Para enviar dados às propriedades do ativo**
O exemplo `batch-put-asset-property-value` a seguir envia dados de potência e temperatura para as propriedades do ativo identificadas pelos aliases da propriedade.
```
aws iotsitewise batch-put-asset-property-value \
--cli-input-json file://batch-put-asset-property-value.json
```
Conteúdo 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
}
}
]
}
]
}
```
Saída:
```
{
"errorEntries": []
}
```
Para obter mais informações, consulte Como [ingerir dados usando a API de AWS SiteWise IoT no](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) Guia do usuário de *AWS IoT SiteWise *.
+ Para obter detalhes da API, consulte [BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html)na *Referência de AWS CLI Comandos*.
### `create-access-policy`
O código de exemplo a seguir mostra como usar `create-access-policy`.
**AWS CLI**
**Exemplo 1: conceder a um usuário acesso administrativo a um portal**
O exemplo `create-access-policy` a seguir cria uma política de acesso que concede ao usuário acesso administrativo a um portal da web para uma empresa de parques eólicos.
```
aws iotsitewise create-access-policy \
--cli-input-json file://create-portal-administrator-access-policy.json
```
Conteúdo 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"
}
}
}
```
Saída:
```
{
"accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
"accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE"
}
```
Para obter mais informações, consulte [Adicionando ou removendo administradores do portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) no Guia do Usuário de *AWS SiteWise IoT*.
**Exemplo 2: conceder a um usuário acesso somente de leitura a um projeto**
O exemplo `create-access-policy` a seguir cria uma política de acesso que concede ao usuário acesso somente de leitura a um projeto de parque eólico.
```
aws iotsitewise create-access-policy \
--cli-input-json file://create-project-viewer-access-policy.json
```
Conteúdo 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"
}
}
}
```
Saída:
```
{
"accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE",
"accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE"
}
```
Para obter mais informações, consulte [Atribuição de visualizadores de projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-viewers.html) no Guia de aplicativos do *AWS SiteWise IoT Monitor*.
+ Para obter detalhes da API, consulte [CreateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-access-policy.html)na *Referência de AWS CLI Comandos*.
### `create-asset-model`
O código de exemplo a seguir mostra como usar `create-asset-model`.
**AWS CLI**
**Para criar um modelo de ativo**
O exemplo `create-asset-model` a seguir cria um modelo de ativo que define uma turbina eólica com as seguintes propriedades:
Número de série - O número de série de uma turbina eólica Energia gerada - O fluxo de dados de energia gerada de uma turbina eólica Temperatura C - O fluxo de dados de temperatura de uma turbina eólica em CelsiusTemperature F - Os pontos de dados de temperatura mapeados de Celsius a Fahrenheit
```
aws iotsitewise create-asset-model \
--cli-input-json file://create-wind-turbine-model.json
```
Conteúdo 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"
}
}
}
}
}
]
}
```
Saída:
```
{
"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 obter mais informações, consulte [Definição de modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html)na *Referência de AWS CLI Comandos*.
### `create-asset`
O código de exemplo a seguir mostra como usar `create-asset`.
**AWS CLI**
**Para criar um ativo**
O exemplo `create-asset` a seguir cria um ativo de turbina eólica a partir de um modelo de ativo de turbina eólica.
```
aws iotsitewise create-asset \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
--asset-name "Wind Turbine 1"
```
Saída:
```
{
"assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"assetStatus": {
"state": "CREATING"
}
}
```
Para obter mais informações, consulte [Criação de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) no Guia do * SiteWise Usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html)na *Referência de AWS CLI Comandos*.
### `create-dashboard`
O código de exemplo a seguir mostra como usar `create-dashboard`.
**AWS CLI**
**Para criar um painel**
O exemplo `create-dashboard` a seguir cria um painel com um gráfico de linhas que exibe a potência total gerada por um 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
```
Conteúdo 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"
}
]
}
]
}
```
Saída:
```
{
"dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
"dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE"
}
```
Para obter mais informações, consulte [Criação de painéis (CLI](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)) no Guia do usuário de *AWS IoT SiteWise *.
+ Para obter detalhes da API, consulte [CreateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-dashboard.html)na *Referência de AWS CLI Comandos*.
### `create-gateway`
O código de exemplo a seguir mostra como usar `create-gateway`.
**AWS CLI**
**Para criar um gateway**
O `create-gateway` exemplo a seguir cria um gateway que é executado no 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}
```
Saída:
```
{
"gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE"
}
```
Para obter mais informações, consulte [Configurando um gateway no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html)na *Referência de AWS CLI Comandos*.
### `create-portal`
O código de exemplo a seguir mostra como usar `create-portal`.
**AWS CLI**
**Para criar um portal**
O exemplo `create-portal` a seguir cria um portal da web para uma empresa de parques eólicos. Você pode criar portais somente na mesma região em que habilitou o 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
```
Saída:
```
{
"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 obter mais informações, consulte [Introdução ao AWS IoT SiteWise Monitor no Guia do Usuário de IoT](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html) e [Habilitando o AWSAWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html#monitor-enable-sso) *no Guia SiteWise do Usuário de IoT*.AWS SiteWise *
+ Para obter detalhes da API, consulte [CreatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-portal.html)na *Referência de AWS CLI Comandos*.
### `create-project`
O código de exemplo a seguir mostra como usar `create-project`.
**AWS CLI**
**Para criar um projeto**
O exemplo `create-project` a seguir cria um projeto 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."
```
Saída:
```
{
"projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
"projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
}
```
Para obter mais informações, consulte [Criação de projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/create-projects.html) no Guia de *aplicativos do AWS IoT SiteWise Monitor*.
+ Para obter detalhes da API, consulte [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-project.html)na *Referência de AWS CLI Comandos*.
### `delete-access-policy`
O código de exemplo a seguir mostra como usar `delete-access-policy`.
**AWS CLI**
**Para revogar o acesso de um usuário a um projeto ou portal**
O exemplo `delete-access-policy` a seguir exclui uma política de acesso que concede ao usuário acesso administrativo a um portal.
```
aws iotsitewise delete-access-policy \
--access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE
```
Este comando não produz saída.
Para obter mais informações, consulte [Adicionando ou removendo administradores do portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) no Guia do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DeleteAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-access-policy.html)na *Referência de AWS CLI Comandos*.
### `delete-asset-model`
O código de exemplo a seguir mostra como usar `delete-asset-model`.
**AWS CLI**
**Para excluir um modelo de ativo**
O exemplo `delete-asset-model` a seguir exclui um modelo de ativo de turbina eólica.
```
aws iotsitewise delete-asset-model \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
```
Saída:
```
{
"assetModelStatus": {
"state": "DELETING"
}
}
```
Para obter mais informações, consulte [Excluindo modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models) no Guia do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html)na *Referência de AWS CLI Comandos*.
### `delete-asset`
O código de exemplo a seguir mostra como usar `delete-asset`.
**AWS CLI**
**Para excluir um ativo**
O exemplo `delete-asset` a seguir exclui um modelo de ativo de turbina eólica.
```
aws iotsitewise delete-asset \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
```
Saída:
```
{
"assetStatus": {
"state": "DELETING"
}
}
```
Para obter mais informações, consulte [Excluindo ativos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html)na *Referência de AWS CLI Comandos*.
### `delete-dashboard`
O código de exemplo a seguir mostra como usar `delete-dashboard`.
**AWS CLI**
**Para excluir um painel**
O exemplo `delete-dashboard` a seguir exclui um painel de turbina eólica.
```
aws iotsitewise delete-dashboard \
--dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE
```
Este comando não produz saída.
Para obter mais informações, consulte [Excluindo painéis](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html) no Guia de aplicativos do *AWS IoT Monitor SiteWise *.
+ Para obter detalhes da API, consulte [DeleteDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-dashboard.html)na *Referência de AWS CLI Comandos*.
### `delete-gateway`
O código de exemplo a seguir mostra como usar `delete-gateway`.
**AWS CLI**
**Para excluir um gateway**
O exemplo `delete-gateway` a seguir exclui um gateway.
```
aws iotsitewise delete-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
```
Este comando não produz saída.
Para obter mais informações, consulte Como [ingerir dados usando um gateway no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html)na *Referência de AWS CLI Comandos*.
### `delete-portal`
O código de exemplo a seguir mostra como usar `delete-portal`.
**AWS CLI**
**Para excluir um portal**
O exemplo `delete-portal` a seguir exclui um portal da web para uma empresa de parques eólicos.
```
aws iotsitewise delete-portal \
--portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE
```
Saída:
```
{
"portalStatus": {
"state": "DELETING"
}
}
```
Para obter mais informações, consulte [Excluindo um portal no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-delete-portal) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DeletePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-portal.html)na *Referência de AWS CLI Comandos*.
### `delete-project`
O código de exemplo a seguir mostra como usar `delete-project`.
**AWS CLI**
**Para excluir um projeto**
O exemplo `delete-project` a seguir exclui um projeto de parque eólico.
```
aws iotsitewise delete-project \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
```
Este comando não produz saída.
Para obter mais informações, consulte [Excluindo projetos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html) de aplicativos do *AWS SiteWise IoT Monitor*.
+ Para obter detalhes da API, consulte [DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-project.html)na *Referência de AWS CLI Comandos*.
### `describe-access-policy`
O código de exemplo a seguir mostra como usar `describe-access-policy`.
**AWS CLI**
**Para descrever uma política de acesso**
O exemplo `describe-access-policy` a seguir descreve uma política de acesso que concede ao usuário acesso administrativo a um portal da web para uma empresa de parques eólicos.
```
aws iotsitewise describe-access-policy \
--access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Adicionando ou removendo administradores do portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) no Guia do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DescribeAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-access-policy.html)na *Referência de AWS CLI Comandos*.
### `describe-asset-model`
O código de exemplo a seguir mostra como usar `describe-asset-model`.
**AWS CLI**
**Para descrever um modelo de ativo**
O exemplo `describe-asset-model` a seguir descreve um modelo de ativo de parque eólico.
```
aws iotsitewise describe-asset-model \
--asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Descrição de um modelo de ativo específico](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html)na *Referência de AWS CLI Comandos*.
### `describe-asset-property`
O código de exemplo a seguir mostra como usar `describe-asset-property`.
**AWS CLI**
**Para descrever uma propriedade do ativo**
O exemplo `describe-asset-property` a seguir descreve a propriedade de potência total gerada de um ativo de parque eólico.
```
aws iotsitewise describe-asset-property \
--asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
--property-id a1b2c3d4-5678-90ab-cdef-99999EXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Descrição de uma propriedade de ativo específica](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-property) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [DescribeAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-property.html)na *Referência de AWS CLI Comandos*.
### `describe-asset`
O código de exemplo a seguir mostra como usar `describe-asset`.
**AWS CLI**
**Para descrever um ativo**
O exemplo `describe-asset` a seguir descreve ativo de parque eólico.
```
aws iotsitewise describe-asset \
--asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Descrição de um ativo específico](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset.html)na *Referência de AWS CLI Comandos*.
### `describe-dashboard`
O código de exemplo a seguir mostra como usar `describe-dashboard`.
**AWS CLI**
**Para descrever um painel**
O exemplo `describe-dashboard` a seguir descreve o painel do parque eólico especificado.
```
aws iotsitewise describe-dashboard \
--dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Visualização de painéis no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) de aplicativos do *AWS SiteWise IoT Monitor*.
+ Para obter detalhes da API, consulte [DescribeDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-dashboard.html)na *Referência de AWS CLI Comandos*.
### `describe-gateway-capability-configuration`
O código de exemplo a seguir mostra como usar `describe-gateway-capability-configuration`.
**AWS CLI**
**Para descrever uma capacidade de gateway**
O exemplo `describe-gateway-capability-configuration` a seguir descreve uma capacidade de fonte OPC-UA.
```
aws iotsitewise describe-gateway-capability-configuration \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
--capability-namespace "iotsitewise:opcuacollector:1"
```
Saída:
```
{
"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 obter mais informações, consulte [Como configurar fontes de dados](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) no Guia do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DescribeGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway-capability-configuration.html)na *Referência de AWS CLI Comandos*.
### `describe-gateway`
O código de exemplo a seguir mostra como usar `describe-gateway`.
**AWS CLI**
**Para descrever um gateway**
O exemplo `describe-gateway` a seguir descreve um gateway.
```
aws iotsitewise describe-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte Como [ingerir dados usando um gateway no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html)na *Referência de AWS CLI Comandos*.
### `describe-logging-options`
O código de exemplo a seguir mostra como usar `describe-logging-options`.
**AWS CLI**
**Para recuperar as opções atuais de registro de AWS SiteWise IoT**
O `describe-logging-options` exemplo a seguir recupera as opções atuais de registro de AWS SiteWise IoT para AWS sua conta na região atual.
```
aws iotsitewise describe-logging-options
```
Saída:
```
{
"loggingOptions": {
"level": "INFO"
}
}
```
Para obter mais informações, consulte [Monitoramento da AWS IoT com SiteWise Amazon CloudWatch Logs no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) do usuário da *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-logging-options.html)na *Referência de AWS CLI Comandos*.
### `describe-portal`
O código de exemplo a seguir mostra como usar `describe-portal`.
**AWS CLI**
**Para descrever um portal**
O exemplo `describe-portal` a seguir descreve um portal da web para uma empresa de parques eólicos.
```
aws iotsitewise describe-portal \
--portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Administrando seus portais no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DescribePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-portal.html)na *Referência de AWS CLI Comandos*.
### `describe-project`
O código de exemplo a seguir mostra como usar `describe-project`.
**AWS CLI**
**Para descrever um projeto**
O exemplo `describe-project` a seguir exclui um projeto de parque eólico.
```
aws iotsitewise describe-project \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Visualização dos detalhes do projeto](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) no Guia de *Aplicação do SiteWise Monitor de AWS IoT*.
+ Para obter detalhes da API, consulte [DescribeProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-project.html)na *Referência de AWS CLI Comandos*.
### `disassociate-assets`
O código de exemplo a seguir mostra como usar `disassociate-assets`.
**AWS CLI**
**Para desassociar um ativo filho de um ativo pai**
O exemplo `disassociate-assets` a seguir desassocia um ativo de turbina eólica de um projeto 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 não produz saída.
Para obter mais informações, consulte [Associando ativos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [DisassociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/disassociate-assets.html)na *Referência de AWS CLI Comandos*.
### `get-asset-property-aggregates`
O código de exemplo a seguir mostra como usar `get-asset-property-aggregates`.
**AWS CLI**
**Para recuperar a média agregada e os valores de contagem de uma propriedade do ativo**
O exemplo `get-asset-property-aggregates` a seguir recupera a potência total média de um ativo de turbina eólica e a contagem de pontos de dados para um 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
```
Saída:
```
{
"aggregatedValues": [
{
"timestamp": 1580850000.0,
"quality": "GOOD",
"value": {
"average": 8723.46538886233,
"count": 12.0
}
}
]
}
```
Para obter mais informações, consulte [Consultar agregados de propriedades de ativos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [GetAssetPropertyAggregates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-aggregates.html)na *Referência de AWS CLI Comandos*.
### `get-asset-property-value-history`
O código de exemplo a seguir mostra como usar `get-asset-property-value-history`.
**AWS CLI**
**Para recuperar os valores históricos de uma propriedade do ativo**
O exemplo `get-asset-property-value-history` a seguir recupera os valores de potência total de um ativo de turbina eólica por um 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
```
Saída:
```
{
"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 obter mais informações, consulte [Consultar valores históricos de propriedades de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) no Guia do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [GetAssetPropertyValueHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value-history.html)na *Referência de AWS CLI Comandos*.
### `get-asset-property-value`
O código de exemplo a seguir mostra como usar `get-asset-property-value`.
**AWS CLI**
**Para recuperar o valor atual de uma propriedade do ativo**
O exemplo `get-asset-property-value` a seguir recupera a potência total atual de um ativo de turbina eólica.
```
aws iotsitewise get-asset-property-value \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
--property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE
```
Saída:
```
{
"propertyValue": {
"value": {
"doubleValue": 6890.8677520453875
},
"timestamp": {
"timeInSeconds": 1580853000,
"offsetInNanos": 0
},
"quality": "GOOD"
}
}
```
Para obter mais informações, consulte [Consultando os valores atuais das propriedades do ativo](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) no Guia do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html)na *Referência de AWS CLI Comandos*.
### `list-access-policies`
O código de exemplo a seguir mostra como usar `list-access-policies`.
**AWS CLI**
**Para listar todas as políticas de acesso**
O exemplo `list-access-policies` a seguir lista todas as políticas de acesso para um usuário que é administrador do portal.
```
aws iotsitewise list-access-policies \
--identity-type USER \
--identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Administrando seus portais no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-access-policies.html)na *Referência de AWS CLI Comandos*.
### `list-asset-models`
O código de exemplo a seguir mostra como usar `list-asset-models`.
**AWS CLI**
**Para listar todos os modelos de ativos**
O `list-asset-models` exemplo a seguir lista todos os modelos de ativos definidos em sua AWS conta na região atual.
```
aws iotsitewise list-asset-models
```
Saída:
```
{
"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 obter mais informações, consulte [Listar todos os modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html)na *Referência de AWS CLI Comandos*.
### `list-assets`
O código de exemplo a seguir mostra como usar `list-assets`.
**AWS CLI**
**Exemplo 1: listar todos os ativos de nível superior**
O `list-assets` exemplo a seguir lista todos os ativos de nível superior na árvore hierárquica de ativos e definidos em sua AWS conta na região atual.
```
aws iotsitewise list-assets \
--filter TOP_LEVEL
```
Saída:
```
{
"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 obter mais informações, consulte [Listar ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) no Guia do * SiteWise usuário de AWS IoT*.
**Exemplo 2: listar todos os ativos com base em um modelo de ativo**
O `list-assets` exemplo a seguir lista todos os ativos com base em um modelo de ativos e definidos em sua AWS conta na região atual.
```
aws iotsitewise list-assets \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Listar ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-assets.html)na *Referência de AWS CLI Comandos*.
### `list-associated-assets`
O código de exemplo a seguir mostra como usar `list-associated-assets`.
**AWS CLI**
**Para listar todos os ativos associados a um ativo em uma hierarquia específica**
O exemplo `list-associated-assets` a seguir lista todos os ativos da turbina eólica associados ao ativo do parque eólico especificado.
```
aws iotsitewise list-associated-assets \
--asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
--hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Listar ativos associados a um ativo específico](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-associated-assets) no Guia do * SiteWise Usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [ListAssociatedAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-associated-assets.html)na *Referência de AWS CLI Comandos*.
### `list-dashboards`
O código de exemplo a seguir mostra como usar `list-dashboards`.
**AWS CLI**
**Para listar todos os painéis em um projeto**
O exemplo `list-dashboards` a seguir lista todos os painéis definidos em um projeto.
```
aws iotsitewise list-dashboards \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Visualização de painéis no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) de aplicativos do *AWS SiteWise IoT Monitor*.
+ Para obter detalhes da API, consulte [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-dashboards.html)na *Referência de AWS CLI Comandos*.
### `list-gateways`
O código de exemplo a seguir mostra como usar `list-gateways`.
**AWS CLI**
**Para listar todos os gateways**
O `list-gateways` exemplo a seguir lista todos os gateways definidos em sua AWS conta na região atual.
```
aws iotsitewise list-gateways
```
Saída:
```
{
"gatewaySummaries": [
{
"gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayName": "ExampleCorpGateway",
"gatewayCapabilitySummaries": [
{
"capabilityNamespace": "iotsitewise:opcuacollector:1",
"capabilitySyncStatus": "IN_SYNC"
}
],
"creationDate": 1588369971.457,
"lastUpdateDate": 1588369971.457
}
]
}
```
Para obter mais informações, consulte Como [ingerir dados usando um gateway no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [ListGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-gateways.html)na *Referência de AWS CLI Comandos*.
### `list-portals`
O código de exemplo a seguir mostra como usar `list-portals`.
**AWS CLI**
**Para listar todos os portais**
O `list-portals` exemplo a seguir lista todos os portais definidos em sua AWS conta na região atual.
```
aws iotsitewise list-portals
```
Saída:
```
{
"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 obter mais informações, consulte [Administrando seus portais no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [ListPortals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-portals.html)na *Referência de AWS CLI Comandos*.
### `list-project-assets`
O código de exemplo a seguir mostra como usar `list-project-assets`.
**AWS CLI**
**Para listar todos os ativos associados a um projeto**
O exemplo `list-project-assets` a seguir lista todos os ativos associados a um projeto de parque eólico.
```
aws iotsitewise list-projects \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
```
Saída:
```
{
"assetIds": [
"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"
]
}
```
Para obter mais informações, consulte [Adicionar ativos a projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) no Guia de *aplicativos do AWS IoT SiteWise Monitor*.
+ Para obter detalhes da API, consulte [ListProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-project-assets.html)na *Referência de AWS CLI Comandos*.
### `list-projects`
O código de exemplo a seguir mostra como usar `list-projects`.
**AWS CLI**
**Para listar todos os projetos em um portal**
O exemplo `list-projects` a seguir lista todos os projetos definidos em um portal.
```
aws iotsitewise list-projects \
--portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE
```
Saída:
```
{
"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 obter mais informações, consulte [Visualização dos detalhes do projeto](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) no Guia de *Aplicação do SiteWise Monitor de AWS IoT*.
+ Para obter detalhes da API, consulte [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-projects.html)na *Referência de AWS CLI Comandos*.
### `list-tags-for-resource`
O código de exemplo a seguir mostra como usar `list-tags-for-resource`.
**AWS CLI**
**Para listar todas as tags de um recurso**
O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ativo 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
```
Saída:
```
{
"tags": {
"Owner": "richard-roe"
}
}
```
Para obter mais informações, consulte Como [marcar seus recursos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-tags-for-resource.html)na *Referência de AWS CLI Comandos*.
### `put-logging-options`
O código de exemplo a seguir mostra como usar `put-logging-options`.
**AWS CLI**
**Para especificar o nível de log**
O `put-logging-options` exemplo a seguir permite o registro `INFO` de níveis na AWS IoT SiteWise. Outros níveis incluem `DEBUG` e `OFF`.
```
aws iotsitewise put-logging-options \
--logging-options level=INFO
```
Este comando não produz saída.
Para obter mais informações, consulte [Monitoramento da AWS IoT com SiteWise Amazon CloudWatch Logs no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) do usuário da *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/put-logging-options.html)em *Referência de AWS CLI Comandos*.
### `tag-resource`
O código de exemplo a seguir mostra como usar `tag-resource`.
**AWS CLI**
**Para adicionar uma tag a um recurso**
O exemplo `tag-resource` a seguir adiciona uma tag de proprietário a um ativo de turbina eólica. Isso permite o controle do acesso ao ativo com base em quem o possui.
```
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 não produz saída.
Para obter mais informações, consulte Como [marcar seus recursos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/tag-resource.html)em *Referência de AWS CLI Comandos*.
### `untag-resource`
O código de exemplo a seguir mostra como usar `untag-resource`.
**AWS CLI**
**Para remover uma tag de um recurso**
O exemplo `untag-resource` a seguir remove uma tag de proprietário de um ativo 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 não produz saída.
Para obter mais informações, consulte Como [marcar seus recursos no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/untag-resource.html)em *Referência de AWS CLI Comandos*.
### `update-access-policy`
O código de exemplo a seguir mostra como usar `update-access-policy`.
**AWS CLI**
**Para designar um visualizador do projeto como proprietário**
O exemplo `update-access-policy` a seguir atualiza uma política de acesso que concede ao visualizador do projeto a propriedade de um projeto.
```
aws iotsitewise update-access-policy \
--access-policy-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE \
--cli-input-json file://update-project-viewer-access-policy.json
```
Conteúdo 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 não produz saída.
Para obter mais informações, consulte [Atribuição de proprietários de projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-owners.html) no Guia de aplicativos do *AWS SiteWise IoT Monitor*.
+ Para obter detalhes da API, consulte [UpdateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-access-policy.html)em *Referência de AWS CLI Comandos*.
### `update-asset-model`
O código de exemplo a seguir mostra como usar `update-asset-model`.
**AWS CLI**
**Para atualizar um modelo de ativo**
O exemplo `update-asset-model` a seguir atualiza a descrição de um modelo de ativo de parque eólico. Esse exemplo inclui o modelo existente IDs e as definições, pois `update-asset-model` substitui o modelo existente pelo novo modelo.
```
aws iotsitewise update-asset-model \
--cli-input-json file://update-wind-farm-model.json
```
Conteúdo 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"
}
]
}
```
Saída:
```
{
"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 obter mais informações, consulte [Atualização de modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-asset-models) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [UpdateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-model.html)em *Referência de AWS CLI Comandos*.
### `update-asset-property`
O código de exemplo a seguir mostra como usar `update-asset-property`.
**AWS CLI**
**Exemplo 1: atualizar o alias de uma propriedade do ativo**
O exemplo `update-asset-property` a seguir atualiza o alias da propriedade de potência de um ativo 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 não produz saída.
Para obter mais informações, consulte [Mapeando fluxos de dados industriais para propriedades de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) no Guia do usuário de *AWS SiteWise IoT*.
**Exemplo 2: habilitar notificações de propriedade de ativos**
O exemplo `update-asset-property` a seguir habilita notificações de atualização de propriedades de ativos para a propriedade de potência de um ativo de turbina eólica. As atualizações do valor da propriedade são publicadas no tópico MQTT `$aws/sitewise/asset-models//assets//properties/`, onde cada ID é substituído pela propriedade, ativo e ID do modelo da propriedade do ativo.
```
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 não produz saída.
Para obter mais informações, consulte [Interagindo com outros serviços no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [UpdateAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-property.html)em *Referência de AWS CLI Comandos*.
### `update-asset`
O código de exemplo a seguir mostra como usar `update-asset`.
**AWS CLI**
**Para atualizar o nome de um ativo**
O exemplo `update-asset` a seguir atualiza o nome de um ativo de turbina eólica.
```
aws iotsitewise update-asset \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
--asset-name "Wind Turbine 2"
```
Saída:
```
{
"assetStatus": {
"state": "UPDATING"
}
}
```
Para obter mais informações, consulte [Atualização de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-assets) no Guia do * SiteWise usuário de AWS IoT*.
+ Para obter detalhes da API, consulte [UpdateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset.html)em *Referência de AWS CLI Comandos*.
### `update-dashboard`
O código de exemplo a seguir mostra como usar `update-dashboard`.
**AWS CLI**
**Para atualizar um painel**
O exemplo `update-dashboard` a seguir altera o título de um gráfico de linhas de um painel que exibe a potência total gerada por um 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
```
Conteúdo 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 não produz saída.
Para obter mais informações, consulte [Criação de painéis (CLI](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)) no Guia do usuário de *AWS IoT SiteWise *.
+ Para obter detalhes da API, consulte [UpdateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-dashboard.html)em *Referência de AWS CLI Comandos*.
### `update-gateway-capability-configuration`
O código de exemplo a seguir mostra como usar `update-gateway-capability-configuration`.
**AWS CLI**
**Para atualizar uma capacidade de gateway**
O seguinte exemplo de `update-gateway-capability-configuration` configura uma fonte OPC-UA com as seguintes propriedades:
Confia em qualquer certificado.Usa o algoritmo Basic256 para proteger mensagens.Usa o SignAndEncrypt modo para proteger conexões.Usa credenciais de autenticação armazenadas em um segredo do 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
```
Conteúdo 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": ""
}
]
}
```
Saída:
```
{
"capabilityNamespace": "iotsitewise:opcuacollector:1",
"capabilitySyncStatus": "OUT_OF_SYNC"
}
```
Para obter mais informações, consulte [Como configurar fontes de dados](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) no Guia do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [UpdateGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway-capability-configuration.html)em *Referência de AWS CLI Comandos*.
### `update-gateway`
O código de exemplo a seguir mostra como usar `update-gateway`.
**AWS CLI**
**Para atualizar o nome de um gateway**
O exemplo `update-gateway` a seguir atualiza o nome de um gateway.
```
aws iotsitewise update-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
--gateway-name ExampleCorpGateway1
```
Este comando não produz saída.
Para obter mais informações, consulte Como [ingerir dados usando um gateway no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) do usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [UpdateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway.html)em *Referência de AWS CLI Comandos*.
### `update-portal`
O código de exemplo a seguir mostra como usar `update-portal`.
**AWS CLI**
**Para atualizar os detalhes de um portal**
O exemplo `update-portal` a seguir atualiza um portal da web de uma 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
```
Saída:
```
{
"portalStatus": {
"state": "UPDATING"
}
}
```
Para obter mais informações, consulte [Administrando seus portais no Guia](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) do Usuário de *AWS SiteWise IoT*.
+ Para obter detalhes da API, consulte [UpdatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-portal.html)em *Referência de AWS CLI Comandos*.
### `update-project`
O código de exemplo a seguir mostra como usar `update-project`.
**AWS CLI**
**Para atualizar os detalhes de um projeto**
O exemplo `update-project` a seguir atualiza um projeto 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 não produz saída.
Para obter mais informações, consulte [Alterando os detalhes do projeto](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/edit-project-details.html) no Guia de *Aplicação do SiteWise Monitor de AWS IoT*.
+ Para obter detalhes da API, consulte [UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-project.html)em *Referência de AWS CLI Comandos*.