CmdID

CmdID / aws / aws iotsitewise

aws iotsitewise describe-portal

Retrieves information about a portal. AWS CLI reference

1 example 1 option Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

To describe a portal

The following describe-portal example describes a web portal for a wind farm company.

aws iotsitewise describe-portal --portal-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Identify
--portal-idThe ID of the portal.
Its output
{
    "portalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "portalName": "WindFarmPortal",
    "portalDescription": "A portal that contains wind farm projects for Example Corp.",
    "portalClientId": "E-a1b2c3d4e5f6_a1b2c3d4e5f6EXAMPLE",
    "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.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"
}

For more information, see Administering your portals in the AWS IoT SiteWise User Guide.

Options

1 in the AWS CLI reference
--portal-idThe ID of the portal.