WidgetsInner

pydantic model openapi_client.models.widgets_inner.WidgetsInner

WidgetsInner

Fields:
field widget_id: Optional[StrictStr] = None (alias 'WidgetId')

Widget identifier. Free-form string; defaults to a server-generated UUID when omitted.

field ref_id: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = None (alias 'RefId')

Client-defined widget reference ID (1-50 characters).

field version: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=20)]] = None (alias 'Version')

Widget version string (1-20 characters).

field widget_service_category: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = None (alias 'WidgetServiceCategory')

Widget backend category (1-50 characters). The quicksight and insights categories are matched case-insensitively and get widget-specific backend handling; any other category is accepted and stored as-is.

field configuration: Optional[Dict[str, Any]] = None (alias 'Configuration')

Widget-specific configuration object (UI-shaped). QuickSight widgets must provide QuicksightDashboardId.Value (string UUID). Insights widgets provide ResourcesList.Value as a non-empty array of objects with ResourceId and ResourceType.

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

Return type:

Optional[Self]