get_cluster_details

ClusterDetailsApi.get_cluster_details(role_id, clustertype, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Retrieve DWH, OpenSearch, or RAG cluster details

Returns the configured Amorphic cluster details for the given clustertype. - dwh: Redshift provisioned or serverless details. - os: Amorphic OpenSearch domain details. - rag: RAG vector-store details (Aurora RDS or OpenSearch Serverless).

Parameters:

• role_id (str) – Amorphic role ID the request is authorized against. (required)

• clustertype (str) – Cluster type to retrieve. - dwh: Redshift DWH (provisioned or serverless) - os: OpenSearch domain - rag: RAG vector store (AI services) (required)

• projection_expression (str) – Comma-separated list of attributes to project from the DWH response. Applied only when clustertype=dwh. Ignored for os and rag. The handler validates keys against this allow-list: - Schedules - Metrics - ClusterType - ClusterIdentifier

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetClusterDetailsResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /clusters/{clustertype}

Parameter examples

Name	In	Example
role_id	header	"role-admin"
clustertype	path	"dwh"
projectionExpression	query	"Schedules,ClusterIdentifier"

Success (HTTP 200)

Cluster details retrieved successfully. Full responses include `ClusterDetails` and `AdvancedDetails`.

Provisioned Redshift DWH (clustertype=dwh)

{
  "ClusterDetails": {
    "Type": "RedShift Cluster",
    "NodeType": "ra3.large",
    "NumberOfNodes": 1,
    "Status": "available",
    "Address": "my-cluster.abc123.us-east-1.redshift.amazonaws.com",
    "Port": 5439,
    "Capacity": "1000000 MB",
    "CreationDate": "2025-12-17T04:39:48.301000+00:00"
  },
  "AdvancedDetails": {
    "ClusterVersion": "1.0",
    "ClusterIdentifier": "my-cluster",
    "StorageEncrypted": false,
    "AutomatedSnapshotRetentionPeriod": 14,
    "VpcSecurityGroups": [
      {
        "VpcSecurityGroupId": "sg-0abc123"
      }
    ],
    "ClusterParameterGroups": [
      {
        "ParameterGroupName": "my-cluster-param-group",
        "ParameterApplyStatus": "in-sync"
      }
    ],
    "ClusterSubnetGroupName": "my-cluster-subnet-group",
    "VpcId": "vpc-0abc123",
    "AvailabilityZone": "us-east-1a",
    "PreferredMaintenanceWindow": "mon:09:00-mon:09:30",
    "PendingModifiedValues": {},
    "AllowVersionUpgrade": false,
    "PubliclyAccessible": false,
    "RestoreStatus": {
      "Status": "completed",
      "CurrentRestoreRateInMegaBytesPerSecond": 0,
      "SnapshotSizeInMegaBytes": 0,
      "ProgressInMegaBytes": 0,
      "ElapsedTimeInSeconds": 0,
      "EstimatedTimeToCompletionInSeconds": 0
    },
    "ClusterNodes": [
      {
        "NodeRole": "SHARED",
        "PrivateIPAddress": "10.50.129.117",
        "PublicIPAddress": "100.60.236.32"
      }
    ],
    "ClusterRevisionNumber": "384821",
    "EnhancedVpcRouting": false,
    "IamRoles": [
      {
        "IamRoleArn": "arn:aws:iam::123456789012:role/adp-Redshift-CopyExecutionRole",
        "ApplyStatus": "in-sync"
      }
    ],
    "MaintenanceTrackName": "current",
    "NextMaintenanceWindowStartTime": "2026-08-17T09:00:00+00:00",
    "AvailabilityZoneRelocationStatus": "enabled",
    "MultiAZ": "Disabled",
    "Schedules": [
      {
        "ScheduledActionName": "daily-schedule-pause",
        "TargetAction": {
          "PauseCluster": {
            "ClusterIdentifier": "my-cluster"
          }
        },
        "Schedule": "cron(0 13 ? * MON-FRI *)",
        "IamRole": "arn:aws:iam::123456789012:role/adp-Redshift-SchedulerActionsRole",
        "State": "ACTIVE",
        "NextInvocations": [
          "2026-08-13T13:00:00+00:00",
          "2026-08-14T13:00:00+00:00"
        ],
        "StartTime": "2026-04-29T18:30:00+00:00",
        "EndTime": "2026-12-31T18:00:00+00:00"
      },
      {
        "ScheduledActionName": "daily-schedule-resume",
        "TargetAction": {
          "ResumeCluster": {
            "ClusterIdentifier": "my-cluster"
          }
        },
        "Schedule": "cron(0 3 ? * MON-FRI *)",
        "IamRole": "arn:aws:iam::123456789012:role/adp-Redshift-SchedulerActionsRole",
        "State": "ACTIVE",
        "NextInvocations": [
          "2026-08-14T03:00:00+00:00",
          "2026-08-17T03:00:00+00:00"
        ],
        "StartTime": "2026-06-23T18:30:00+00:00",
        "EndTime": "2026-12-31T15:00:00+00:00"
      }
    ]
  }
}

Redshift Serverless DWH (clustertype=dwh)

{
  "ClusterDetails": {
    "Type": "Redshift Serverless",
    "Status": "available",
    "Address": "my-workgroup.123456789012.us-west-2.redshift-serverless.amazonaws.com",
    "Port": 5439,
    "Capacity": 0,
    "CreationDate": "2025-07-31T11:02:05.060000+00:00"
  },
  "AdvancedDetails": {
    "Namespace": {
      "CreationDate": "2025-07-31T11:02:05.060000+00:00",
      "IamRoles": [
        {
          "ApplyStatus": "in-sync",
          "IamRoleArn": "arn:aws:iam::123456789012:role/adp-Redshift-CopyExecutionRole"
        }
      ],
      "NamespaceId": "03265e04-e3e0-4ca6-8239-57f20103cdf8",
      "NamespaceName": "my-serverless-redshift-namespace",
      "Status": "available"
    },
    "Workgroup": {
      "EnhancedVpcRouting": true,
      "PubliclyAccessible": false,
      "Status": "available",
      "VpcId": "vpc-0abc123",
      "SubnetIds": [
        "subnet-0abc111",
        "subnet-0abc222",
        "subnet-0abc333"
      ],
      "SecurityGroupIds": [
        "sg-0abc123"
      ],
      "WorkgroupId": "c48045ea-8424-4897-9c7c-d25b07488463",
      "WorkgroupName": "my-default-wg",
      "WorkgroupVersion": "N/A",
      "PatchVersion": "N/A",
      "JDBCURL": "my-workgroup.123456789012.us-west-2.redshift-serverless.amazonaws.com",
      "Storage": 0
    },
    "Snapshots": [],
    "LatestRecoveryPoint": {
      "NamespaceArn": "arn:aws:redshift-serverless:us-west-2:123456789012:namespace/03265e04-e3e0-4ca6-8239-57f20103cdf8",
      "NamespaceName": "my-serverless-redshift-namespace",
      "RecoveryPointCreateTime": "2026-08-13T09:27:38.216000+00:00",
      "RecoveryPointId": "97ef1137-5a0d-4a76-8bee-4fc27811c415",
      "TotalSizeInMegaBytes": 67886
    },
    "Schedules": []
  }
}

RAG vector store backed by Aurora (clustertype=rag)

{
  "ClusterDetails": {
    "ClusterType": "RAG - Aurora (RDS)",
    "ClusterIdentifier": "my-rag-aurora-cluster",
    "Status": "available",
    "Engine": "aurora-postgresql",
    "EngineVersion": "15.4",
    "EngineMode": "provisioned",
    "Port": 5432,
    "TableCount": {
      "TotalTableCount": 42,
      "TenantCount": 3,
      "KnowledgeBaseTableCount": 12
    }
  },
  "AdvancedDetails": {
    "ScalingConfiguration": {
      "MinCapacity": 0.5,
      "MaxCapacity": 8
    },
    "VpcSecurityGroups": [
      {
        "VpcSecurityGroupId": "sg-0abc123",
        "Status": "active"
      }
    ],
    "LatestRestorableTime": "13 Aug, 2026 09:27 AM"
  }
}

RAG vector store backed by OpenSearch Serverless (clustertype=rag)

{
  "ClusterDetails": {
    "ClusterType": "RAG - OpenSearch Serverless",
    "CollectionId": "abc123def456",
    "Name": "amorphic-rag-collection",
    "Status": "ACTIVE",
    "CollectionType": "VECTORSEARCH",
    "CollectionEndpoint": "https://abc123def456.us-east-1.aoss.amazonaws.com"
  },
  "AdvancedDetails": {
    "Description": "RAG vector store for AI services",
    "StandbyReplicas": "DISABLED"
  }
}

RAG Aurora where the table count could not be collected

{
  "ClusterDetails": {
    "ClusterType": "RAG - Aurora (RDS)",
    "ClusterIdentifier": "my-rag-aurora-cluster",
    "Status": "available",
    "Engine": "aurora-postgresql",
    "EngineVersion": "15.4",
    "EngineMode": "provisioned",
    "Port": 5432,
    "TableCount": {}
  },
  "AdvancedDetails": {
    "ScalingConfiguration": {},
    "VpcSecurityGroups": [],
    "LatestRestorableTime": "N/A"
  }
}

Errors

Documented error codes: IPV-1004, IPV-1006, AI-1004, EMF-1001, RTE-1001.

HTTP 400

Input validation, authorization, or unsupported request.

invalidClusterType

{
  "Message": "IPV-1004 - Invalid clustertype. Supported types are ['dwh', 'os', 'rag']."
}

invalidProjection

{
  "Message": "IPV-1006 - Invalid input projection keys - {'Foo'}, valid keys are - {'Schedules', 'Metrics', 'ClusterType', 'ClusterIdentifier'}"
}

aiDisabled

{
  "Message": "AI-1004 - Rag Management is available only for the AI services enabled environment. Please contact the administrator to enable it."
}

HTTP 500

Backend/generic failure.

Request / response example

{
  "Message": "EMF-1001 - RTE-1001 - <exception details>"
}