DashboardDetailsResponseBody

pydantic model openapi_client.models.dashboard_details_response_body.DashboardDetailsResponseBody

Full dashboard metadata returned by GET without option.

Fields:

• access_type (openapi_client.models.resource_access_type.ResourceAccessType | None)

• created_by (str | None)

• creation_time (str | None)

• current_slug (str | None)

• custom_id (str | None)

• custom_url_path (str | None)

• dashboard_description (str | None)

• dashboard_id (str)

• dashboard_name (str)

• insight_metrics (List[Any] | None)

• keywords (List[str] | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• message (str | None)

• resources (List[openapi_client.models.dashboard_details_response_body_resources_inner.DashboardDetailsResponseBodyResourcesInner] | None)

• widgets (List[openapi_client.models.widgets_inner.WidgetsInner] | None)

field dashboard_name: StrictStr [Required] (alias 'DashboardName')

Name of the dashboard

Constraints:

• strict = True

field dashboard_id: StrictStr [Required] (alias 'DashboardId')

Unique identifier for the dashboard

Constraints:

• strict = True

field dashboard_description: Optional[StrictStr] = None (alias 'DashboardDescription')

Description of the dashboard

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Timestamp when the dashboard was last modified

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User who last modified the dashboard

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

List of keywords for the dashboard

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Timestamp when the dashboard was created

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User who created the dashboard

field widgets: Optional[List[WidgetsInner]] = None (alias 'Widgets')

Dashboard widgets. WidgetServiceCategory is a free-form string of 1-50 characters; the quicksight and insights categories get special backend handling and are matched case-insensitively, while any other category is stored as-is. RefId length 1-50, Version length 1-20. WidgetId is assigned server-side when omitted.

field access_type: Optional[ResourceAccessType] = None (alias 'AccessType')

field custom_url_path: Optional[StrictStr] = None (alias 'CustomUrlPath')

Human-readable path {CurrentSlug}-{CustomId} (for example SalesOverview-3c4d5e6f). Null when CustomId/CurrentSlug are missing.

field current_slug: Optional[StrictStr] = None (alias 'CurrentSlug')

Current custom URL slug segment used to build CustomUrlPath.

field custom_id: Optional[StrictStr] = None (alias 'CustomId')

Short custom identifier segment used to build CustomUrlPath.

field insight_metrics: Optional[List[Any]] = None (alias 'InsightMetrics')

Legacy insights metrics payload when present.

field resources: Optional[List[DashboardDetailsResponseBodyResourcesInner]] = None (alias 'Resources')

Insights resource details when returned as part of dashboard metadata. Prefer DashboardInsightsDetailsResponse when using option=insights_details.

field message: Optional[StrictStr] = None (alias 'Message')

Optional status message accompanying the payload.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of DashboardDetailsResponseBody from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of DashboardDetailsResponseBody from a dict

Return type:

Optional[Self]