UpdateDashboardRequest

pydantic model openapi_client.models.update_dashboard_request.UpdateDashboardRequest

UpdateDashboardRequest

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

Updated dashboard name (1-128 characters when provided).

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

Updated description. When omitted, the model default is an empty string and may overwrite an existing description.

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

Updated search keywords. Defaults to an empty list when omitted.

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

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 UpdateDashboardRequest 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 UpdateDashboardRequest from a dict

Return type:

Optional[Self]