IoTSiteWise / Client / describe_dashboard

describe_dashboard#

IoTSiteWise.Client.describe_dashboard(**kwargs)#

Retrieves information about a dashboard.

Request Syntax

response = client.describe_dashboard(
    dashboardId='string'
)

Parameters:

dashboardId (string) –

[REQUIRED]

The ID of the dashboard.

Return type:

dict

Returns:

Response Syntax

{
    'dashboardId': 'string',
    'dashboardArn': 'string',
    'dashboardName': 'string',
    'projectId': 'string',
    'dashboardDescription': 'string',
    'dashboardDefinition': 'string',
    'dashboardCreationDate': datetime(2015, 1, 1),
    'dashboardLastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- dashboardId (string) –
  
  The ID of the dashboard.
- dashboardArn (string) –
  
  The ARN of the dashboard, which has the following format.
  
  arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
- dashboardName (string) –
  
  The name of the dashboard.
- projectId (string) –
  
  The ID of the project that the dashboard is in.
- dashboardDescription (string) –
  
  The dashboard’s description.
- dashboardDefinition (string) –
  
  The dashboard’s definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
- dashboardCreationDate (datetime) –
  
  The date the dashboard was created, in Unix epoch time.
- dashboardLastUpdateDate (datetime) –
  
  The date the dashboard was last updated, in Unix epoch time.

Exceptions

IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.ThrottlingException