2026/08/12 - odb - 13 new 6 updated api methods
Changes Adds support for Oracle Exadata on Exascale Infrastructure (ExaDB-XS) resources including storage vaults and VM clusters.
Removes virtual machines from the specified Exascale VM cluster.
See also: AWS API Documentation
Request Syntax
client.disassociate_virtual_machines_from_exadb_vm_cluster(
exadbVmClusterId='string',
dbNodeIds=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the Exascale VM cluster to remove virtual machines from.
list
[REQUIRED]
The list of DB node IDs to remove from the Exascale VM cluster.
(string) --
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exadbVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale VM cluster.
status (string) --
The current status of the Exascale VM cluster.
statusReason (string) --
Additional information about the status of the Exascale VM cluster.
exadbVmClusterId (string) --
The unique identifier of the Exascale VM cluster.
Adds virtual machines to the specified Exascale VM cluster.
See also: AWS API Documentation
Request Syntax
client.associate_virtual_machines_to_exadb_vm_cluster(
exadbVmClusterId='string',
desiredNodeCount=123
)
string
[REQUIRED]
The unique identifier of the Exascale VM cluster to add virtual machines to.
integer
[REQUIRED]
The desired number of nodes in the Exascale VM cluster after the association.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exadbVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale VM cluster.
status (string) --
The current status of the Exascale VM cluster.
statusReason (string) --
Additional information about the status of the Exascale VM cluster.
exadbVmClusterId (string) --
The unique identifier of the Exascale VM cluster.
Deletes the specified Exascale storage vault.
See also: AWS API Documentation
Request Syntax
client.delete_exascale_db_storage_vault(
exascaleDbStorageVaultId='string'
)
string
[REQUIRED]
The unique identifier of the Exascale storage vault to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the specified Exascale storage vault.
See also: AWS API Documentation
Request Syntax
client.update_exascale_db_storage_vault(
exascaleDbStorageVaultId='string',
additionalFlashCacheInPercent=123,
autoscaleLimitInGBs=123,
description='string',
displayName='string',
highCapacityDatabaseStorageTotalSizeInGBs=123,
isAutoscaleEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the Exascale storage vault to update.
integer
The additional flash cache percentage for the Exascale storage vault.
integer
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
string
A new description for the Exascale storage vault.
string
A new user-friendly name for the Exascale storage vault.
integer
The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault.
boolean
Specifies whether autoscaling is enabled for the Exascale storage vault.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exascaleDbStorageVaultId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale storage vault.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
Returns information about the specified Exascale storage vault.
See also: AWS API Documentation
Request Syntax
client.get_exascale_db_storage_vault(
exascaleDbStorageVaultId='string'
)
string
[REQUIRED]
The unique identifier of the Exascale storage vault.
dict
Response Syntax
{
'exascaleDbStorageVault': {
'exascaleDbStorageVaultId': 'string',
'additionalFlashCacheInPercent': 123,
'attachedShapeAttributes': [
'SMART_STORAGE'|'BLOCK_STORAGE',
],
'autoscaleLimitInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'displayName': 'string',
'vmClusterArns': [
'string',
],
'vmClusterCount': 123,
'vmClusterIds': [
'string',
],
'exascaleDbStorageVaultArn': 'string',
'highCapacityDatabaseStorage': {
'availableSizeInGBs': 123,
'totalSizeInGBs': 123
},
'isAutoscaleEnabled': True|False,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'percentProgress': ...,
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'timeZone': 'string'
}
}
Response Structure
(dict) --
exascaleDbStorageVault (dict) --
The Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
additionalFlashCacheInPercent (integer) --
The additional flash cache percentage for the Exascale storage vault.
attachedShapeAttributes (list) --
The list of shape attributes attached to the Exascale storage vault.
(string) --
autoscaleLimitInGBs (integer) --
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
availabilityZone (string) --
The Availability Zone for the Exascale storage vault.
availabilityZoneId (string) --
The Availability Zone ID for the Exascale storage vault.
createdAt (datetime) --
The date and time when the Exascale storage vault was created.
description (string) --
The description of the Exascale storage vault.
displayName (string) --
The user-friendly name for the Exascale storage vault.
vmClusterArns (list) --
The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault.
(string) --
vmClusterCount (integer) --
The number of VM clusters associated with this Exascale storage vault.
vmClusterIds (list) --
The list of unique identifiers of the VM clusters associated with this Exascale storage vault.
(string) --
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault.
highCapacityDatabaseStorage (dict) --
The high-capacity database storage details for the Exascale storage vault.
availableSizeInGBs (integer) --
The available storage size, in gigabytes (GB).
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
isAutoscaleEnabled (boolean) --
Specifies whether autoscaling is enabled for the Exascale storage vault.
ocid (string) --
The OCID of the Exascale storage vault.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exascale storage vault.
ociUrl (string) --
The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI).
percentProgress (float) --
The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
timeZone (string) --
The time zone of the Exascale storage vault.
Returns information about the Exascale storage vaults owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_exascale_db_storage_vaults(
maxResults=123,
nextToken='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'nextToken': 'string',
'exascaleDbStorageVaults': [
{
'exascaleDbStorageVaultId': 'string',
'additionalFlashCacheInPercent': 123,
'attachedShapeAttributes': [
'SMART_STORAGE'|'BLOCK_STORAGE',
],
'autoscaleLimitInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'displayName': 'string',
'vmClusterArns': [
'string',
],
'vmClusterCount': 123,
'vmClusterIds': [
'string',
],
'exascaleDbStorageVaultArn': 'string',
'highCapacityDatabaseStorage': {
'availableSizeInGBs': 123,
'totalSizeInGBs': 123
},
'isAutoscaleEnabled': True|False,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'percentProgress': ...,
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'timeZone': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
exascaleDbStorageVaults (list) --
The list of Exascale storage vaults.
(dict) --
Summary information about an Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
additionalFlashCacheInPercent (integer) --
The additional flash cache percentage for the Exascale storage vault.
attachedShapeAttributes (list) --
The list of shape attributes attached to the Exascale storage vault.
(string) --
autoscaleLimitInGBs (integer) --
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
availabilityZone (string) --
The Availability Zone for the Exascale storage vault.
availabilityZoneId (string) --
The Availability Zone ID for the Exascale storage vault.
createdAt (datetime) --
The date and time when the Exascale storage vault was created.
description (string) --
The description of the Exascale storage vault.
displayName (string) --
The user-friendly name for the Exascale storage vault.
vmClusterArns (list) --
The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault.
(string) --
vmClusterCount (integer) --
The number of VM clusters associated with this Exascale storage vault.
vmClusterIds (list) --
The list of unique identifiers of the VM clusters associated with this Exascale storage vault.
(string) --
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault.
highCapacityDatabaseStorage (dict) --
The high-capacity database storage details for the Exascale storage vault.
availableSizeInGBs (integer) --
The available storage size, in gigabytes (GB).
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
isAutoscaleEnabled (boolean) --
Specifies whether autoscaling is enabled for the Exascale storage vault.
ocid (string) --
The OCID of the Exascale storage vault.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exascale storage vault.
ociUrl (string) --
The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI).
percentProgress (float) --
The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
timeZone (string) --
The time zone of the Exascale storage vault.
Returns information about the Exascale VM clusters owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_exadb_vm_clusters(
exascaleDbStorageVaultId='string',
maxResults=123,
nextToken='string'
)
string
The unique identifier of the Exascale storage vault to list the associated Exascale VM clusters.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'nextToken': 'string',
'exadbVmClusters': [
{
'exadbVmClusterId': 'string',
'clusterName': 'string',
'createdAt': datetime(2015, 1, 1),
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'displayName': 'string',
'domain': 'string',
'enabledEcpuCount': 123,
'exadbVmClusterArn': 'string',
'exascaleDbStorageVaultArn': 'string',
'exascaleDbStorageVaultId': 'string',
'giVersion': 'string',
'gridImageId': 'string',
'gridImageType': 'RELEASE_UPDATE'|'CUSTOM_IMAGE',
'hostname': 'string',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
],
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'odbNetworkArn': 'string',
'odbNetworkId': 'string',
'percentProgress': ...,
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'scanListenerPortTcp': 123,
'scanListenerPortTcpSsl': 123,
'shape': 'string',
'shapeAttribute': 'SMART_STORAGE'|'BLOCK_STORAGE',
'snapshotFileSystemStorage': {
'totalSizeInGBs': 123
},
'sshPublicKeys': [
'string',
],
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'systemVersion': 'string',
'timeZone': 'string',
'totalEcpuCount': 123,
'totalFileSystemStorage': {
'totalSizeInGBs': 123
},
'vipIds': [
'string',
],
'vmFileSystemStorage': {
'totalSizeInGBs': 123
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
exadbVmClusters (list) --
The list of Exascale VM clusters.
(dict) --
Summary information about an Exascale VM cluster.
exadbVmClusterId (string) --
The unique identifier of the Exascale VM cluster.
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
createdAt (datetime) --
The date and time when the Exascale VM cluster was created.
dataCollectionOptions (dict) --
The set of diagnostic collection options enabled for the Exascale VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
displayName (string) --
The user-friendly name for the Exascale VM cluster.
domain (string) --
The domain of the Exascale VM cluster.
enabledEcpuCount (integer) --
The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster.
exadbVmClusterArn (string) --
The Amazon Resource Name (ARN) of the Exascale VM cluster.
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault associated with this Exascale VM cluster.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault associated with this Exascale VM cluster.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster.
gridImageId (string) --
The Grid Infrastructure software image ID for the Exascale VM cluster.
gridImageType (string) --
The type of Grid Infrastructure image for the Exascale VM cluster.
hostname (string) --
The host name for the Exascale VM cluster.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale 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.
iormConfigCache (dict) --
The I/O Resource Management (IORM) configuration cache details for the Exascale VM cluster.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the Exascale VM cluster.
listenerPort (integer) --
The port number configured for the listener on the Exascale VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster.
nodeCount (integer) --
The number of nodes in the Exascale VM cluster.
ocid (string) --
The OCID of the Exascale VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exascale VM cluster.
ociUrl (string) --
The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI).
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this Exascale VM cluster.
odbNetworkId (string) --
The unique identifier of the ODB network for the Exascale VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage.
scanDnsName (string) --
The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the Exascale VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster.
(string) --
scanListenerPortTcp (integer) --
The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster.
scanListenerPortTcpSsl (integer) --
The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster.
shape (string) --
The hardware model name of the Exadata infrastructure that's running the Exascale VM cluster.
shapeAttribute (string) --
The shape attribute for the Exascale VM cluster.
snapshotFileSystemStorage (dict) --
The snapshot file system storage details for the Exascale VM cluster.
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
(string) --
status (string) --
The current status of the Exascale VM cluster.
statusReason (string) --
Additional information about the status of the Exascale VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the Exascale VM cluster.
timeZone (string) --
The time zone of the Exascale VM cluster.
totalEcpuCount (integer) --
The total number of ECPUs for the Exascale VM cluster.
totalFileSystemStorage (dict) --
The total file system storage details for the Exascale VM cluster.
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
vipIds (list) --
The virtual IP (VIP) addresses associated with the Exascale VM cluster. One VIP address is assigned per node to support failover. If a node fails, its VIP is reassigned to another active node in the cluster.
(string) --
vmFileSystemStorage (dict) --
The VM file system storage details for the Exascale VM cluster.
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
Updates the specified Exascale VM cluster.
See also: AWS API Documentation
Request Syntax
client.update_exadb_vm_cluster(
exadbVmClusterId='string',
dataCollectionOptions={
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
displayName='string',
enabledEcpuCount=123,
gridImageId='string',
licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
sshPublicKeys=[
'string',
],
systemVersion='string',
totalEcpuCount=123,
updateAction='ROLLING_APPLY'|'NON_ROLLING_APPLY'|'PRECHECK'|'ROLLBACK',
vmFileSystemStorageTotalSizeInGBs=123
)
string
[REQUIRED]
The unique identifier of the Exascale VM cluster to update.
dict
The set of preferences for the various diagnostic collection options for the Exascale VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
string
A new user-friendly name for the Exascale VM cluster.
integer
The number of ECPUs to enable for the Exascale VM cluster.
string
The Grid Infrastructure software image ID for the Exascale VM cluster.
string
The Oracle license model to apply to the Exascale VM cluster.
list
The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
(string) --
string
The version of the operating system of the image for the Exascale VM cluster.
integer
The total number of ECPUs for the Exascale VM cluster.
string
The update action to perform on the Exascale VM cluster.
integer
The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exadbVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale VM cluster.
status (string) --
The current status of the Exascale VM cluster.
statusReason (string) --
Additional information about the status of the Exascale VM cluster.
exadbVmClusterId (string) --
The unique identifier of the Exascale VM cluster.
Returns information about the specified Exascale VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_exadb_vm_cluster(
exadbVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the Exascale VM cluster.
dict
Response Syntax
{
'exadbVmCluster': {
'exadbVmClusterId': 'string',
'clusterName': 'string',
'createdAt': datetime(2015, 1, 1),
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'displayName': 'string',
'domain': 'string',
'enabledEcpuCount': 123,
'exadbVmClusterArn': 'string',
'exascaleDbStorageVaultArn': 'string',
'exascaleDbStorageVaultId': 'string',
'giVersion': 'string',
'gridImageId': 'string',
'gridImageType': 'RELEASE_UPDATE'|'CUSTOM_IMAGE',
'hostname': 'string',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
],
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'odbNetworkArn': 'string',
'odbNetworkId': 'string',
'percentProgress': ...,
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'scanListenerPortTcp': 123,
'scanListenerPortTcpSsl': 123,
'shape': 'string',
'shapeAttribute': 'SMART_STORAGE'|'BLOCK_STORAGE',
'snapshotFileSystemStorage': {
'totalSizeInGBs': 123
},
'sshPublicKeys': [
'string',
],
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'systemVersion': 'string',
'timeZone': 'string',
'totalEcpuCount': 123,
'totalFileSystemStorage': {
'totalSizeInGBs': 123
},
'vipIds': [
'string',
],
'vmFileSystemStorage': {
'totalSizeInGBs': 123
}
}
}
Response Structure
(dict) --
exadbVmCluster (dict) --
The Exascale VM cluster.
exadbVmClusterId (string) --
The unique identifier of the Exascale VM cluster.
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
createdAt (datetime) --
The date and time when the Exascale VM cluster was created.
dataCollectionOptions (dict) --
The set of diagnostic collection options enabled for the Exascale VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
displayName (string) --
The user-friendly name for the Exascale VM cluster.
domain (string) --
The domain of the Exascale VM cluster.
enabledEcpuCount (integer) --
The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster.
exadbVmClusterArn (string) --
The Amazon Resource Name (ARN) of the Exascale VM cluster.
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault associated with this Exascale VM cluster.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault associated with this Exascale VM cluster.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster.
gridImageId (string) --
The Grid Infrastructure software image ID for the Exascale VM cluster.
gridImageType (string) --
The type of Grid Infrastructure image for the Exascale VM cluster.
hostname (string) --
The host name for the Exascale VM cluster.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale 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.
iormConfigCache (dict) --
The I/O Resource Management (IORM) configuration cache details for the Exascale VM cluster.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the Exascale VM cluster.
listenerPort (integer) --
The port number configured for the listener on the Exascale VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster.
nodeCount (integer) --
The number of nodes in the Exascale VM cluster.
ocid (string) --
The OCID of the Exascale VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exascale VM cluster.
ociUrl (string) --
The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI).
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this Exascale VM cluster.
odbNetworkId (string) --
The unique identifier of the ODB network for the Exascale VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage.
scanDnsName (string) --
The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the Exascale VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster.
(string) --
scanListenerPortTcp (integer) --
The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster.
scanListenerPortTcpSsl (integer) --
The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster.
shape (string) --
The hardware model name of the Exadata infrastructure that's running the Exascale VM cluster.
shapeAttribute (string) --
The shape attribute for the Exascale VM cluster.
snapshotFileSystemStorage (dict) --
The snapshot file system storage details for the Exascale VM cluster.
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
(string) --
status (string) --
The current status of the Exascale VM cluster.
statusReason (string) --
Additional information about the status of the Exascale VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the Exascale VM cluster.
timeZone (string) --
The time zone of the Exascale VM cluster.
totalEcpuCount (integer) --
The total number of ECPUs for the Exascale VM cluster.
totalFileSystemStorage (dict) --
The total file system storage details for the Exascale VM cluster.
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
vipIds (list) --
The virtual IP (VIP) addresses associated with the Exascale VM cluster. One VIP address is assigned per node to support failover. If a node fails, its VIP is reassigned to another active node in the cluster.
(string) --
vmFileSystemStorage (dict) --
The VM file system storage details for the Exascale VM cluster.
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
Creates an Exascale VM cluster.
See also: AWS API Documentation
Request Syntax
client.create_exadb_vm_cluster(
displayName='string',
enabledEcpuCount=123,
exascaleDbStorageVaultId='string',
gridImageId='string',
hostname='string',
nodeCount=123,
odbNetworkId='string',
shape='string',
sshPublicKeys=[
'string',
],
totalEcpuCount=123,
vmFileSystemStorageTotalSizeInGBs=123,
clusterName='string',
dataCollectionOptions={
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
scanListenerPortTcp=123,
scanListenerPortTcpSsl=123,
shapeAttribute='SMART_STORAGE'|'BLOCK_STORAGE',
systemVersion='string',
tags={
'string': 'string'
},
timeZone='string',
clientToken='string'
)
string
[REQUIRED]
A user-friendly name for the Exascale VM cluster.
integer
[REQUIRED]
The number of ECPUs to enable for the Exascale VM cluster.
string
[REQUIRED]
The unique identifier of the Exascale storage vault for this Exascale VM cluster.
string
[REQUIRED]
The Grid Infrastructure software image ID for the Exascale VM cluster.
string
[REQUIRED]
The host name for the Exascale VM cluster.
integer
[REQUIRED]
The number of nodes in the Exascale VM cluster.
string
[REQUIRED]
The unique identifier of the ODB network for the Exascale VM cluster.
string
[REQUIRED]
The shape of the Exascale VM cluster.
list
[REQUIRED]
The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
(string) --
integer
[REQUIRED]
The total number of ECPUs for the Exascale VM cluster.
integer
[REQUIRED]
The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.
string
A name for the Grid Infrastructure cluster. The name isn't case sensitive.
dict
The set of preferences for the various diagnostic collection options for the Exascale VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
string
The Oracle license model to apply to the Exascale VM cluster.
integer
The port number for TCP connections to the single client access name (SCAN) listener.
integer
The port number for TCP connections with SSL to the single client access name (SCAN) listener.
string
The shape attribute for the Exascale VM cluster.
string
The version of the operating system of the image for the Exascale VM cluster.
dict
The list of resource tags to apply to the Exascale VM cluster.
(string) --
(string) --
string
The time zone for the Exascale VM cluster.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates one and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.
This field is autopopulated if not provided.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exadbVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale VM cluster.
status (string) --
The current status of the Exascale VM cluster.
statusReason (string) --
Additional information about the status of the Exascale VM cluster.
exadbVmClusterId (string) --
The unique identifier of the Exascale VM cluster.
Returns a list of the Oracle Grid Infrastructure (GI) minor versions for the specified major version.
See also: AWS API Documentation
Request Syntax
client.list_gi_minor_versions(
giVersion='string',
maxResults=123,
nextToken='string',
shapeFamily='string',
availabilityZone='string',
availabilityZoneId='string'
)
string
[REQUIRED]
The Oracle Grid Infrastructure (GI) major version.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The shape family for the GI minor version.
string
The Availability Zone to filter GI minor versions.
string
The Availability Zone ID to filter GI minor versions.
dict
Response Syntax
{
'nextToken': 'string',
'giMinorVersions': [
{
'version': 'string',
'gridImageId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
giMinorVersions (list) --
The list of GI minor versions.
(dict) --
Summary information about an Oracle Grid Infrastructure (GI) minor version.
version (string) --
The GI minor version.
gridImageId (string) --
The Grid Infrastructure software image ID for this minor version.
Creates an Exascale storage vault.
See also: AWS API Documentation
Request Syntax
client.create_exascale_db_storage_vault(
displayName='string',
highCapacityDatabaseStorageTotalSizeInGBs=123,
additionalFlashCacheInPercent=123,
autoscaleLimitInGBs=123,
availabilityZoneId='string',
availabilityZone='string',
description='string',
isAutoscaleEnabled=True|False,
tags={
'string': 'string'
},
timeZone='string',
clientToken='string'
)
string
[REQUIRED]
A user-friendly name for the Exascale storage vault.
integer
[REQUIRED]
The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault.
integer
The additional flash cache percentage for the Exascale storage vault.
integer
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
string
The Availability Zone ID for the Exascale storage vault.
string
The Availability Zone for the Exascale storage vault.
string
A description of the Exascale storage vault.
boolean
Specifies whether autoscaling is enabled for the Exascale storage vault.
dict
The list of resource tags to apply to the Exascale storage vault.
(string) --
(string) --
string
The time zone for the Exascale storage vault.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates one and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.
This field is autopopulated if not provided.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exascaleDbStorageVaultId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale storage vault.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
Deletes the specified Exascale VM cluster.
See also: AWS API Documentation
Request Syntax
client.delete_exadb_vm_cluster(
exadbVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the Exascale VM cluster to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'exadbVmClusterId': 'string'}
Returns information about the specified DB node.
See also: AWS API Documentation
Request Syntax
client.get_db_node(
cloudVmClusterId='string',
exadbVmClusterId='string',
dbNodeId='string'
)
string
The unique identifier of the VM cluster that contains the DB node. You must specify either this parameter or exadbVmClusterId.
string
The unique identifier of the Exascale VM cluster that contains the DB node. You must specify either this parameter or cloudVmClusterId.
string
[REQUIRED]
The unique identifier of the DB node to retrieve information about.
dict
Response Syntax
{
'dbNode': {
'dbNodeId': 'string',
'dbNodeArn': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'STOPPING'|'STOPPED'|'STARTING',
'statusReason': 'string',
'additionalDetails': 'string',
'backupIpId': 'string',
'backupVnic2Id': 'string',
'backupVnicId': 'string',
'cpuCoreCount': 123,
'dbNodeStorageSizeInGBs': 123,
'dbServerId': 'string',
'dbSystemId': 'string',
'faultDomain': 'string',
'hostIpId': 'string',
'hostname': 'string',
'ocid': 'string',
'ociResourceAnchorName': 'string',
'maintenanceType': 'VMDB_REBOOT_MIGRATION',
'memorySizeInGBs': 123,
'softwareStorageSizeInGB': 123,
'createdAt': datetime(2015, 1, 1),
'timeMaintenanceWindowEnd': 'string',
'timeMaintenanceWindowStart': 'string',
'totalCpuCoreCount': 123,
'vnic2Id': 'string',
'vnicId': 'string',
'privateIpAddress': 'string',
'floatingIpAddress': 'string'
}
}
Response Structure
(dict) --
dbNode (dict) --
Information about a DB node.
dbNodeId (string) --
The unique identifier of the DB node.
dbNodeArn (string) --
The Amazon Resource Name (ARN) of the DB node.
status (string) --
The current status of the DB node.
statusReason (string) --
Additional information about the status of the DB node.
additionalDetails (string) --
Additional information about the planned maintenance.
backupIpId (string) --
The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.
backupVnic2Id (string) --
The OCID of the second backup VNIC.
backupVnicId (string) --
The OCID of the backup VNIC.
cpuCoreCount (integer) --
Number of CPU cores enabled on the DB node.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated on the DB node.
dbServerId (string) --
The unique identifier of the Db server that is associated with the DB node.
dbSystemId (string) --
The OCID of the DB system.
faultDomain (string) --
The name of the fault domain the instance is contained in.
hostIpId (string) --
The OCID of the host IP address that's associated with the DB node.
hostname (string) --
The host name for the DB node.
ocid (string) --
The OCID of the DB node.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the DB node.
maintenanceType (string) --
The type of database node maintenance. Either VMDB_REBOOT_MIGRATION or EXADBXS_REBOOT_MIGRATION.
memorySizeInGBs (integer) --
The allocated memory in GBs on the DB node.
softwareStorageSizeInGB (integer) --
The size (in GB) of the block storage volume allocation for the DB system.
createdAt (datetime) --
The date and time when the DB node was created.
timeMaintenanceWindowEnd (string) --
End date and time of maintenance window.
timeMaintenanceWindowStart (string) --
Start date and time of maintenance window.
totalCpuCoreCount (integer) --
The total number of CPU cores reserved on the DB node.
vnic2Id (string) --
The OCID of the second VNIC.
vnicId (string) --
The OCID of the VNIC.
privateIpAddress (string) --
The private IP address assigned to the DB node.
floatingIpAddress (string) --
The floating IP address assigned to the DB node.
{'exadbVmClusterId': 'string'}
Returns information about the DB nodes for the specified VM cluster.
See also: AWS API Documentation
Request Syntax
client.list_db_nodes(
maxResults=123,
nextToken='string',
cloudVmClusterId='string',
exadbVmClusterId='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The unique identifier of the VM cluster. You must specify either this parameter or exadbVmClusterId.
string
The unique identifier of the Exascale VM cluster. You must specify either this parameter or cloudVmClusterId.
dict
Response Syntax
{
'nextToken': 'string',
'dbNodes': [
{
'dbNodeId': 'string',
'dbNodeArn': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'STOPPING'|'STOPPED'|'STARTING',
'statusReason': 'string',
'additionalDetails': 'string',
'backupIpId': 'string',
'backupVnic2Id': 'string',
'backupVnicId': 'string',
'cpuCoreCount': 123,
'dbNodeStorageSizeInGBs': 123,
'dbServerId': 'string',
'dbSystemId': 'string',
'faultDomain': 'string',
'hostIpId': 'string',
'hostname': 'string',
'ocid': 'string',
'ociResourceAnchorName': 'string',
'maintenanceType': 'VMDB_REBOOT_MIGRATION',
'memorySizeInGBs': 123,
'softwareStorageSizeInGB': 123,
'createdAt': datetime(2015, 1, 1),
'timeMaintenanceWindowEnd': 'string',
'timeMaintenanceWindowStart': 'string',
'totalCpuCoreCount': 123,
'vnic2Id': 'string',
'vnicId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
dbNodes (list) --
The list of DB nodes along with their properties.
(dict) --
Information about a DB node.
dbNodeId (string) --
The unique identifier of the DB node.
dbNodeArn (string) --
The Amazon Resource Name (ARN) of the DB node.
status (string) --
The current status of the DB node.
statusReason (string) --
Additional information about the status of the DB node.
additionalDetails (string) --
Additional information about the planned maintenance.
backupIpId (string) --
The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.
backupVnic2Id (string) --
The OCID of the second backup virtual network interface card (VNIC) for the DB node.
backupVnicId (string) --
The OCID of the backup VNIC for the DB node.
cpuCoreCount (integer) --
The number of CPU cores enabled on the DB node.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated on the DB node.
dbServerId (string) --
The unique identifier of the database server that's associated with the DB node.
dbSystemId (string) --
The OCID of the DB system.
faultDomain (string) --
The name of the fault domain where the DB node is located.
hostIpId (string) --
The OCID of the host IP address that's associated with the DB node.
hostname (string) --
The host name for the DB node.
ocid (string) --
The OCID of the DB node.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the DB node.
maintenanceType (string) --
The type of maintenance the DB node.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that allocated on the DB node.
softwareStorageSizeInGB (integer) --
The size of the block storage volume, in gigabytes (GB), that's allocated for the DB system. This attribute applies only for virtual machine DB systems.
createdAt (datetime) --
The date and time when the DB node was created.
timeMaintenanceWindowEnd (string) --
The end date and time of the maintenance window.
timeMaintenanceWindowStart (string) --
The start date and time of the maintenance window.
totalCpuCoreCount (integer) --
The total number of CPU cores reserved on the DB node.
vnic2Id (string) --
The OCID of the second VNIC.
vnicId (string) --
The OCID of the VNIC.
{'shapeFamily': 'string'}
Response {'dbSystemShapes': {'shapeAttributes': ['SMART_STORAGE | BLOCK_STORAGE']}}
Returns information about the shapes that are available for an Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_db_system_shapes(
maxResults=123,
nextToken='string',
availabilityZone='string',
availabilityZoneId='string',
shapeFamily='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The logical name of the AZ, for example, us-east-1a. This name varies depending on the account.
string
The physical ID of the AZ, for example, use1-az4. This ID persists across accounts.
string
The shape family to filter results by.
dict
Response Syntax
{
'nextToken': 'string',
'dbSystemShapes': [
{
'availableCoreCount': 123,
'availableCoreCountPerNode': 123,
'availableDataStorageInTBs': 123,
'availableDataStoragePerServerInTBs': 123,
'availableDbNodePerNodeInGBs': 123,
'availableDbNodeStorageInGBs': 123,
'availableMemoryInGBs': 123,
'availableMemoryPerNodeInGBs': 123,
'coreCountIncrement': 123,
'maxStorageCount': 123,
'maximumNodeCount': 123,
'minCoreCountPerNode': 123,
'minDataStorageInTBs': 123,
'minDbNodeStoragePerNodeInGBs': 123,
'minMemoryPerNodeInGBs': 123,
'minStorageCount': 123,
'minimumCoreCount': 123,
'minimumNodeCount': 123,
'runtimeMinimumCoreCount': 123,
'shapeFamily': 'string',
'shapeType': 'AMD'|'INTEL'|'INTEL_FLEX_X9'|'AMPERE_FLEX_A1',
'shapeAttributes': [
'SMART_STORAGE'|'BLOCK_STORAGE',
],
'name': 'string',
'computeModel': 'ECPU'|'OCPU',
'areServerTypesSupported': True|False
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
dbSystemShapes (list) --
The list of shapes and their properties.
(dict) --
Information about a hardware system model (shape) that's available for an Exadata infrastructure. The shape determines resources, such as CPU cores, memory, and storage, to allocate to the Exadata infrastructure.
availableCoreCount (integer) --
The maximum number of CPU cores that can be enabled for the shape.
availableCoreCountPerNode (integer) --
The maximum number of CPU cores per DB node that can be enabled for the shape.
availableDataStorageInTBs (integer) --
The maximum amount of data storage, in terabytes (TB), that can be enabled for the shape.
availableDataStoragePerServerInTBs (integer) --
The maximum amount of data storage, in terabytes (TB), that's available per storage server for the shape.
availableDbNodePerNodeInGBs (integer) --
The maximum amount of DB node storage, in gigabytes (GB), that's available per DB node for the shape.
availableDbNodeStorageInGBs (integer) --
The maximum amount of DB node storage, in gigabytes (GB), that can be enabled for the shape.
availableMemoryInGBs (integer) --
The maximum amount of memory, in gigabytes (GB), that can be enabled for the shape.
availableMemoryPerNodeInGBs (integer) --
The maximum amount of memory, in gigabytes (GB), that's available per DB node for the shape.
coreCountIncrement (integer) --
The discrete number by which the CPU core count for the shape can be increased or decreased.
maxStorageCount (integer) --
The maximum number of Exadata storage servers that's available for the shape.
maximumNodeCount (integer) --
The maximum number of compute servers that is available for the shape.
minCoreCountPerNode (integer) --
The minimum number of CPU cores that can be enabled per node for the shape.
minDataStorageInTBs (integer) --
The minimum amount of data storage, in terabytes (TB), that must be allocated for the shape.
minDbNodeStoragePerNodeInGBs (integer) --
The minimum amount of DB node storage, in gigabytes (GB), that must be allocated per DB node for the shape.
minMemoryPerNodeInGBs (integer) --
The minimum amount of memory, in gigabytes (GB), that must be allocated per DB node for the shape.
minStorageCount (integer) --
The minimum number of Exadata storage servers that are available for the shape.
minimumCoreCount (integer) --
The minimum number of CPU cores that can be enabled for the shape.
minimumNodeCount (integer) --
The minimum number of compute servers that are available for the shape.
runtimeMinimumCoreCount (integer) --
The runtime minimum number of CPU cores that can be enabled for the shape.
shapeFamily (string) --
The family of the shape.
shapeType (string) --
The shape type. This property is determined by the CPU hardware.
shapeAttributes (list) --
If provided and applicable, return DB System shape parameters based on the shape attribute provided.
(string) --
name (string) --
The name of the shape.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
areServerTypesSupported (boolean) --
Indicates whether the hardware system model supports configurable database and server storage types.
{'exadbVmClusterId': 'string'}
Reboots the specified DB node in a VM cluster.
See also: AWS API Documentation
Request Syntax
client.reboot_db_node(
cloudVmClusterId='string',
exadbVmClusterId='string',
dbNodeId='string'
)
string
The unique identifier of the VM cluster that contains the DB node to reboot. You must specify either this parameter or exadbVmClusterId.
string
The unique identifier of the Exascale VM cluster that contains the DB node to reboot. You must specify either this parameter or cloudVmClusterId.
string
[REQUIRED]
The unique identifier of the DB node to reboot.
dict
Response Syntax
{
'dbNodeId': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'STOPPING'|'STOPPED'|'STARTING',
'statusReason': 'string'
}
Response Structure
(dict) --
dbNodeId (string) --
The unique identifier of the DB node that was rebooted.
status (string) --
The current status of the DB node after the reboot operation.
statusReason (string) --
Additional information about the status of the DB node after the reboot operation.
{'exadbVmClusterId': 'string'}
Starts the specified DB node in a VM cluster.
See also: AWS API Documentation
Request Syntax
client.start_db_node(
cloudVmClusterId='string',
exadbVmClusterId='string',
dbNodeId='string'
)
string
The unique identifier of the VM cluster that contains the DB node to start. You must specify either this parameter or exadbVmClusterId.
string
The unique identifier of the Exascale VM cluster that contains the DB node to start. You must specify either this parameter or cloudVmClusterId.
string
[REQUIRED]
The unique identifier of the DB node to start.
dict
Response Syntax
{
'dbNodeId': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'STOPPING'|'STOPPED'|'STARTING',
'statusReason': 'string'
}
Response Structure
(dict) --
dbNodeId (string) --
The unique identifier of the DB node that was started.
status (string) --
The current status of the DB node after the start operation.
statusReason (string) --
Additional information about the status of the DB node after the start operation.
{'exadbVmClusterId': 'string'}
Stops the specified DB node in a VM cluster.
See also: AWS API Documentation
Request Syntax
client.stop_db_node(
cloudVmClusterId='string',
exadbVmClusterId='string',
dbNodeId='string'
)
string
The unique identifier of the VM cluster that contains the DB node to stop. You must specify either this parameter or exadbVmClusterId.
string
The unique identifier of the Exascale VM cluster that contains the DB node to stop. You must specify either this parameter or cloudVmClusterId.
string
[REQUIRED]
The unique identifier of the DB node to stop.
dict
Response Syntax
{
'dbNodeId': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'STOPPING'|'STOPPED'|'STARTING',
'statusReason': 'string'
}
Response Structure
(dict) --
dbNodeId (string) --
The unique identifier of the DB node that was stopped.
status (string) --
The current status of the DB node after the stop operation.
statusReason (string) --
Additional information about the status of the DB node after the stop operation.