AWS iot-sitewise documentation change
Summary
Added multiple new sections for managing SiteWise Edge gateways including listing, describing, creating, updating capability configurations, tagging operations, and enhanced deletion instructions with AWS CLI examples
Security assessment
The changes add standard management operations documentation without referencing security vulnerabilities or patching. The capability configuration section shows security policy settings but documents normal configuration options rather than addressing a specific vulnerability
Diff
diff --git a/iot-sitewise/latest/userguide/manage-gateways-ggv2.md b/iot-sitewise/latest/userguide/manage-gateways-ggv2.md index a931ec74d..bdca255ce 100644 --- a//iot-sitewise/latest/userguide/manage-gateways-ggv2.md +++ b//iot-sitewise/latest/userguide/manage-gateways-ggv2.md @@ -5 +5 @@ -Manage your SiteWise Edge gateway with the AWS IoT SiteWise consoleManage SiteWise Edge gateways using AWS OpsHub for AWS IoT SiteWiseAccess your SiteWise Edge gateway using local operating system credentialsManage the SiteWise Edge gateway certificateChange the version of SiteWise Edge gateway component packsUpdate the version of an AWS IoT SiteWise componentDelete a SiteWise Edge gateway +Manage your SiteWise Edge gateway with the AWS IoT SiteWise consoleManage SiteWise Edge gateways using AWS OpsHub for AWS IoT SiteWiseAccess your SiteWise Edge gateway using local operating system credentialsManage the SiteWise Edge gateway certificateChange the version of SiteWise Edge gateway component packsList SiteWise Edge gatewaysDescribe a SiteWise Edge gatewayCreate a SiteWise Edge gatewayUpdate a SiteWise Edge gatewayUpdate gateway capability configurationTag gateway resourcesList tags for a gatewayRemove tags from a gatewayUpdate the version of an AWS IoT SiteWise componentDelete a SiteWise Edge gateway @@ -252,0 +253,362 @@ You can use the AWS IoT SiteWise console to change the version of component pack +## List SiteWise Edge gateways + +Console + + +###### To list SiteWise Edge gateways + + 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). + + 2. In the navigation pane, choose **Edge gateways**. + + 3. View the list of all your SiteWise Edge gateways. + + + + +AWS CLI + + +To list your gateways using AWS CLI, follow these steps: + + * Use the list-gateways command to view all your gateways: + + aws iotsitewise list-gateways + +This command returns a list of your gateways with their IDs, names, and other information. + +You can also specify pagination parameters: + + aws iotsitewise list-gateways --max-results 10 --next-token your-token + + + + +For more information, see [list-gateways](https://docs.aws.amazon.com/cli/latest/reference/iotsitewise/list-gateways.html) in the AWS CLI Command Reference. + +## Describe a SiteWise Edge gateway + +Console + + +###### To view gateway details + + 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). + + 2. In the navigation pane, choose **Edge gateways**. + + 3. Choose the name of the gateway you want to view details for. + + 4. View the gateway details on the **Edge gateway details** page. + + + + +AWS CLI + + +To get detailed information about a specific gateway using AWS CLI, follow these steps: + + * Use the describe-gateway command with the gateway ID: + + aws iotsitewise describe-gateway --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE + +This command returns detailed information about the gateway. + + + + +For more information, see [describe-gateway](https://docs.aws.amazon.com/cli/latest/reference/iotsitewise/describe-gateway.html) in the AWS CLI Command Reference. + +## Create a SiteWise Edge gateway + +Console + + +###### To create a SiteWise Edge gateway + + 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). + + 2. In the navigation pane, choose **Edge gateways**. + + 3. Choose **Create gateway**. + + 4. Enter a name for your gateway. + + 5. Select the Greengrass group for your gateway. + + 6. Optionally, add tags to your gateway. + + 7. Choose **Create**. + + + + +AWS CLI + + +To create a new IoT SiteWise gateway using AWS CLI, follow these steps: + + * Use the create-gateway command to create a new gateway: + + aws iotsitewise create-gateway \ + --gateway-name "NewSiteWiseGateway" \ + --gateway-platform '{ + "greengrass": { + "groupArn": "arn:aws:greengrass:us-east-1:123456789012:group/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE" + } + }' \ + --tags '{ + "Environment": "Production", + "Location": "Factory1" + }' + +This command returns the new gateway's ID and ARN: + + { + "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", + "gatewayArn": "arn:aws:iotsitewise:us-east-1:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE" + } + + + + +For more information, see [create-gateway](https://docs.aws.amazon.com/cli/latest/reference/iotsitewise/create-gateway.html) in the AWS CLI Command Reference. + +## Update a SiteWise Edge gateway + +Console + + +###### To update a SiteWise Edge gateway + + 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). + + 2. In the navigation pane, choose **Edge gateways**. + + 3. Select the gateway you want to update. + + 4. Choose **Edit**. + + 5. Update the gateway name or other settings as needed. + + 6. Choose **Save**. + + + + +AWS CLI + + +To update an existing gateway using AWS CLI, follow these steps: + + * Use the update-gateway command to update a gateway's name: + + aws iotsitewise update-gateway \ + --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ + --gateway-name "UpdatedGatewayName" + +This command produces no output when successful. + + + + +For more information, see [update-gateway](https://docs.aws.amazon.com/cli/latest/reference/iotsitewise/update-gateway.html) in the AWS CLI Command Reference. + +## Update gateway capability configuration + +Console + + +###### To update gateway capability configuration + + 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). + + 2. In the navigation pane, choose **Edge gateways**. + + 3. Choose the name of the gateway you want to update. + + 4. In the **Data sources** section, choose **Edit**. + + 5. Update the data source configuration as needed. + + 6. Choose **Save**. + + + + +AWS CLI + + +To update a gateway's capability configuration using AWS CLI, follow these steps: +