UpdateSystemConfiguration

pydantic model openapi_client.models.update_system_configuration.UpdateSystemConfiguration

PUT /system-configs body. Keys depend on config. No schema-level required. Web search uses top-level Status, Engine, and WebSearchAPIkey. Proxy updates use ProxyDomainName.

Fields:

• catalog_search_type (str | None)

• dataset_listing_source (str | None)

• disabled_datasources (Dict[str, Any] | None)

• domains (List[str] | None)

• engine (str | None)

• ipv4_addresses (List[str] | None)

• ipv6_addresses (List[str] | None)

• log_level (str | None)

• logs_retention_period (str | None)

• notebook_instance_types (List[str] | None)

• previous_object_versions_retention_period (str | None)

• proxy_domain_name (List[str] | None)

• retain_forever (str | None)

• sqlai_auto_run_configuration (str | None)

• status (str | None)

• system_keywords (List[str] | None)

• tags (Dict[str, str] | None)

• web_search_ap_ikey (str | None)

field ipv4_addresses: Optional[List[StrictStr]] = None (alias 'IPV4Addresses')

whitelist-ips. At least one of IPV4Addresses or IPV6Addresses required (IPV-1008).

field ipv6_addresses: Optional[List[StrictStr]] = None (alias 'IPV6Addresses')

whitelist-ips. IPV-1002 if IPv6 is not enabled in the environment.

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

user-domains. Required non-empty; joined CSV must be 1-4000 chars (IPV-1015).

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

logs-retention-period. Must be in the allowed SSM list (IPV-1071).

field previous_object_versions_retention_period: Optional[StrictStr] = None (alias 'PreviousObjectVersionsRetentionPeriod')

Required when RetainForever is no. Digit string 1-3650 (IPV-1012).

field retain_forever: Optional[StrictStr] = None (alias 'RetainForever')

previous-object-versions-retention-period. Required (IPV-1008).

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

Lowercased and checked against AWS notebook types (IPV-1041). JSON length max 8100 (GE-1034).

field proxy_domain_name: Optional[List[StrictStr]] = None (alias 'ProxyDomainName')

proxy-domain. Required list. Must include .aws.amazon.com, .amazonaws.com, and .amazoncognito.com. Lowercase letters, digits, dots, hyphens.

field tags: Optional[Dict[str, StrictStr]] = None (alias 'Tags')

application-tags. Required non-empty dict. Keys/values strings without = or comma.

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

log-level. Uppercased then checked. Invalid becomes GE-1034.

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

sqlai-autorun-configuration. Other values GE-1034.

field catalog_search_type: Optional[StrictStr] = None (alias 'CatalogSearchType')

catalog-search-configuration. semantic needs AI and Catalog service.

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

Compared lowercase (IPV-1041).

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

Max 30 keywords, each max 25 characters (IPV-1004).

field disabled_datasources: Optional[Dict[str, Any]] = None (alias 'DisabledDatasources')

datasources-configuration. Keys jdbc and/or arcgis. jdbc values [advanceddataload]; arcgis values [arcgis]. {} enables both. Omitted treated as {}.

field status: Optional[StrictStr] = None (alias 'Status')

web-search-configuration. Optional; omitted keeps current.

field engine: Optional[StrictStr] = None (alias 'Engine')

web-search-configuration. Engine change requires Status Enabled.

field web_search_ap_ikey: Optional[StrictStr] = None (alias 'WebSearchAPIkey')

Required when Engine is not agent-core-browser. Rejected for agent-core-browser.

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

Return type:

Optional[Self]