2026/01/20 - odb - 2 updated api methods
Changes Adds support for associating and disassociating IAM roles with Autonomous VM cluster resources through the AssociateIamRoleToResource and DisassociateIamRoleFromResource APIs. The GetCloudAutonomousVmCluster and ListCloudAutonomousVmClusters API responses now include the iamRoles field.
{'cloudAutonomousVmCluster': {'iamRoles': [{'awsIntegration': 'KmsTde',
'iamRoleArn': 'string',
'status': 'ASSOCIATING | '
'DISASSOCIATING | FAILED '
'| CONNECTED | '
'DISCONNECTED | '
'PARTIALLY_CONNECTED | '
'UNKNOWN',
'statusReason': 'string'}]}}
Gets information about a specific Autonomous VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_cloud_autonomous_vm_cluster(
cloudAutonomousVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the Autonomous VM cluster to retrieve information about.
dict
Response Syntax
{
'cloudAutonomousVmCluster': {
'cloudAutonomousVmClusterId': 'string',
'cloudAutonomousVmClusterArn': 'string',
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'ociResourceAnchorName': 'string',
'percentProgress': ...,
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'autonomousDataStoragePercentage': ...,
'autonomousDataStorageSizeInTBs': 123.0,
'availableAutonomousDataStorageSizeInTBs': 123.0,
'availableContainerDatabases': 123,
'availableCpus': ...,
'computeModel': 'ECPU'|'OCPU',
'cpuCoreCount': 123,
'cpuCoreCountPerNode': 123,
'cpuPercentage': ...,
'dataStorageSizeInGBs': 123.0,
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'description': 'string',
'domain': 'string',
'exadataStorageInTBsLowestScaledValue': 123.0,
'hostname': 'string',
'ocid': 'string',
'ociUrl': 'string',
'isMtlsEnabledVmCluster': True|False,
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'maintenanceWindow': {
'customActionTimeoutInMins': 123,
'daysOfWeek': [
{
'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
},
],
'hoursOfDay': [
123,
],
'isCustomActionTimeoutEnabled': True|False,
'leadTimeInWeeks': 123,
'months': [
{
'name': 'JANUARY'|'FEBRUARY'|'MARCH'|'APRIL'|'MAY'|'JUNE'|'JULY'|'AUGUST'|'SEPTEMBER'|'OCTOBER'|'NOVEMBER'|'DECEMBER'
},
],
'patchingMode': 'ROLLING'|'NONROLLING',
'preference': 'NO_PREFERENCE'|'CUSTOM_PREFERENCE',
'skipRu': True|False,
'weeksOfMonth': [
123,
]
},
'maxAcdsLowestScaledValue': 123,
'memoryPerOracleComputeUnitInGBs': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'nonProvisionableAutonomousContainerDatabases': 123,
'provisionableAutonomousContainerDatabases': 123,
'provisionedAutonomousContainerDatabases': 123,
'provisionedCpus': ...,
'reclaimableCpus': ...,
'reservedCpus': ...,
'scanListenerPortNonTls': 123,
'scanListenerPortTls': 123,
'shape': 'string',
'createdAt': datetime(2015, 1, 1),
'timeDatabaseSslCertificateExpires': datetime(2015, 1, 1),
'timeOrdsCertificateExpires': datetime(2015, 1, 1),
'timeZone': 'string',
'totalContainerDatabases': 123,
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
}
}
Response Structure
(dict) --
cloudAutonomousVmCluster (dict) --
The details of the requested Autonomous VM cluster.
cloudAutonomousVmClusterId (string) --
The unique identifier of the Autonomous VM cluster.
cloudAutonomousVmClusterArn (string) --
The Amazon Resource Name (ARN) for the Autonomous VM cluster.
odbNetworkId (string) --
The unique identifier of the ODB network associated with this Autonomous VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this Autonomous VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor associated with this Autonomous VM cluster.
percentProgress (float) --
The progress of the current operation on the Autonomous VM cluster, as a percentage.
displayName (string) --
The display name of the Autonomous VM cluster.
status (string) --
The current state of the Autonomous VM cluster. Possible values include CREATING, AVAILABLE, UPDATING, DELETING, DELETED, FAILED.
statusReason (string) --
Additional information about the current status of the Autonomous VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
autonomousDataStoragePercentage (float) --
The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.
autonomousDataStorageSizeInTBs (float) --
The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
availableAutonomousDataStorageSizeInTBs (float) --
The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB.
availableContainerDatabases (integer) --
The number of Autonomous CDBs that you can create with the currently available storage.
availableCpus (float) --
The number of CPU cores available for allocation to Autonomous Databases.
computeModel (string) --
The compute model of the Autonomous VM cluster: ECPU or OCPU.
cpuCoreCount (integer) --
The total number of CPU cores in the Autonomous VM cluster.
cpuCoreCountPerNode (integer) --
The number of CPU cores enabled per node in the Autonomous VM cluster.
cpuPercentage (float) --
The percentage of total CPU cores currently in use in the Autonomous VM cluster.
dataStorageSizeInGBs (float) --
The total data storage allocated to the Autonomous VM cluster, in GB.
dataStorageSizeInTBs (float) --
The total data storage allocated to the Autonomous VM cluster, in TB.
dbNodeStorageSizeInGBs (integer) --
The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB).
dbServers (list) --
The list of database servers associated with the Autonomous VM cluster.
(string) --
description (string) --
The user-provided description of the Autonomous VM cluster.
domain (string) --
The domain name for the Autonomous VM cluster.
exadataStorageInTBsLowestScaledValue (float) --
The minimum value to which you can scale down the Exadata storage, in TB.
hostname (string) --
The hostname for the Autonomous VM cluster.
ocid (string) --
The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.
ociUrl (string) --
The URL for accessing the OCI console page for this Autonomous VM cluster.
isMtlsEnabledVmCluster (boolean) --
Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
licenseModel (string) --
The Oracle license model that applies to the Autonomous VM cluster.
maintenanceWindow (dict) --
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
customActionTimeoutInMins (integer) --
The custom action timeout in minutes for the maintenance window.
daysOfWeek (list) --
The days of the week when maintenance can be performed.
(dict) --
An enumeration of days of the week used for scheduling maintenance windows.
name (string) --
The name of the day of the week.
hoursOfDay (list) --
The hours of the day when maintenance can be performed.
(integer) --
isCustomActionTimeoutEnabled (boolean) --
Indicates whether custom action timeout is enabled for the maintenance window.
leadTimeInWeeks (integer) --
The lead time in weeks before the maintenance window.
months (list) --
The months when maintenance can be performed.
(dict) --
An enumeration of months used for scheduling maintenance windows.
name (string) --
The name of the month.
patchingMode (string) --
The patching mode for the maintenance window.
preference (string) --
The preference for the maintenance window scheduling.
skipRu (boolean) --
Indicates whether to skip release updates during maintenance.
weeksOfMonth (list) --
The weeks of the month when maintenance can be performed.
(integer) --
maxAcdsLowestScaledValue (integer) --
The minimum value to which you can scale down the maximum number of Autonomous CDBs.
memoryPerOracleComputeUnitInGBs (integer) --
The amount of memory allocated per Oracle Compute Unit, in GB.
memorySizeInGBs (integer) --
The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB).
nodeCount (integer) --
The number of database server nodes in the Autonomous VM cluster.
nonProvisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that can't be provisioned because of resource constraints.
provisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster.
provisionedAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster.
provisionedCpus (float) --
The number of CPU cores currently provisioned in the Autonomous VM cluster.
reclaimableCpus (float) --
The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.
reservedCpus (float) --
The number of CPU cores reserved for system operations and redundancy.
scanListenerPortNonTls (integer) --
The SCAN listener port for non-TLS (TCP) protocol. The default is 1521.
scanListenerPortTls (integer) --
The SCAN listener port for TLS (TCP) protocol. The default is 2484.
shape (string) --
The shape of the Exadata infrastructure for the Autonomous VM cluster.
createdAt (datetime) --
The date and time when the Autonomous VM cluster was created.
timeDatabaseSslCertificateExpires (datetime) --
The expiration date and time of the database SSL certificate.
timeOrdsCertificateExpires (datetime) --
The expiration date and time of the Oracle REST Data Services (ORDS) certificate.
timeZone (string) --
The time zone of the Autonomous VM cluster.
totalContainerDatabases (integer) --
The total number of Autonomous Container Databases that can be created with the allocated local storage.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
status (string) --
The current status of the Amazon Web Services Identity and Access Management (IAM) service role.
statusReason (string) --
Additional information about the current status of the Amazon Web Services Identity and Access Management (IAM) service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.
{'cloudAutonomousVmClusters': {'iamRoles': [{'awsIntegration': 'KmsTde',
'iamRoleArn': 'string',
'status': 'ASSOCIATING | '
'DISASSOCIATING | '
'FAILED | CONNECTED | '
'DISCONNECTED | '
'PARTIALLY_CONNECTED | '
'UNKNOWN',
'statusReason': 'string'}]}}
Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_cloud_autonomous_vm_clusters(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='string'
)
integer
The maximum number of items to return per page.
string
The pagination token to continue listing from.
string
The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed.
dict
Response Syntax
{
'nextToken': 'string',
'cloudAutonomousVmClusters': [
{
'cloudAutonomousVmClusterId': 'string',
'cloudAutonomousVmClusterArn': 'string',
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'ociResourceAnchorName': 'string',
'percentProgress': ...,
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'autonomousDataStoragePercentage': ...,
'autonomousDataStorageSizeInTBs': 123.0,
'availableAutonomousDataStorageSizeInTBs': 123.0,
'availableContainerDatabases': 123,
'availableCpus': ...,
'computeModel': 'ECPU'|'OCPU',
'cpuCoreCount': 123,
'cpuCoreCountPerNode': 123,
'cpuPercentage': ...,
'dataStorageSizeInGBs': 123.0,
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'description': 'string',
'domain': 'string',
'exadataStorageInTBsLowestScaledValue': 123.0,
'hostname': 'string',
'ocid': 'string',
'ociUrl': 'string',
'isMtlsEnabledVmCluster': True|False,
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'maintenanceWindow': {
'customActionTimeoutInMins': 123,
'daysOfWeek': [
{
'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
},
],
'hoursOfDay': [
123,
],
'isCustomActionTimeoutEnabled': True|False,
'leadTimeInWeeks': 123,
'months': [
{
'name': 'JANUARY'|'FEBRUARY'|'MARCH'|'APRIL'|'MAY'|'JUNE'|'JULY'|'AUGUST'|'SEPTEMBER'|'OCTOBER'|'NOVEMBER'|'DECEMBER'
},
],
'patchingMode': 'ROLLING'|'NONROLLING',
'preference': 'NO_PREFERENCE'|'CUSTOM_PREFERENCE',
'skipRu': True|False,
'weeksOfMonth': [
123,
]
},
'maxAcdsLowestScaledValue': 123,
'memoryPerOracleComputeUnitInGBs': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'nonProvisionableAutonomousContainerDatabases': 123,
'provisionableAutonomousContainerDatabases': 123,
'provisionedAutonomousContainerDatabases': 123,
'provisionedCpus': ...,
'reclaimableCpus': ...,
'reservedCpus': ...,
'scanListenerPortNonTls': 123,
'scanListenerPortTls': 123,
'shape': 'string',
'createdAt': datetime(2015, 1, 1),
'timeDatabaseSslCertificateExpires': datetime(2015, 1, 1),
'timeOrdsCertificateExpires': datetime(2015, 1, 1),
'timeZone': 'string',
'totalContainerDatabases': 123,
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token to continue listing from.
cloudAutonomousVmClusters (list) --
The list of Autonomous VM clusters in the specified Cloud Exadata Infrastructure.
(dict) --
A summary of an Autonomous VM cluster.
cloudAutonomousVmClusterId (string) --
The unique identifier of the Autonomous VM cluster.
cloudAutonomousVmClusterArn (string) --
The Amazon Resource Name (ARN) for the Autonomous VM cluster.
odbNetworkId (string) --
The unique identifier of the ODB network associated with this Autonomous VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this Autonomous VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor associated with this Autonomous VM cluster.
percentProgress (float) --
The progress of the current operation on the Autonomous VM cluster, as a percentage.
displayName (string) --
The user-friendly name for the Autonomous VM cluster.
status (string) --
The current status of the Autonomous VM cluster.
statusReason (string) --
Additional information about the current status of the Autonomous VM cluster, if applicable.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure containing this Autonomous VM cluster.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure containing this Autonomous VM cluster.
autonomousDataStoragePercentage (float) --
The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.
autonomousDataStorageSizeInTBs (float) --
The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
availableAutonomousDataStorageSizeInTBs (float) --
The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB.
availableContainerDatabases (integer) --
The number of Autonomous Container Databases that you can create with the currently available storage.
availableCpus (float) --
The number of CPU cores available for allocation to Autonomous Databases.
computeModel (string) --
The compute model of the Autonomous VM cluster: ECPU or OCPU.
cpuCoreCount (integer) --
The total number of CPU cores in the Autonomous VM cluster.
cpuCoreCountPerNode (integer) --
The number of CPU cores per node in the Autonomous VM cluster.
cpuPercentage (float) --
The percentage of total CPU cores currently in use in the Autonomous VM cluster.
dataStorageSizeInGBs (float) --
The total data storage allocated to the Autonomous VM cluster, in GB.
dataStorageSizeInTBs (float) --
The total data storage allocated to the Autonomous VM cluster, in TB.
dbNodeStorageSizeInGBs (integer) --
The local node storage allocated to the Autonomous VM cluster, in GB.
dbServers (list) --
The list of database servers associated with the Autonomous VM cluster.
(string) --
description (string) --
The user-provided description of the Autonomous VM cluster.
domain (string) --
The domain name for the Autonomous VM cluster.
exadataStorageInTBsLowestScaledValue (float) --
The lowest value to which Exadata storage can be scaled down, in TB.
hostname (string) --
The host name for the Autonomous VM cluster.
ocid (string) --
The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.
ociUrl (string) --
The URL for accessing the OCI console page for this Autonomous VM cluster.
isMtlsEnabledVmCluster (boolean) --
Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
licenseModel (string) --
The Oracle license model that applies to the Autonomous VM cluster.
maintenanceWindow (dict) --
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
customActionTimeoutInMins (integer) --
The custom action timeout in minutes for the maintenance window.
daysOfWeek (list) --
The days of the week when maintenance can be performed.
(dict) --
An enumeration of days of the week used for scheduling maintenance windows.
name (string) --
The name of the day of the week.
hoursOfDay (list) --
The hours of the day when maintenance can be performed.
(integer) --
isCustomActionTimeoutEnabled (boolean) --
Indicates whether custom action timeout is enabled for the maintenance window.
leadTimeInWeeks (integer) --
The lead time in weeks before the maintenance window.
months (list) --
The months when maintenance can be performed.
(dict) --
An enumeration of months used for scheduling maintenance windows.
name (string) --
The name of the month.
patchingMode (string) --
The patching mode for the maintenance window.
preference (string) --
The preference for the maintenance window scheduling.
skipRu (boolean) --
Indicates whether to skip release updates during maintenance.
weeksOfMonth (list) --
The weeks of the month when maintenance can be performed.
(integer) --
maxAcdsLowestScaledValue (integer) --
The lowest value to which you can scale down the maximum number of Autonomous CDBs.
memoryPerOracleComputeUnitInGBs (integer) --
The amount of memory allocated per Oracle Compute Unit (OCU), in GB.
memorySizeInGBs (integer) --
The total amount of memory allocated to the Autonomous VM cluster, in GB.
nodeCount (integer) --
The number of database server nodes in the Autonomous VM cluster.
nonProvisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that can't be provisioned because of resource constraints.
provisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that you can provision in the Autonomous VM cluster.
provisionedAutonomousContainerDatabases (integer) --
The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster.
provisionedCpus (float) --
The number of CPUs currently provisioned in the Autonomous VM cluster.
reclaimableCpus (float) --
The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases.
reservedCpus (float) --
The number of CPUs reserved for system operations and redundancy.
scanListenerPortNonTls (integer) --
The SCAN listener port for non-TLS (TCP) protocol.
scanListenerPortTls (integer) --
The SCAN listener port for TLS (TCP) protocol.
shape (string) --
The shape of the Exadata infrastructure for the Autonomous VM cluster.
createdAt (datetime) --
The date and time when the Autonomous VM cluster was created.
timeDatabaseSslCertificateExpires (datetime) --
The expiration date and time of the database SSL certificate.
timeOrdsCertificateExpires (datetime) --
The expiration date and time of the Oracle REST Data Services (ORDS) certificate.
timeZone (string) --
The time zone of the Autonomous VM cluster.
totalContainerDatabases (integer) --
The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster in the summary information.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
status (string) --
The current status of the Amazon Web Services Identity and Access Management (IAM) service role.
statusReason (string) --
Additional information about the current status of the Amazon Web Services Identity and Access Management (IAM) service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.