SystemConfiguration

pydantic model openapi_client.models.system_configuration.SystemConfiguration

GET /system-configs body. No properties are required; keys depend on config and projectionExpression.

Fields:

• application_tags (openapi_client.models.system_configuration_application_tags.SystemConfigurationApplicationTags | None)

• aws_account_id (str | None)

• aws_region (str | None)

• catalog_search_configuration (openapi_client.models.system_configuration_catalog_search_configuration.SystemConfigurationCatalogSearchConfiguration | None)

• dataset_listing_source (str | None)

• datasource_config (openapi_client.models.system_configuration_datasource_config.SystemConfigurationDatasourceConfig | None)

• domains (openapi_client.models.system_configuration_domains.SystemConfigurationDomains | None)

• enabled_verticals (List[str] | None)

• environment (str | None)

• hcls_config (openapi_client.models.system_configuration_hcls_config.SystemConfigurationHCLSConfig | None)

• ipv4_enabled (str | None)

• ipv6_enabled (str | None)

• log_level (str | None)

• logs_retention_period (str | None)

• notebook_instance_types (List[str] | None)

• previous_object_versions (openapi_client.models.previous_object_versions.PreviousObjectVersions | None)

• project_name (str | None)

• project_shortname (str | None)

• proxy_domains (openapi_client.models.system_configuration_proxy_domains.SystemConfigurationProxyDomains | None)

• rag_configuration (openapi_client.models.system_configuration_rag_configuration.SystemConfigurationRAGConfiguration | None)

• redshift_cluster_type (str | None)

• sqlai_auto_run_configuration (str | None)

• studio_instance_types (List[str] | None)

• system_keywords (List[str] | None)

• version (str | None)

• web_search_configuration (openapi_client.models.system_configuration_web_search_configuration.SystemConfigurationWebSearchConfiguration | None)

• whitelisted_ips (openapi_client.models.system_configuration_whitelisted_ips.SystemConfigurationWhitelistedIPs | None)

field version: Optional[StrictStr] = None (alias 'Version')

Product version. Present with no query, config=all, or matching projection.

field environment: Optional[StrictStr] = None (alias 'Environment')

Deployment environment name.

field project_name: Optional[StrictStr] = None (alias 'ProjectName')

Full project name.

field project_shortname: Optional[StrictStr] = None (alias 'ProjectShortname')

Project short name.

field aws_region: Optional[StrictStr] = None (alias 'AWSRegion')

AWS region of the deployment.

field aws_account_id: Optional[StrictStr] = None (alias 'AWSAccountId')

AWS account ID.

field domains: Optional[SystemConfigurationDomains] = None (alias 'Domains')

field logs_retention_period: Optional[StrictStr] = None (alias 'LogsRetentionPeriod')

SSM logs retention period (days as stored).

field ipv4_enabled: Optional[StrictStr] = None (alias 'IPV4Enabled')

Whitelist IPv4 feature flag from SSM (yes/no).

field ipv6_enabled: Optional[StrictStr] = None (alias 'IPV6Enabled')

IPv6 whitelist feature flag from SSM (yes/no).

field sqlai_auto_run_configuration: Optional[StrictStr] = None (alias 'SQLAIAutoRunConfiguration')

SQL AI autorun SSM value.

field dataset_listing_source: Optional[StrictStr] = None (alias 'DatasetListingSource')

Defaults to dynamodb when the SSM parameter is missing.

field whitelisted_ips: Optional[SystemConfigurationWhitelistedIPs] = None (alias 'WhitelistedIPs')

field previous_object_versions: Optional[PreviousObjectVersions] = None (alias 'PreviousObjectVersions')

field notebook_instance_types: Optional[List[StrictStr]] = None (alias 'NotebookInstanceTypes')

JSON list from SSM; empty list if the parameter is empty.

field studio_instance_types: Optional[List[StrictStr]] = None (alias 'StudioInstanceTypes')

JSON list from SSM for studio instance types.

field application_tags: Optional[SystemConfigurationApplicationTags] = None (alias 'ApplicationTags')

field catalog_search_configuration: Optional[SystemConfigurationCatalogSearchConfiguration] = None (alias 'CatalogSearchConfiguration')

field web_search_configuration: Optional[SystemConfigurationWebSearchConfiguration] = None (alias 'WebSearchConfiguration')

field redshift_cluster_type: Optional[StrictStr] = None (alias 'RedshiftClusterType')

Redshift cluster type SSM value. Missing from the previous spec.

field hcls_config: Optional[SystemConfigurationHCLSConfig] = None (alias 'HCLSConfig')

field enabled_verticals: Optional[List[StrictStr]] = None (alias 'EnabledVerticals')

Comma-split SSM list, or [] when the parameter does not exist.

field proxy_domains: Optional[SystemConfigurationProxyDomains] = None (alias 'ProxyDomains')

field log_level: Optional[StrictStr] = None (alias 'LogLevel')

field rag_configuration: Optional[SystemConfigurationRAGConfiguration] = None (alias 'RAGConfiguration')

field datasource_config: Optional[SystemConfigurationDatasourceConfig] = None (alias 'DatasourceConfig')

field system_keywords: Optional[List[StrictStr]] = None (alias 'SystemKeywords')

SSM StringList split on commas. A stored single element “[]” becomes []. Missing parameter returns [].

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

Return type:

Optional[Self]