AWS IoT SiteWise contoh menggunakan AWS CLI - AWS Contoh Kode SDK
Tindakan

Ada lebih banyak contoh AWS SDK yang tersedia di repo Contoh SDK AWS Doc. GitHub

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

AWS IoT SiteWise contoh menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan mengimplementasikan skenario umum dengan menggunakan AWS Command Line Interface with AWS IoT SiteWise.

Tindakan merupakan kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakanassociate-assets.

AWS CLI

Untuk mengaitkan aset anak dengan aset orang tua

associate-assetsContoh berikut mengaitkan aset turbin angin ke aset ladang angin, di mana model aset turbin angin ada sebagai hierarki dalam model aset ladang angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaitkan aset di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanbatch-associate-project-assets.

AWS CLI

Untuk mengaitkan aset dengan proyek

batch-associate-project-assetsContoh berikut mengaitkan aset ladang angin ke sebuah proyek.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menambahkan aset ke proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanbatch-disassociate-project-assets.

AWS CLI

Untuk memisahkan aset dari proyek

batch-disassociate-project-assetsContoh berikut memisahkan aset ladang angin dari sebuah proyek.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menambahkan aset ke proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanbatch-put-asset-property-value.

AWS CLI

Untuk mengirim data ke properti aset

batch-put-asset-property-valueContoh berikut mengirimkan data daya dan suhu ke properti aset yang diidentifikasi oleh alias properti.

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

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

Output:

{
    "errorEntries": []
}

Untuk informasi selengkapnya, lihat Menyerap data menggunakan API AWS SiteWise IoT di Panduan Pengguna AWS IoT SiteWise .

Contoh kode berikut menunjukkan cara menggunakancreate-access-policy.

AWS CLI

Contoh 1: Untuk memberikan akses administratif pengguna ke portal

create-access-policyContoh berikut membuat kebijakan akses yang memberikan akses administratif pengguna ke portal web untuk perusahaan peternakan angin.

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

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

Output:

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

Untuk informasi selengkapnya, lihat Menambahkan atau menghapus administrator portal di Panduan Pengguna AWS SiteWise IoT.

Contoh 2: Untuk memberikan pengguna akses hanya-baca ke proyek

create-access-policyContoh berikut membuat kebijakan akses yang memberikan pengguna akses hanya-baca ke proyek ladang angin.

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

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

Output:

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

Untuk informasi selengkapnya, lihat Menetapkan pemirsa proyek di Panduan Aplikasi Monitor AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakancreate-asset-model.

AWS CLI

Untuk membuat model aset

create-asset-modelContoh berikut menciptakan model aset yang mendefinisikan turbin angin dengan sifat-sifat berikut:

Nomor seri - Nomor seri turbin anginDaya energi - Aliran data daya yang dihasilkan dari turbin anginSuhu C - Aliran data suhu dari turbin angin di CelsiusTemperature F - Titik data suhu yang dipetakan dari Celcius ke Fahrenheit

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

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

Output:

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

Untuk informasi selengkapnya, lihat Mendefinisikan model aset di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakancreate-asset.

AWS CLI

Untuk membuat aset

create-assetContoh berikut menciptakan aset turbin angin dari model aset turbin angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Membuat aset di SiteWise Panduan Pengguna AWS IoT.

  • Untuk detail API, lihat CreateAssetdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-dashboard.

AWS CLI

Untuk membuat dasbor

create-dashboardContoh berikut membuat dasbor dengan diagram garis yang menampilkan total daya yang dihasilkan untuk ladang angin.

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

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

Output:

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

Untuk informasi selengkapnya, lihat Membuat dasbor (CLI) di Panduan Pengguna AWS IoT SiteWise .

Contoh kode berikut menunjukkan cara menggunakancreate-gateway.

AWS CLI

Untuk membuat gateway

create-gatewayContoh berikut membuat gateway yang berjalan di 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}

Output:

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

Untuk informasi selengkapnya, lihat Mengonfigurasi gateway di Panduan AWS Pengguna SiteWise IoT.

  • Untuk detail API, lihat CreateGatewaydi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-portal.

AWS CLI

Untuk membuat portal

create-portalContoh berikut membuat portal web untuk perusahaan peternakan angin. Anda dapat membuat portal hanya di Wilayah yang sama tempat Anda mengaktifkan 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

Output:

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

Untuk informasi selengkapnya, lihat Memulai SiteWise Monitor AWS IoT di Panduan SiteWise Pengguna AWS IoT dan Mengaktifkan SSO AWS di Panduan Pengguna IoT..AWS SiteWise

  • Untuk detail API, lihat CreatePortaldi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-project.

AWS CLI

Untuk membuat proyek

create-projectContoh berikut menciptakan proyek ladang angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Membuat proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

  • Untuk detail API, lihat CreateProjectdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-access-policy.

AWS CLI

Untuk mencabut akses pengguna ke proyek atau portal

delete-access-policyContoh berikut menghapus kebijakan akses yang memberikan akses administratif pengguna ke portal.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menambahkan atau menghapus administrator portal di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandelete-asset-model.

AWS CLI

Untuk menghapus model aset

delete-asset-modelContoh berikut menghapus model aset turbin angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menghapus model aset di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandelete-asset.

AWS CLI

Untuk menghapus aset

delete-assetContoh berikut menghapus aset turbin angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menghapus aset di Panduan AWS Pengguna SiteWise IoT.

  • Untuk detail API, lihat DeleteAssetdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-dashboard.

AWS CLI

Untuk menghapus dasbor

delete-dashboardContoh berikut menghapus dasbor turbin angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menghapus dasbor di Panduan Aplikasi Monitor AWS IoT SiteWise .

Contoh kode berikut menunjukkan cara menggunakandelete-gateway.

AWS CLI

Untuk menghapus gateway

delete-gatewayContoh berikut menghapus gateway.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menyerap data menggunakan gateway di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat DeleteGatewaydi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-portal.

AWS CLI

Untuk menghapus portal

delete-portalContoh berikut menghapus portal web untuk perusahaan peternakan angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menghapus portal di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat DeletePortaldi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-project.

AWS CLI

Untuk menghapus proyek

delete-projectContoh berikut menghapus proyek ladang angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menghapus proyek di Panduan Aplikasi Monitor AWS SiteWise IoT.

  • Untuk detail API, lihat DeleteProjectdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-access-policy.

AWS CLI

Untuk mendeskripsikan kebijakan akses

describe-access-policyContoh berikut menjelaskan kebijakan akses yang memberikan akses administratif pengguna ke portal web untuk perusahaan peternakan angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menambahkan atau menghapus administrator portal di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-asset-model.

AWS CLI

Untuk menggambarkan model aset

describe-asset-modelContoh berikut menjelaskan model aset ladang angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menjelaskan model aset tertentu di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-asset-property.

AWS CLI

Untuk mendeskripsikan properti aset

describe-asset-propertyContoh berikut menjelaskan total properti daya yang dihasilkan aset ladang angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menjelaskan properti aset tertentu di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-asset.

AWS CLI

Untuk mendeskripsikan aset

describe-assetContoh berikut menjelaskan aset ladang angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menjelaskan aset tertentu di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat DescribeAssetdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-dashboard.

AWS CLI

Untuk mendeskripsikan dasbor

describe-dashboardContoh berikut menjelaskan dasbor ladang angin yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Melihat dasbor di Panduan Aplikasi Monitor AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-gateway-capability-configuration.

AWS CLI

Untuk menggambarkan kemampuan gateway

describe-gateway-capability-configurationContoh berikut menjelaskan kemampuan sumber OPC-UA.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengonfigurasi sumber data di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-gateway.

AWS CLI

Untuk menggambarkan gateway

describe-gatewayContoh berikut menjelaskan gateway.

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

Output:

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

Untuk informasi selengkapnya, lihat Menyerap data menggunakan gateway di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-logging-options.

AWS CLI

Untuk mengambil opsi pencatatan AWS SiteWise IoT saat ini

describe-logging-optionsContoh berikut mengambil opsi pencatatan AWS SiteWise IoT saat ini untuk akun AWS Anda di Wilayah saat ini.

aws iotsitewise describe-logging-options

Output:

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

Untuk informasi selengkapnya, lihat Memantau AWS IoT dengan CloudWatch Log SiteWise Amazon di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakandescribe-portal.

AWS CLI

Untuk mendeskripsikan sebuah portal

describe-portalContoh berikut menjelaskan portal web untuk perusahaan peternakan angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengelola portal Anda di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat DescribePortaldi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-project.

AWS CLI

Untuk menggambarkan sebuah proyek

describe-projectContoh berikut menjelaskan proyek ladang angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Melihat detail proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

Contoh kode berikut menunjukkan cara menggunakandisassociate-assets.

AWS CLI

Untuk memisahkan aset anak dari aset orang tua

disassociate-assetsContoh berikut memisahkan aset turbin angin dari aset ladang angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaitkan aset di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanget-asset-property-aggregates.

AWS CLI

Untuk mengambil nilai rata-rata agregat dan menghitung nilai properti aset

get-asset-property-aggregatesContoh berikut mengambil daya total rata-rata aset turbin angin dan jumlah titik data daya total untuk periode 1 jam.

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

Output:

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

Untuk informasi selengkapnya, lihat Menanyakan agregat properti aset di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanget-asset-property-value-history.

AWS CLI

Untuk mengambil nilai historis properti aset

get-asset-property-value-historyContoh berikut mengambil nilai daya total aset turbin angin untuk jangka waktu 20 menit.

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

Output:

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

Untuk informasi selengkapnya, lihat Menanyakan nilai properti aset historis di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanget-asset-property-value.

AWS CLI

Untuk mengambil nilai aset properti saat ini

get-asset-property-valueContoh berikut mengambil daya total aset turbin angin saat ini.

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

Output:

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

Untuk informasi selengkapnya, lihat Menanyakan nilai properti aset saat ini di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-access-policies.

AWS CLI

Untuk mencantumkan semua kebijakan akses

list-access-policiesContoh berikut mencantumkan semua kebijakan akses untuk pengguna yang merupakan administrator portal.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengelola portal Anda di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-asset-models.

AWS CLI

Untuk membuat daftar semua model aset

list-asset-modelsContoh berikut mencantumkan semua model aset yang ditentukan di AWS akun Anda di Wilayah saat ini.

aws iotsitewise list-asset-models

Output:

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

Untuk informasi selengkapnya, lihat Mencantumkan semua model aset di SiteWise Panduan Pengguna AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-assets.

AWS CLI

Contoh 1: Untuk mencantumkan semua aset tingkat atas

list-assetsContoh berikut mencantumkan semua aset yang berada di level teratas dalam pohon hierarki aset dan ditentukan di AWS akun Anda di Wilayah saat ini.

aws iotsitewise list-assets \
    --filter TOP_LEVEL

Output:

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

Untuk informasi selengkapnya, lihat Mencantumkan aset di SiteWise Panduan Pengguna AWS IoT.

Contoh 2: Untuk membuat daftar semua aset berdasarkan model aset

list-assetsContoh berikut mencantumkan semua aset berdasarkan model aset dan didefinisikan di AWS akun Anda di Wilayah saat ini.

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

Output:

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

Untuk informasi selengkapnya, lihat Mencantumkan aset di SiteWise Panduan Pengguna AWS IoT.

  • Untuk detail API, lihat ListAssetsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-associated-assets.

AWS CLI

Untuk mencantumkan semua aset yang terkait dengan aset dalam hierarki tertentu

list-associated-assetsContoh berikut mencantumkan semua aset turbin angin yang terkait dengan aset ladang angin yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Mencantumkan aset yang terkait dengan aset tertentu di SiteWise Panduan Pengguna AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-dashboards.

AWS CLI

Untuk membuat daftar semua dasbor dalam sebuah proyek

list-dashboardsContoh berikut mencantumkan semua dasbor yang didefinisikan dalam sebuah proyek.

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

Output:

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

Untuk informasi selengkapnya, lihat Melihat dasbor di Panduan Aplikasi Monitor AWS SiteWise IoT.

  • Untuk detail API, lihat ListDashboardsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-gateways.

AWS CLI

Untuk membuat daftar semua gateway

list-gatewaysContoh berikut mencantumkan semua gateway yang ditentukan di AWS akun Anda di Wilayah saat ini.

aws iotsitewise list-gateways

Output:

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

Untuk informasi selengkapnya, lihat Menyerap data menggunakan gateway di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat ListGatewaysdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-portals.

AWS CLI

Untuk daftar semua portal

list-portalsContoh berikut mencantumkan semua portal yang ditentukan di AWS akun Anda di Wilayah saat ini.

aws iotsitewise list-portals

Output:

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

Untuk informasi selengkapnya, lihat Mengelola portal Anda di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat ListPortalsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-project-assets.

AWS CLI

Untuk mencantumkan semua aset yang terkait dengan proyek

list-project-assetsContoh berikut mencantumkan semua aset yang terkait dengan proyek ladang angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menambahkan aset ke proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-projects.

AWS CLI

Untuk membuat daftar semua proyek di portal

list-projectsContoh berikut mencantumkan semua proyek yang didefinisikan dalam portal.

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

Output:

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

Untuk informasi selengkapnya, lihat Melihat detail proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

  • Untuk detail API, lihat ListProjectsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-tags-for-resource.

AWS CLI

Untuk mencantumkan semua tag untuk sumber daya

list-tags-for-resourceContoh berikut mencantumkan semua tag untuk aset turbin angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Menandai sumber daya Anda di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanput-logging-options.

AWS CLI

Untuk menentukan tingkat logging

put-logging-optionsContoh berikut memungkinkan INFO level logging di AWS IoT SiteWise. Level lainnya termasuk DEBUG danOFF.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Memantau AWS IoT dengan CloudWatch Log SiteWise Amazon di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakantag-resource.

AWS CLI

Untuk menambahkan tanda ke sumber daya

tag-resourceContoh berikut menambahkan tag pemilik ke aset turbin angin. Ini memungkinkan Anda mengontrol akses ke aset berdasarkan siapa yang memilikinya.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menandai sumber daya Anda di Panduan AWS Pengguna SiteWise IoT.

  • Untuk detail API, lihat TagResourcedi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanuntag-resource.

AWS CLI

Untuk menghapus tag dari sumber daya

untag-resourceContoh berikut menghapus tag pemilik dari aset turbin angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menandai sumber daya Anda di Panduan AWS Pengguna SiteWise IoT.

  • Untuk detail API, lihat UntagResourcedi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-access-policy.

AWS CLI

Untuk memberikan kepemilikan proyek kepada penampil proyek

update-access-policyContoh berikut memperbarui kebijakan akses yang memberikan kepemilikan proyek kepada penampil proyek.

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

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menetapkan pemilik proyek di Panduan Aplikasi Monitor AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanupdate-asset-model.

AWS CLI

Untuk memperbarui model aset

update-asset-modelContoh berikut memperbarui deskripsi model aset ladang angin. Contoh ini mencakup model yang ada IDs dan definisi, karena update-asset-model menimpa model yang ada dengan model baru.

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

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

Output:

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

Untuk informasi selengkapnya, lihat Memperbarui model aset di SiteWise Panduan Pengguna AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanupdate-asset-property.

AWS CLI

Contoh 1: Untuk memperbarui alias properti aset

update-asset-propertyContoh berikut memperbarui alias properti daya aset turbin angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Memetakan aliran data industri ke properti aset di Panduan Pengguna AWS SiteWise IoT.

Contoh 2: Untuk mengaktifkan notifikasi properti aset

update-asset-propertyContoh berikut memungkinkan pemberitahuan pembaruan properti aset untuk properti daya aset turbin angin. Pembaruan nilai properti dipublikasikan ke topik MQTT$aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, di mana setiap ID diganti dengan properti, aset, dan ID model properti aset.

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"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Berinteraksi dengan layanan lain di Panduan Pengguna AWS SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanupdate-asset.

AWS CLI

Untuk memperbarui nama aset

update-assetContoh berikut memperbarui nama aset turbin angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Memperbarui aset di SiteWise Panduan Pengguna AWS IoT.

  • Untuk detail API, lihat UpdateAssetdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-dashboard.

AWS CLI

Untuk memperbarui dasbor

update-dashboardContoh berikut mengubah judul bagan garis dasbor yang menampilkan total daya yang dihasilkan untuk ladang angin.

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

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Membuat dasbor (CLI) di Panduan Pengguna AWS IoT SiteWise .

Contoh kode berikut menunjukkan cara menggunakanupdate-gateway-capability-configuration.

AWS CLI

Untuk memperbarui kemampuan gateway

update-gateway-capability-configurationContoh berikut mengonfigurasi sumber OPC-UA dengan properti berikut:

Mempercayai sertifikat apa pun.Menggunakan algoritma Basic256 untuk mengamankan pesan.Menggunakan SignAndEncrypt mode untuk mengamankan koneksi.Menggunakan kredensil otentikasi yang disimpan dalam rahasia 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

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

Output:

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

Untuk informasi selengkapnya, lihat Mengonfigurasi sumber data di Panduan AWS Pengguna SiteWise IoT.

Contoh kode berikut menunjukkan cara menggunakanupdate-gateway.

AWS CLI

Untuk memperbarui nama gateway

update-gatewayContoh berikut memperbarui nama gateway.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menyerap data menggunakan gateway di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat UpdateGatewaydi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-portal.

AWS CLI

Untuk memperbarui detail portal

update-portalContoh berikut memperbarui portal web untuk perusahaan peternakan angin.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengelola portal Anda di Panduan Pengguna AWS SiteWise IoT.

  • Untuk detail API, lihat UpdatePortaldi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-project.

AWS CLI

Untuk memperbarui detail proyek

update-projectContoh berikut memperbarui proyek ladang angin.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengubah detail proyek di Panduan Aplikasi SiteWise Monitor AWS IoT.

  • Untuk detail API, lihat UpdateProjectdi Referensi AWS CLI Perintah.