GetClusterDetailsResponseClusterDetails

pydantic model openapi_client.models.get_cluster_details_response_cluster_details.GetClusterDetailsResponseClusterDetails

High-level cluster summary fields for the requested clustertype

Fields:

• address (str | None)

• capacity (openapi_client.models.get_cluster_details_response_cluster_details_capacity.GetClusterDetailsResponseClusterDetailsCapacity | None)

• cluster_config (openapi_client.models.get_cluster_details_response_cluster_details_cluster_config.GetClusterDetailsResponseClusterDetailsClusterConfig | None)

• cluster_identifier (str | None)

• cluster_type (str | None)

• collection_endpoint (str | None)

• collection_id (str | None)

• collection_type (str | None)

• creation_date (str | None)

• endpoints (str | None)

• engine (str | None)

• engine_mode (str | None)

• engine_version (str | None)

• health (str | None)

• name (str | None)

• node_type (str | None)

• number_of_nodes (int | None)

• port (openapi_client.models.get_cluster_details_response_cluster_details_port.GetClusterDetailsResponseClusterDetailsPort | None)

• state (str | None)

• status (str | None)

• table_count (openapi_client.models.get_cluster_details_response_cluster_details_table_count.GetClusterDetailsResponseClusterDetailsTableCount | None)

• type (str | None)

• version (str | None)

field name: Optional[StrictStr] = None (alias 'Name')

Cluster or domain name (OpenSearch / RAG)

field type: Optional[StrictStr] = None (alias 'Type')

Cluster type label for DWH responses. Provisioned returns RedShift Cluster; serverless returns Redshift Serverless.

field cluster_type: Optional[StrictStr] = None (alias 'ClusterType')

RAG cluster type label. This endpoint emits exactly “RAG - Aurora (RDS)” or “RAG - OpenSearch Serverless”. Deliberately not constrained to an enum: note that GET /clusters/rag/metrics labels the same Aurora cluster differently again, so do not rely on this value matching across endpoints.

field cluster_identifier: Optional[StrictStr] = None (alias 'ClusterIdentifier')

Redshift or RAG cluster identifier

field collection_id: Optional[StrictStr] = None (alias 'CollectionId')

OpenSearch Serverless collection id (RAG)

field collection_type: Optional[StrictStr] = None (alias 'CollectionType')

OpenSearch Serverless collection type (RAG)

field collection_endpoint: Optional[StrictStr] = None (alias 'CollectionEndpoint')

OpenSearch Serverless collection endpoint (RAG)

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

Current cluster/domain status

field address: Optional[StrictStr] = None (alias 'Address')

Cluster endpoint address

field port: Optional[GetClusterDetailsResponseClusterDetailsPort] = None (alias 'Port')

field number_of_nodes: Optional[StrictInt] = None (alias 'NumberOfNodes')

Number of nodes in a provisioned Redshift cluster

field capacity: Optional[GetClusterDetailsResponseClusterDetailsCapacity] = None (alias 'Capacity')

field node_type: Optional[StrictStr] = None (alias 'NodeType')

Redshift node type

field creation_date: Optional[StrictStr] = None (alias 'CreationDate')

Cluster or domain creation timestamp

field state: Optional[StrictStr] = None (alias 'State')

OpenSearch domain config state

field health: Optional[StrictStr] = None (alias 'Health')

OpenSearch cluster health

field endpoints: Optional[StrictStr] = None (alias 'Endpoints')

OpenSearch VPC endpoint

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

Engine/version string

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

RAG Aurora engine name

field engine_version: Optional[StrictStr] = None (alias 'EngineVersion')

RAG Aurora engine version

field engine_mode: Optional[StrictStr] = None (alias 'EngineMode')

RAG Aurora engine mode

field table_count: Optional[GetClusterDetailsResponseClusterDetailsTableCount] = None (alias 'TableCount')

field cluster_config: Optional[GetClusterDetailsResponseClusterDetailsClusterConfig] = None (alias 'ClusterConfig')

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

Return type:

Optional[Self]