Skip to content

DescribeDashboardResponse

Source code in docs_src/capo_iotsitewise/types/describe_dashboard_response.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class DescribeDashboardResponse(TypedDict, closed=True):
    dashboard_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the dashboard.</p>"""
    dashboard_arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>"""
    dashboard_name: "capo_iotsitewise.types.name.Name"
    """<p>The name of the dashboard.</p>"""
    project_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the project that the dashboard is in.</p>"""
    dashboard_description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>The dashboard's description.</p>"""
    dashboard_definition: (
        "capo_iotsitewise.types.dashboard_definition.DashboardDefinition"
    )
    """<p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    dashboard_creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the dashboard was created, in Unix epoch time.</p>"""
    dashboard_last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the dashboard was last updated, in Unix epoch time.</p>"""

dashboard_arn instance-attribute 

dashboard_arn: ARN

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

dashboard_creation_date instance-attribute 

dashboard_creation_date: Timestamp

The date the dashboard was created, in Unix epoch time.

dashboard_definition instance-attribute 

dashboard_definition: DashboardDefinition

The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

dashboard_description instance-attribute 

dashboard_description: NotRequired[Description]

The dashboard's description.

dashboard_id instance-attribute 

dashboard_id: ID

The ID of the dashboard.

dashboard_last_update_date instance-attribute 

dashboard_last_update_date: Timestamp

The date the dashboard was last updated, in Unix epoch time.

dashboard_name instance-attribute 

dashboard_name: Name

The name of the dashboard.

project_id instance-attribute 

project_id: ID

The ID of the project that the dashboard is in.