VerticalByIdResponseBody

pydantic model openapi_client.models.vertical_by_id_response_body.VerticalByIdResponseBody

GET /verticals/{id} payload. Vertical table item plus AccessType and UsersAttached.

Fields:
field vertical_id: Optional[StrictStr] = None (alias 'VerticalId')

Unique identifier of the vertical.

field vertical_name: Optional[StrictStr] = None (alias 'VerticalName')

Display name of the vertical.

field vertical_type: Optional[StrictStr] = None (alias 'VerticalType')

App key stored on the vertical. BI is “bi”.

field description: Optional[StrictStr] = None (alias 'Description')

Optional description.

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

Last modification timestamp.

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

User who last modified the vertical.

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

User who created the vertical.

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

Creation timestamp.

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

Caller’s ACL on this vertical.

field is_q_enabled: Optional[StrictStr] = None (alias 'IsQEnabled')

Present when set. “yes” allows QuickSight Pro roles on user grant/upgrade.

field users_attached: Optional[List[VerticalAttachedUser]] = None (alias 'UsersAttached')

Users whose AllowedApps contain VerticalType.lower(). QuickSightRole is set only when VerticalType is bi.

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

Return type:

Optional[Self]