aws iotsitewise describe-portal --portal-id does not include edgeConfig/edgeAccess values within the AWS response.

[bobneuman]

Describe the bug

aws iotsitewise describe-portal --portal-id [idnumber] does not display the information related to the edgeConfig enablement that is returned within the response from AWS.
I you run the command with --debug the MainThread - botocore.parsers - DEBUG - Response body: {} includes the "edgeConfig": { "edgeAccess": "ENABLED" }, but the cli output does not.

Regression Issue

• Select this option if this issue appears to be a regression.

Expected Behavior

I'd expect the cli to display the information in the MainThread - botocore.parsers - DEBUG - Response body: {}

Current Behavior

The cli of aws iotsitewise describe-portal --portal-id _____ fails to include the "edgeConfig": { "edgeAccess": "ENABLED" } or "edgeConfig": null

Reproduction Steps

Create a sitewise edge portal and use the id to query aws iotsitewise describe-portal --portal-id _____ --debug. A review of the MainThread - botocore.parsers - DEBUG - Response body should have "edgeConfig": null. Then using the console navigate to the portal and enable the edge (see. ___ ). Wait a few minutes and rerun the command aws iotsitewise describe-portal --portal-id _____ --debug the debug content will include "edgeConfig": { "edgeAccess": "ENABLED"} , but the cli output will not.

Possible Solution

No response

Additional Information/Context

Update the Create and Update Portal functions of the cli to allow setting the edgeAccess to ENABLED. Cloudtrail captures the following when the setting is altered in the console.

  { .....
    "eventName": "UpdatePortal",
    ....
    "requestParameters": {
        "portalName": "My-Portal",
        "roleArn": "arn:aws:iam::123456789011:role/AWSIoTSiteWiseMonitorServiceRole",
        "clientToken": "aaaaaaaa-bbbb-cccc-ddddddddddd",
        "portalId": "aaaaaaaa-bbbb-cccc-ddddddddddd",
        "portalContactEmail": "[email protected]",
        "edgeConfig": {
            "edgeAccess": "ENABLED"
        },
        "portalDescription": "My-Portal description"
    },

CLI version used

aws-cli/2.22.26 Python/3.12.6

Environment details (OS name and version, etc.)

Linux/6.1.0-27-amd64 exe/x86_64.debian.12

[RyanFitzSimmonsAK]

Hi @bobneuman, thanks for reaching out. I was able to reproduce this behavior; the unparsed response contains several unmodeled fields, including edgeConfig": { "edgeAccess": "ENABLED" }. Because this operation doesn't document that it returns this value, technically the expected behavior would be for it to be absent. However, given that it's already returning it, the ideal solution would probably be to change the model file so that the parsed response includes it. I've reached out to the service team, and will let you know when I have any updates. In the meantime, you'd need to use the unparsed response if you want to get this value using describe-portal.

Ticket # for internal use : P186030809

[bobneuman]

RyanFitzSimmonsAK the requirements should align to the published service. The ability to set the edgeConfig": { "edgeAccess": "ENABLED" } for SiteWise via the console has been present for months. The CLI and SDKs should implement those items. Backloged somewhere?

[nateprewitt]

Hi @bobneuman,

To provide a little more clarity, you can check the official API Reference for AWS IoT Sitewise. They don't currently publish edgeConfig as being part of their public API. This is why all AWS SDKs (including the AWS CLI) currently ignore this value in the response. This may be an oversight from the Sitewise team though.

Once they confirm their intent and officially flag this as part of their public API, it should be available in all of our public tooling. @RyanFitzSimmonsAK will follow up once we get clearer guidance from the service team.

[RyanFitzSimmonsAK]

Hey, thanks for your patience, the service team got back to me. This value is not intended to be part of the response, and won't be added to the public model. Because this behavior is subject to change, customers should not rely on it. Unfortunately, there isn't an intended way to interact with this setting programatically. You'll have to use the console for a supported way to use this feature.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

[bobneuman]

@RyanFitzSimmonsAK interesting response from the service team. Although the API docs are not updated with the 'edgeConfig' it does set the value via a direct API call by a lambda. I'll use that until something is published or they deprecate the capability.