CreateDashboardRequest¶

pydantic model openapi_client.models.create_dashboard_request.CreateDashboardRequest¶

CreateDashboardRequest

Fields:

field dashboard_id: Optional[StrictStr] = None (alias 'DashboardId')¶: Optional client-supplied dashboard UUID. When omitted, the server generates a new UUID.

field dashboard_name: Annotated[str, Field(min_length=1, strict=True, max_length=128)] [Required] (alias 'DashboardName')¶

Name of the dashboard. Required. Validated length 1-128 characters.

Constraints:

field dashboard_description: Optional[StrictStr] = '' (alias 'DashboardDescription')¶: Description of the dashboard. Defaults to empty string.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')¶: Search keywords. Defaults to an empty list.

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.

to_str()¶

Returns the string representation of the model using alias

to_json()¶

Returns the JSON representation of the model using alias

classmethod from_json(json_str)¶

Create an instance of CreateDashboardRequest from a JSON string

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.

classmethod from_dict(obj)¶

Create an instance of CreateDashboardRequest from a dict