AWS IoT SiteWise 사용 예제 AWS CLI - AWS SDK 코드 예제
작업

AWS Doc SDK ExamplesWord AWS SDK 리포지토리에는 더 많은 GitHub 예제가 있습니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

AWS IoT SiteWise 사용 예제 AWS CLI

다음 코드 예제에서는를 AWS Command Line Interface 와 함께 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여줍니다 AWS IoT SiteWise.

작업은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 개별 서비스 함수를 직접적으로 호출하는 방법을 보여주며 관련 시나리오의 컨텍스트에 맞는 작업을 볼 수 있습니다.

각 예제에는 컨텍스트에서 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있는 전체 소스 코드에 대한 링크가 포함되어 있습니다.

주제

작업

다음 코드 예시에서는 associate-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

하위 자산을 상위 자산에 연결하려면

다음 associate-assets 예제는 풍력 터빈 자산을 풍력 발전 단지 자산에 연결합니다. 풍력 터빈 자산 모델은 풍력 발전 단지 자산 모델의 계층 구조로 존재합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 연결을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 AssociateAssets를 참조하세요.

다음 코드 예시에서는 batch-associate-project-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

자산을 프로젝트에 연결하려면

다음 batch-associate-project-assets 예제에서는 풍력 팜 자산을 프로젝트에 연결합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트에 자산 추가를 참조하세요.

다음 코드 예시에서는 batch-disassociate-project-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트에서 자산을 연결 해제하려면

다음 batch-disassociate-project-assets 예제에서는 풍력 팜 자산을 프로젝트에서 연결 해제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트에 자산 추가를 참조하세요.

다음 코드 예시에서는 batch-put-asset-property-value을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 속성으로 데이터를 보내려면

다음 batch-put-asset-property-value 예제에서는 속성 별칭으로 식별되는 자산 속성으로 전력 및 온도 데이터를 전송합니다.

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

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
                    }
                }
            ]
        }
    ]
}

출력:

{
    "errorEntries": []
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 API를 사용하여 데이터 수집을 참조하세요. AWS IoT SiteWise

다음 코드 예시에서는 create-access-policy을 사용하는 방법을 보여 줍니다.

AWS CLI

예제 1: 포털에 대한 사용자 관리 액세스 권한 부여

다음 create-access-policy 예제에서는 풍력 발전 단지 회사의 웹 포털에 대한 사용자 관리 액세스 권한을 부여하는 액세스 정책을 생성합니다.

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

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"
        }
    }
}

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리자 추가 또는 제거를 참조하세요.

예제 2: 사용자에게 프로젝트에 대한 읽기 전용 액세스 권한 부여

다음 create-access-policy 예제에서는 사용자에게 풍력 발전 단지 프로젝트에 대한 읽기 전용 액세스 권한을 부여하는 액세스 정책을 생성합니다.

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

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"
        }
    }
}

출력:

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

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트 뷰어 할당을 참조하세요.

다음 코드 예시에서는 create-asset-model을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 모델을 생성하려면

다음 create-asset-model 예제에서는 다음 속성을 가진 풍력 터빈을 정의하는 자산 모델을 생성합니다.

일련 번호 - wind turbineGenerated 전력의 일련 번호 - wind turbineTemperature C에서 생성된 전력 데이터 스트림 - CelsiusTemperature F의 풍력 터빈에서 온도 데이터 스트림 - Celsius에서 Fahrenheit까지 매핑된 온도 데이터 포인트

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

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"
                        }
                    }
                }
            }
        }
    ]
}

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 모델 정의를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 CreateAssetModel를 참조하세요.

다음 코드 예시에서는 create-asset을 사용하는 방법을 보여 줍니다.

AWS CLI

자산을 생성하려면

다음 create-asset 예제에서는 풍력 터빈 자산 모델에서 풍력 터빈 자산을 생성합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 생성을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 CreateAsset를 참조하세요.

다음 코드 예시에서는 create-dashboard을 사용하는 방법을 보여 줍니다.

AWS CLI

대시보드를 생성하려면

다음 create-dashboard 예제에서는 풍력 발전 단지에 대해 생성된 총 전력을 표시하는 선 차트가 있는 대시보드를 생성합니다.

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

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"
                }
            ]
        }
    ]
}

출력:

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

자세한 내용은 IoTCLI 사용 설명서의 대시보드 생성(Word)을 참조하세요. AWS IoT SiteWise

  • API 세부 정보는 AWS CLI 명령 참조의 CreateDashboard를 참조하세요.

다음 코드 예시에서는 create-gateway을 사용하는 방법을 보여 줍니다.

AWS CLI

게이트웨이를 생성하려면

다음 create-gateway 예제에서는 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}

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 게이트웨이 구성을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 CreateGateway를 참조하세요.

다음 코드 예시에서는 create-portal을 사용하는 방법을 보여 줍니다.

AWS CLI

포털을 생성하려면

다음 create-portal 예제에서는 풍력 발전 단지 회사를 위한 웹 포털을 생성합니다. 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

출력:

{
    "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"
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 IoTWord Monitor 시작하기 및 IoT AWS SSO 사용 설명서의 EnablingWord를 참조하세요. AWS IoT SiteWise AWS IoT SiteWise

  • API 세부 정보는 AWS CLI 명령 참조의 CreatePortal를 참조하세요.

다음 코드 예시에서는 create-project을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트를 생성하려면

다음 create-project 예제에서는 풍력 발전 단지 프로젝트를 생성합니다.

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."

출력:

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

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트 생성을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 CreateProject를 참조하세요.

다음 코드 예시에서는 delete-access-policy을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트 또는 포털에 대한 사용자의 액세스를 취소하려면

다음 delete-access-policy 예제에서는 포털에 대한 사용자 관리 액세스 권한을 부여하는 액세스 정책을 삭제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리자 추가 또는 제거를 참조하세요.

다음 코드 예시에서는 delete-asset-model을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 모델을 삭제하려면

다음 delete-asset-model 예제에서는 풍력 터빈 자산 모델을 삭제합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 모델 삭제를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeleteAssetModel를 참조하세요.

다음 코드 예시에서는 delete-asset을 사용하는 방법을 보여 줍니다.

AWS CLI

자산을 삭제하려면

다음 delete-asset 예제에서는 풍력 터빈 자산을 삭제합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 삭제를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeleteAsset를 참조하세요.

다음 코드 예시에서는 delete-dashboard을 사용하는 방법을 보여 줍니다.

AWS CLI

대시보드를 삭제하려면

다음 delete-dashboard 예제에서는 풍력 터빈 대시보드를 삭제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word Monitor 애플리케이션 안내서의 대시보드 삭제를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeleteDashboard를 참조하세요.

다음 코드 예시에서는 delete-gateway을 사용하는 방법을 보여 줍니다.

AWS CLI

게이트웨이를 삭제하려면

다음 delete-gateway 예제에서는 게이트웨이를 삭제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 게이트웨이를 사용하여 데이터 수집을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeleteGateway를 참조하세요.

다음 코드 예시에서는 delete-portal을 사용하는 방법을 보여 줍니다.

AWS CLI

포털을 삭제하려면

다음 delete-portal 예제에서는 풍력 발전 단지 회사의 웹 포털을 삭제합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 삭제를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeletePortal를 참조하세요.

다음 코드 예시에서는 delete-project을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트를 삭제하려면

다음 delete-project 예제에서는 풍력 발전 단지 프로젝트를 삭제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트 삭제를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeleteProject를 참조하세요.

다음 코드 예시에서는 describe-access-policy을 사용하는 방법을 보여 줍니다.

AWS CLI

액세스 정책을 설명하려면

다음 describe-access-policy 예제에서는 풍력 발전 단지 회사의 웹 포털에 대한 사용자 관리 액세스 권한을 부여하는 액세스 정책을 설명합니다.

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

출력:

{
    "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"
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리자 추가 또는 제거를 참조하세요.

다음 코드 예시에서는 describe-asset-model을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 모델을 설명하려면

다음 describe-asset-model 예제에서는 풍력 발전 단지 자산 모델을 설명합니다.

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

출력:

{
    "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"
    }
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 특정 자산 모델 설명을 참조하세요.

다음 코드 예시에서는 describe-asset-property을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 속성을 설명하려면

다음 describe-asset-property 예제에서는 풍력 발전 단지 자산의 총 생성 전력 속성을 설명합니다.

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

출력:

{
    "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"
                    }
                }
            }
        }
    }
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 특정 자산 속성 설명을 참조하세요.

다음 코드 예시에서는 describe-asset을 사용하는 방법을 보여 줍니다.

AWS CLI

자산을 설명하려면

다음 describe-asset 예제에서는 풍력 발전 단지 자산을 설명합니다.

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

출력:

{
    "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"
    }
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 특정 자산 설명을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribeAsset를 참조하세요.

다음 코드 예시에서는 describe-dashboard을 사용하는 방법을 보여 줍니다.

AWS CLI

대시보드를 설명하려면

다음 describe-dashboard 예제에서는 지정된 풍력 발전 단지 대시보드를 설명합니다.

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

출력:

{
    "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"
}

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 대시보드 보기를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribeDashboard를 참조하세요.

다음 코드 예시에서는 describe-gateway-capability-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

게이트웨이 기능을 설명하려면

다음 describe-gateway-capability-configuration 예제에서는 OPC-UA 소스 기능을 설명합니다.

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

출력:

{
    "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"
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 데이터 소스 구성을 참조하세요.

다음 코드 예시에서는 describe-gateway을 사용하는 방법을 보여 줍니다.

AWS CLI

게이트웨이를 설명하려면

다음 describe-gateway 예제에서는 게이트웨이에 대해 설명합니다.

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

출력:

{
    "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
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 게이트웨이를 사용하여 데이터 수집을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribeGateway를 참조하세요.

다음 코드 예시에서는 describe-logging-options을 사용하는 방법을 보여 줍니다.

AWS CLI

현재 AWS IoT SiteWise Word 로깅 옵션을 검색하려면

다음 describe-logging-options 예제에서는 현재 리전의 AWS 계정에 대한 현재 AWS IoT SiteWise Word 로깅 옵션을 검색합니다.

aws iotsitewise describe-logging-options

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 Amazon CloudWatch Logs를 사용한 MonitoringIoTWord를 참조하세요. AWS IoT SiteWise

다음 코드 예시에서는 describe-portal을 사용하는 방법을 보여 줍니다.

AWS CLI

포털을 설명하려면

다음 describe-portal 예제에서는 풍력 발전 단지 회사의 웹 포털에 대해 설명합니다.

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

출력:

{
    "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"
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribePortal를 참조하세요.

다음 코드 예시에서는 describe-project을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트를 설명하려면

다음 describe-project 예제에서는 풍력 발전 단지 프로젝트를 설명합니다.

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

출력:

{
    "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"
}

자세한 내용은 AWS IoT SiteWise Word Monitor 애플리케이션 안내서의 프로젝트 세부 정보 보기를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribeProject를 참조하세요.

다음 코드 예시에서는 disassociate-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

상위 자산에서 하위 자산을 연결 해제하려면

다음 disassociate-assets 예제에서는 풍력 터빈 자산을 풍력 팜 자산과 연결 해제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 연결을 참조하세요.

다음 코드 예시에서는 get-asset-property-aggregates을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 속성의 집계된 평균 및 개수 값을 검색하려면

다음 get-asset-property-aggregates 예제에서는 1시간 동안 풍력 터빈 자산의 평균 총 전력과 총 전력 데이터 포인트 수를 검색합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 속성 집계 쿼리를 참조하세요.

다음 코드 예시에서는 get-asset-property-value-history을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 속성의 기록 값을 검색하려면

다음 get-asset-property-value-history 예제에서는 20분 동안 풍력 터빈 자산의 총 전력 값을 검색합니다.

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

출력:

{
    "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"
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 과거 자산 속성 값 쿼리를 참조하세요.

다음 코드 예시에서는 get-asset-property-value을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 속성의 현재 값을 검색하려면

다음 get-asset-property-value 예제에서는 풍력 터빈 자산의 현재 총 전력을 검색합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 현재 자산 속성 값 쿼리를 참조하세요.

다음 코드 예시에서는 list-access-policies을 사용하는 방법을 보여 줍니다.

AWS CLI

모든 액세스 정책을 나열하려면

다음 list-access-policies 예제에서는 포털 관리자인 사용자의 모든 액세스 정책을 나열합니다.

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

출력:

{
    "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"
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리를 참조하세요.

다음 코드 예시에서는 list-asset-models을 사용하는 방법을 보여 줍니다.

AWS CLI

모든 자산 모델을 나열하려면

다음 list-asset-models 예제에서는 현재 리전의 AWS 계정에 정의된 모든 자산 모델을 나열합니다.

aws iotsitewise list-asset-models

출력:

{
    "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"
            }
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 모든 자산 모델 나열을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListAssetModels를 참조하세요.

다음 코드 예시에서는 list-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

예제 1: 모든 최상위 자산을 나열하려면

다음 list-assets 예제에서는 자산 계층 구조 트리에서 최상위 수준이고 현재 리전의 AWS 계정에 정의된 모든 자산을 나열합니다.

aws iotsitewise list-assets \
    --filter TOP_LEVEL

출력:

{
    "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"
                }
            ]
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 나열을 참조하세요.

예제 2: 자산 모델을 기반으로 모든 자산을 나열하려면

다음 list-assets 예제에서는 자산 모델을 기반으로 현재 리전의 AWS 계정에 정의된 모든 자산을 나열합니다.

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

출력:

{
    "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": []
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 나열을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListAssets를 참조하세요.

다음 코드 예시에서는 list-associated-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

특정 계층 구조의 자산에 연결된 모든 자산을 나열하려면

다음 list-associated-assets 예제에서는 지정된 풍력 발전 단지 자산과 연결된 모든 풍력 터빈 자산을 나열합니다.

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

출력:

{
    "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": []
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 특정 자산과 연결된 자산 나열을 참조하세요.

다음 코드 예시에서는 list-dashboards을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트의 모든 대시보드를 나열하려면

다음 list-dashboards 예제에서는 프로젝트에 정의된 모든 대시보드를 나열합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 대시보드 보기를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListDashboards를 참조하세요.

다음 코드 예시에서는 list-gateways을 사용하는 방법을 보여 줍니다.

AWS CLI

모든 게이트웨이를 나열하려면

다음 list-gateways 예제에서는 현재 리전의 AWS 계정에 정의된 모든 게이트웨이를 나열합니다.

aws iotsitewise list-gateways

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 게이트웨이를 사용하여 데이터 수집을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListGateways를 참조하세요.

다음 코드 예시에서는 list-portals을 사용하는 방법을 보여 줍니다.

AWS CLI

모든 포털을 나열하려면

다음 list-portals 예제에서는 현재 리전의 AWS 계정에 정의된 모든 포털을 나열합니다.

aws iotsitewise list-portals

출력:

{
    "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"
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListPortals를 참조하세요.

다음 코드 예시에서는 list-project-assets을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트에 연결된 모든 자산을 나열하려면

다음 list-project-assets 예제에서는 풍력 발전 단지 프로젝트와 연결된 모든 자산을 나열합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트에 자산 추가를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListProjectAssets를 참조하세요.

다음 코드 예시에서는 list-projects을 사용하는 방법을 보여 줍니다.

AWS CLI

포털의 모든 프로젝트를 나열하려면

다음 list-projects 예제에서는 포털에 정의된 모든 프로젝트를 나열합니다.

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

출력:

{
    "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"
        }
    ]
}

자세한 내용은 AWS IoT SiteWise Word Monitor 애플리케이션 안내서의 프로젝트 세부 정보 보기를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 ListProjects를 참조하세요.

다음 코드 예시에서는 list-tags-for-resource을 사용하는 방법을 보여 줍니다.

AWS CLI

리소스의 모든 태그를 나열하려면

다음 list-tags-for-resource 예제에서는 풍력 터빈 자산의 모든 태그를 나열합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 리소스 태그 지정을 참조하세요.

다음 코드 예시에서는 put-logging-options을 사용하는 방법을 보여 줍니다.

AWS CLI

로깅 수준을 지정하려면

다음 put-logging-options 예제에서는 AWS IoT SiteWiseWord에서 INFO 수준 로깅을 활성화합니다. 다른 수준에는 DEBUG 및가 포함됩니다OFF.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 Amazon CloudWatch Logs를 사용한 MonitoringIoTWord를 참조하세요. AWS IoT SiteWise

  • API 세부 정보는 AWS CLI 명령 참조의 PutLoggingOptions를 참조하세요.

다음 코드 예시에서는 tag-resource을 사용하는 방법을 보여 줍니다.

AWS CLI

리소스에 태그를 추가하려면

다음 tag-resource 예제에서는 풍력 터빈 자산에 소유자 태그를 추가합니다. 이를 통해 자산 소유자에 따라 자산에 대한 액세스를 제어할 수 있습니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 리소스 태그 지정을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 TagResource를 참조하세요.

다음 코드 예시에서는 untag-resource을 사용하는 방법을 보여 줍니다.

AWS CLI

리소스에서 태그를 제거하려면

다음 untag-resource 예제에서는 풍력 터빈 자산에서 소유자 태그를 제거합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 리소스 태그 지정을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 UntagResource를 참조하세요.

다음 코드 예시에서는 update-access-policy을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트 뷰어에게 프로젝트의 소유권을 부여하려면

다음 update-access-policy 예제에서는 프로젝트 뷰어에게 프로젝트의 소유권을 부여하는 액세스 정책을 업데이트합니다.

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

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"
        }
    }
}

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word Monitor 애플리케이션 안내서의 프로젝트 소유자 할당을 참조하세요.

다음 코드 예시에서는 update-asset-model을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 모델을 업데이트하려면

다음 update-asset-model 예제에서는 풍력 발전 단지 자산 모델의 설명을 업데이트합니다. 이 예제에서는가 기존 모델을 새 모델로 update-asset-model 덮어쓰기 때문에 모델의 기존 IDs 및 정의를 포함합니다.

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

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"
        }
    ]
}

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 모델 업데이트를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 UpdateAssetModel를 참조하세요.

다음 코드 예시에서는 update-asset-property을 사용하는 방법을 보여 줍니다.

AWS CLI

예제 1: 자산 속성의 별칭을 업데이트하려면

다음 update-asset-property 예제에서는 풍력 터빈 자산의 전력 속성 별칭을 업데이트합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 속성에 산업 데이터 스트림 매핑을 참조하세요.

예제 2: 자산 속성 알림을 활성화하려면

다음 update-asset-property 예제에서는 풍력 터빈 자산의 전력 속성에 대한 자산 속성 업데이트 알림을 활성화합니다. 속성 값 업데이트는 MQTT 주제에 게시되며$aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, 여기서 각 ID는 자산 속성의 속성, 자산 및 모델 ID로 대체됩니다.

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"

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 다른 서비스와 상호 작용을 참조하세요.

다음 코드 예시에서는 update-asset을 사용하는 방법을 보여 줍니다.

AWS CLI

자산 이름을 업데이트하려면

다음 update-asset 예제에서는 풍력 터빈 자산의 이름을 업데이트합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 자산 업데이트를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 UpdateAsset를 참조하세요.

다음 코드 예시에서는 update-dashboard을 사용하는 방법을 보여 줍니다.

AWS CLI

대시보드를 업데이트하려면

다음 update-dashboard 예제에서는 풍력 발전 단지에 대해 생성된 총 전력을 표시하는 대시보드의 선 차트 제목을 변경합니다.

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

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"
                }
            ]
        }
    ]
}

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 IoTCLI 사용 설명서의 대시보드 생성(Word)을 참조하세요. AWS IoT SiteWise

  • API 세부 정보는 AWS CLI 명령 참조의 UpdateDashboard를 참조하세요.

다음 코드 예시에서는 update-gateway-capability-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

게이트웨이 기능을 업데이트하려면

다음 update-gateway-capability-configuration 예제에서는 다음 속성을 사용하여 OPC-UA 소스를 구성합니다.

모든 인증서를 신뢰합니다. Basic256 알고리즘을 사용하여 메시지를 보호합니다. SignAndEncrypt 모드를 사용하여 연결을 보호합니다. 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

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": ""
        }
    ]
}

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 데이터 소스 구성을 참조하세요.

다음 코드 예시에서는 update-gateway을 사용하는 방법을 보여 줍니다.

AWS CLI

게이트웨이 이름을 업데이트하려면

다음 update-gateway 예제에서는 게이트웨이의 이름을 업데이트합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 게이트웨이를 사용하여 데이터 수집을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 UpdateGateway를 참조하세요.

다음 코드 예시에서는 update-portal을 사용하는 방법을 보여 줍니다.

AWS CLI

포털의 세부 정보를 업데이트하려면

다음 update-portal 예제에서는 풍력 발전 단지 회사의 웹 포털을 업데이트합니다.

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

출력:

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

자세한 내용은 AWS IoT SiteWise Word 사용 설명서의 포털 관리를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 UpdatePortal를 참조하세요.

다음 코드 예시에서는 update-project을 사용하는 방법을 보여 줍니다.

AWS CLI

프로젝트 세부 정보를 업데이트하려면

다음 update-project 예제에서는 풍력 발전 단지 프로젝트를 업데이트합니다.

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."

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT SiteWise Word Monitor Application Guide의 프로젝트 세부 정보 변경을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 UpdateProject를 참조하세요.