2025/07/01 - odb - 40 new api methods
Changes This release adds API operations for Oracle Database@AWS. You can use the APIs to create Exadata infrastructure, ODB networks, and Exadata and Autonomous VM clusters inside AWS data centers. The infrastructure is managed by OCI. You can integrate these resources with AWS services.
Returns information about the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.get_cloud_exadata_infrastructure(
cloudExadataInfrastructureId='string'
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure.
dict
Response Syntax
{
'cloudExadataInfrastructure': {
'cloudExadataInfrastructureId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureArn': 'string',
'activatedStorageCount': 123,
'additionalStorageCount': 123,
'availableStorageSizeInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'computeCount': 123,
'cpuCount': 123,
'customerContactsToSendToOCI': [
{
'email': 'string'
},
],
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServerVersion': 'string',
'lastMaintenanceRunId': 'string',
'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,
]
},
'maxCpuCount': 123,
'maxDataStorageInTBs': 123.0,
'maxDbNodeStorageSizeInGBs': 123,
'maxMemoryInGBs': 123,
'memorySizeInGBs': 123,
'monthlyDbServerVersion': 'string',
'monthlyStorageServerVersion': 'string',
'nextMaintenanceRunId': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'ocid': 'string',
'shape': 'string',
'storageCount': 123,
'storageServerVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'totalStorageSizeInGBs': 123,
'percentProgress': ...,
'databaseServerType': 'string',
'storageServerType': 'string',
'computeModel': 'ECPU'|'OCPU'
}
}
Response Structure
(dict) --
cloudExadataInfrastructure (dict) --
The Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier for the Exadata infrastructure.
displayName (string) --
The user-friendly name for the Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure.
statusReason (string) --
Additional information about the status of the Exadata infrastructure.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) for the Exadata infrastructure.
activatedStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
additionalStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
availableStorageSizeInGBs (integer) --
The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
availabilityZone (string) --
The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the Exadata infrastructure is located.
computeCount (integer) --
The number of database servers for the Exadata infrastructure.
cpuCount (integer) --
The total number of CPU cores that are allocated to the Exadata infrastructure.
customerContactsToSendToOCI (list) --
The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
(dict) --
A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.
email (string) --
The email address of the contact.
dataStorageSizeInTBs (float) --
The size of the Exadata infrastructure's data disk group, in terabytes (TB).
dbNodeStorageSizeInGBs (integer) --
The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
dbServerVersion (string) --
The software version of the database servers (dom0) in the Exadata infrastructure.
lastMaintenanceRunId (string) --
The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.
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) --
maxCpuCount (integer) --
The total number of CPU cores available on the Exadata infrastructure.
maxDataStorageInTBs (float) --
The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
maxDbNodeStorageSizeInGBs (integer) --
The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
maxMemoryInGBs (integer) --
The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
monthlyDbServerVersion (string) --
The monthly software version of the database servers installed on the Exadata infrastructure.
monthlyStorageServerVersion (string) --
The monthly software version of the storage servers installed on the Exadata infrastructure.
nextMaintenanceRunId (string) --
The OCID of the next maintenance run for the Exadata infrastructure.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exadata infrastructure.
ociUrl (string) --
The HTTPS link to the Exadata infrastructure in OCI.
ocid (string) --
The OCID of the Exadata infrastructure.
shape (string) --
The model name of the Exadata infrastructure.
storageCount (integer) --
The number of storage servers that are activated for the Exadata infrastructure.
storageServerVersion (string) --
The software version of the storage servers on the Exadata infrastructure.
createdAt (datetime) --
The date and time when the Exadata infrastructure was created.
totalStorageSizeInGBs (integer) --
The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.
percentProgress (float) --
The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.
databaseServerType (string) --
The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
storageServerType (string) --
The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
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.
Deletes an ODB peering connection.
When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.
See also: AWS API Documentation
Request Syntax
client.delete_odb_peering_connection(
odbPeeringConnectionId='string'
)
string
[REQUIRED]
The unique identifier of the ODB peering connection to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the ODB networks owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_odb_networks(
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.
Default: 10
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',
'odbNetworks': [
{
'odbNetworkId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkArn': 'string',
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'clientSubnetCidr': 'string',
'backupSubnetCidr': 'string',
'customDomainName': 'string',
'defaultDnsPrefix': 'string',
'peeredCidrs': [
'string',
],
'ociNetworkAnchorId': 'string',
'ociNetworkAnchorUrl': 'string',
'ociResourceAnchorName': 'string',
'ociVcnId': 'string',
'ociVcnUrl': 'string',
'ociDnsForwardingConfigs': [
{
'domainName': 'string',
'ociDnsListenerIp': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'percentProgress': ...,
'managedServices': {
'serviceNetworkArn': 'string',
'resourceGatewayArn': 'string',
'managedServicesIpv4Cidrs': [
'string',
],
'serviceNetworkEndpoint': {
'vpcEndpointId': 'string',
'vpcEndpointType': 'SERVICENETWORK'
},
'managedS3BackupAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
]
},
'zeroEtlAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'cidr': 'string'
},
's3Access': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
's3PolicyDocument': '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.
odbNetworks (list) --
The list of ODB networks.
(dict) --
Information about an ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the current status of the ODB network.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network.
availabilityZone (string) --
The Amazon Web Services Availability Zone (AZ) where the ODB network is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the ODB network is located.
clientSubnetCidr (string) --
The CIDR range of the client subnet in the ODB network.
backupSubnetCidr (string) --
The CIDR range of the backup subnet in the ODB network.
customDomainName (string) --
The domain name for the resources in the ODB network.
defaultDnsPrefix (string) --
The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
peeredCidrs (list) --
The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.
(string) --
ociNetworkAnchorId (string) --
The unique identifier of the OCI network anchor for the ODB network.
ociNetworkAnchorUrl (string) --
The URL of the OCI network anchor for the ODB network.
ociResourceAnchorName (string) --
The name of the OCI resource anchor associated with the ODB network.
ociVcnId (string) --
The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) associated with the ODB network.
ociVcnUrl (string) --
The URL for the VCN that's associated with the ODB network.
ociDnsForwardingConfigs (list) --
The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.
(dict) --
DNS configuration to forward DNS resolver endpoints to your OCI Private Zone.
domainName (string) --
Domain name to which DNS resolver forwards to.
ociDnsListenerIp (string) --
OCI DNS listener IP for custom DNS setup.
createdAt (datetime) --
The date and time when the ODB network was created.
percentProgress (float) --
The amount of progress made on the current operation on the ODB network, expressed as a percentage.
managedServices (dict) --
The managed services configuration for the ODB network.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
resourceGatewayArn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
managedServicesIpv4Cidrs (list) --
The IPv4 CIDR blocks for the managed services.
(string) --
serviceNetworkEndpoint (dict) --
The service network endpoint configuration.
vpcEndpointId (string) --
The identifier of the VPC endpoint.
vpcEndpointType (string) --
The type of the VPC endpoint.
Valid Values: Interface | Gateway
managedS3BackupAccess (dict) --
The managed Amazon S3 backup access configuration.
status (string) --
The status of the managed Amazon S3 backup access.
Valid Values: enabled | disabled
ipv4Addresses (list) --
The IPv4 addresses for the managed Amazon S3 backup access.
(string) --
zeroEtlAccess (dict) --
The Zero-ETL access configuration.
status (string) --
The status of the Zero-ETL access.
Valid Values: enabled | disabled
cidr (string) --
The CIDR block for the Zero-ETL access.
s3Access (dict) --
The Amazon S3 access configuration.
status (string) --
The status of the Amazon S3 access.
Valid Values: enabled | disabled
ipv4Addresses (list) --
The IPv4 addresses for the Amazon S3 access.
(string) --
domainName (string) --
The domain name for the Amazon S3 access.
s3PolicyDocument (string) --
The endpoint policy for the Amazon S3 access.
Retrieves information about an ODB peering connection.
See also: AWS API Documentation
Request Syntax
client.get_odb_peering_connection(
odbPeeringConnectionId='string'
)
string
[REQUIRED]
The unique identifier of the ODB peering connection to retrieve information about.
dict
Response Syntax
{
'odbPeeringConnection': {
'odbPeeringConnectionId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbPeeringConnectionArn': 'string',
'odbNetworkArn': 'string',
'peerNetworkArn': 'string',
'odbPeeringConnectionType': 'string',
'createdAt': datetime(2015, 1, 1),
'percentProgress': ...
}
}
Response Structure
(dict) --
odbPeeringConnection (dict) --
A peering connection between an ODB network and either another ODB network or a customer-owned VPC.
odbPeeringConnectionId (string) --
The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678.
displayName (string) --
The display name of the ODB peering connection.
status (string) --
The status of the ODB peering connection.
Valid Values: provisioning | active | terminating | terminated | failed
statusReason (string) --
The reason for the current status of the ODB peering connection.
odbPeeringConnectionArn (string) --
The Amazon Resource Name (ARN) of the ODB peering connection.
Example: arn:aws:odb:us-east-1:123456789012:odb-peering-connection/odbpcx-abcdefgh12345678
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
peerNetworkArn (string) --
The Amazon Resource Name (ARN) of the peer network.
odbPeeringConnectionType (string) --
The type of the ODB peering connection.
Valid Values: ODB-VPC | ODB-ODB
createdAt (datetime) --
The timestamp when the ODB peering connection was created.
percentProgress (float) --
The percentage progress of the ODB peering connection creation or deletion.
Returns information about the specified ODB network.
See also: AWS API Documentation
Request Syntax
client.get_odb_network(
odbNetworkId='string'
)
string
[REQUIRED]
The unique identifier of the ODB network.
dict
Response Syntax
{
'odbNetwork': {
'odbNetworkId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkArn': 'string',
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'clientSubnetCidr': 'string',
'backupSubnetCidr': 'string',
'customDomainName': 'string',
'defaultDnsPrefix': 'string',
'peeredCidrs': [
'string',
],
'ociNetworkAnchorId': 'string',
'ociNetworkAnchorUrl': 'string',
'ociResourceAnchorName': 'string',
'ociVcnId': 'string',
'ociVcnUrl': 'string',
'ociDnsForwardingConfigs': [
{
'domainName': 'string',
'ociDnsListenerIp': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'percentProgress': ...,
'managedServices': {
'serviceNetworkArn': 'string',
'resourceGatewayArn': 'string',
'managedServicesIpv4Cidrs': [
'string',
],
'serviceNetworkEndpoint': {
'vpcEndpointId': 'string',
'vpcEndpointType': 'SERVICENETWORK'
},
'managedS3BackupAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
]
},
'zeroEtlAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'cidr': 'string'
},
's3Access': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
's3PolicyDocument': 'string'
}
}
}
}
Response Structure
(dict) --
odbNetwork (dict) --
The ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the current status of the ODB network.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network.
availabilityZone (string) --
The Amazon Web Services Availability Zone (AZ) where the ODB network is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the ODB network is located.
clientSubnetCidr (string) --
The CIDR range of the client subnet in the ODB network.
backupSubnetCidr (string) --
The CIDR range of the backup subnet in the ODB network.
customDomainName (string) --
The domain name for the resources in the ODB network.
defaultDnsPrefix (string) --
The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
peeredCidrs (list) --
The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.
(string) --
ociNetworkAnchorId (string) --
The unique identifier of the OCI network anchor for the ODB network.
ociNetworkAnchorUrl (string) --
The URL of the OCI network anchor for the ODB network.
ociResourceAnchorName (string) --
The name of the OCI resource anchor that's associated with the ODB network.
ociVcnId (string) --
The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that's associated with the ODB network.
ociVcnUrl (string) --
The URL for the VCN that's associated with the ODB network.
ociDnsForwardingConfigs (list) --
The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.
(dict) --
DNS configuration to forward DNS resolver endpoints to your OCI Private Zone.
domainName (string) --
Domain name to which DNS resolver forwards to.
ociDnsListenerIp (string) --
OCI DNS listener IP for custom DNS setup.
createdAt (datetime) --
The date and time when the ODB network was created.
percentProgress (float) --
The amount of progress made on the current operation on the ODB network, expressed as a percentage.
managedServices (dict) --
The managed services configuration for the ODB network.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
resourceGatewayArn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
managedServicesIpv4Cidrs (list) --
The IPv4 CIDR blocks for the managed services.
(string) --
serviceNetworkEndpoint (dict) --
The service network endpoint configuration.
vpcEndpointId (string) --
The identifier of the VPC endpoint.
vpcEndpointType (string) --
The type of the VPC endpoint.
Valid Values: Interface | Gateway
managedS3BackupAccess (dict) --
The managed Amazon S3 backup access configuration.
status (string) --
The status of the managed Amazon S3 backup access.
Valid Values: enabled | disabled
ipv4Addresses (list) --
The IPv4 addresses for the managed Amazon S3 backup access.
(string) --
zeroEtlAccess (dict) --
The Zero-ETL access configuration.
status (string) --
The status of the Zero-ETL access.
Valid Values: enabled | disabled
cidr (string) --
The CIDR block for the Zero-ETL access.
s3Access (dict) --
The Amazon S3 access configuration.
status (string) --
The status of the Amazon S3 access.
Valid Values: enabled | disabled
ipv4Addresses (list) --
The IPv4 addresses for the Amazon S3 access.
(string) --
domainName (string) --
The domain name for the Amazon S3 access.
s3PolicyDocument (string) --
The endpoint policy for the Amazon S3 access.
Retrieves information about unallocated resources in a specified Cloud Exadata Infrastructure.
See also: AWS API Documentation
Request Syntax
client.get_cloud_exadata_infrastructure_unallocated_resources(
cloudExadataInfrastructureId='string',
dbServers=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the Cloud Exadata infrastructure for which to retrieve unallocated resources.
list
The database servers to include in the unallocated resources query.
(string) --
dict
Response Syntax
{
'cloudExadataInfrastructureUnallocatedResources': {
'cloudAutonomousVmClusters': [
{
'cloudAutonomousVmClusterId': 'string',
'unallocatedAdbStorageInTBs': 123.0
},
],
'cloudExadataInfrastructureDisplayName': 'string',
'exadataStorageInTBs': 123.0,
'cloudExadataInfrastructureId': 'string',
'localStorageInGBs': 123,
'memoryInGBs': 123,
'ocpus': 123
}
}
Response Structure
(dict) --
cloudExadataInfrastructureUnallocatedResources (dict) --
Details about the unallocated resources in the specified Cloud Exadata infrastructure.
cloudAutonomousVmClusters (list) --
A list of Autonomous VM clusters associated with this Cloud Exadata Infrastructure.
(dict) --
Resource details of an Autonomous VM cluster.
cloudAutonomousVmClusterId (string) --
The unique identifier of the Autonomous VM cluster.
unallocatedAdbStorageInTBs (float) --
The amount of unallocated Autonomous Database storage in the Autonomous VM cluster, in terabytes.
cloudExadataInfrastructureDisplayName (string) --
The display name of the Cloud Exadata infrastructure.
exadataStorageInTBs (float) --
The amount of unallocated Exadata storage available, in terabytes (TB).
cloudExadataInfrastructureId (string) --
The unique identifier of the Cloud Exadata infrastructure.
localStorageInGBs (integer) --
The amount of unallocated local storage available, in gigabytes (GB).
memoryInGBs (integer) --
The amount of unallocated memory available, in gigabytes (GB).
ocpus (integer) --
The number of unallocated Oracle CPU Units (OCPUs) available.
Returns information about the specified VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_cloud_vm_cluster(
cloudVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster.
dict
Response Syntax
{
'cloudVmCluster': {
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU'
}
}
Response Structure
(dict) --
cloudVmCluster (dict) --
The VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
The set of diagnostic collection options enabled for the 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.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The ExadataIormConfig cache details for the 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.
isLocalBackupEnabled (boolean) --
Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
isSparseDiskgroupEnabled (boolean) --
Indicates whether the VM cluster is configured with a sparse disk group.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
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.
Returns the tenancy activation link and onboarding status for your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.get_oci_onboarding_status()
dict
Response Syntax
{
'status': 'NOT_STARTED'|'PENDING_LINK_GENERATION'|'PENDING_CUSTOMER_ACTION'|'PENDING_INITIALIZATION'|'ACTIVATING'|'ACTIVE_IN_HOME_REGION'|'ACTIVE'|'ACTIVE_LIMITED'|'FAILED'|'PUBLIC_OFFER_UNSUPPORTED'|'SUSPENDED'|'CANCELED',
'existingTenancyActivationLink': 'string',
'newTenancyActivationLink': 'string'
}
Response Structure
(dict) --
status (string) --
existingTenancyActivationLink (string) --
The existing OCI tenancy activation link for your Amazon Web Services account.
newTenancyActivationLink (string) --
A new OCI tenancy activation link for your Amazon Web Services account.
Creates an Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.create_cloud_exadata_infrastructure(
displayName='string',
shape='string',
availabilityZone='string',
availabilityZoneId='string',
tags={
'string': 'string'
},
computeCount=123,
customerContactsToSendToOCI=[
{
'email': 'string'
},
],
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,
]
},
storageCount=123,
clientToken='string',
databaseServerType='string',
storageServerType='string'
)
string
[REQUIRED]
A user-friendly name for the Exadata infrastructure.
string
[REQUIRED]
The model name of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
string
The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
This operation requires that you specify a value for either availabilityZone or availabilityZoneId.
Example: us-east-1a
string
The AZ ID of the AZ where the Exadata infrastructure is located.
This operation requires that you specify a value for either availabilityZone or availabilityZoneId.
Example: use1-az1
dict
The list of resource tags to apply to the Exadata infrastructure.
(string) --
(string) --
integer
[REQUIRED]
The number of database servers for the Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the ListDbSystemShapes operation.
list
The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
(dict) --
A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.
email (string) --
The email address of the contact.
dict
The maintenance window configuration for the Exadata Cloud infrastructure.
This allows you to define when maintenance operations such as patching and updates can be performed on the infrastructure.
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) --
integer
[REQUIRED]
The number of storage servers to activate for this Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the ListDbSystemShapes operation.
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 a client token 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.
string
The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
string
The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure.
statusReason (string) --
Additional information about the status of the Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure.
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',
'ociResourceAnchorName': 'string',
'percentProgress': ...,
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': '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
}
}
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.
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.
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. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE.
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.
Returns information about the specified DB node.
See also: AWS API Documentation
Request Syntax
client.get_db_node(
cloudVmClusterId='string',
dbNodeId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster that contains the DB node.
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 (GBs), 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.
Updates the properties of an Exadata infrastructure resource.
See also: AWS API Documentation
Request Syntax
client.update_cloud_exadata_infrastructure(
cloudExadataInfrastructureId='string',
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,
]
}
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure to update.
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) --
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name of the updated Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure after the update operation.
statusReason (string) --
Additional information about the status of the Exadata infrastructure after the update operation.
cloudExadataInfrastructureId (string) --
The unique identifier of the updated Exadata infrastructure.
Deletes the specified ODB network.
See also: AWS API Documentation
Request Syntax
client.delete_odb_network(
odbNetworkId='string',
deleteAssociatedResources=True|False
)
string
[REQUIRED]
The unique identifier of the ODB network to delete.
boolean
[REQUIRED]
Specifies whether to delete associated OCI networking resources along with the ODB network.
dict
Response Syntax
{}
Response Structure
(dict) --
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'
)
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.
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',
'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.
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.
Returns information about the database servers that belong to the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_db_servers(
cloudExadataInfrastructureId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the Oracle Exadata infrastructure.
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.
dict
Response Syntax
{
'nextToken': 'string',
'dbServers': [
{
'dbServerId': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cpuCoreCount': 123,
'dbNodeStorageSizeInGBs': 123,
'dbServerPatchingDetails': {
'estimatedPatchDuration': 123,
'patchingStatus': 'COMPLETE'|'FAILED'|'MAINTENANCE_IN_PROGRESS'|'SCHEDULED',
'timePatchingEnded': 'string',
'timePatchingStarted': 'string'
},
'displayName': 'string',
'exadataInfrastructureId': 'string',
'ocid': 'string',
'ociResourceAnchorName': 'string',
'maxCpuCount': 123,
'maxDbNodeStorageInGBs': 123,
'maxMemoryInGBs': 123,
'memorySizeInGBs': 123,
'shape': 'string',
'createdAt': datetime(2015, 1, 1),
'vmClusterIds': [
'string',
],
'computeModel': 'ECPU'|'OCPU',
'autonomousVmClusterIds': [
'string',
],
'autonomousVirtualMachineIds': [
'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.
dbServers (list) --
The list of database servers along with their properties.
(dict) --
Information about a database server.
dbServerId (string) --
The unique identifier of the database server.
status (string) --
The current status of the database server.
statusReason (string) --
Additional information about the status of the database server.
cpuCoreCount (integer) --
The number of CPU cores enabled on the database server.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated on the database server.
dbServerPatchingDetails (dict) --
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
estimatedPatchDuration (integer) --
Estimated time, in minutes, to patch one database server.
patchingStatus (string) --
The status of the patching operation. Possible values are SCHEDULED, MAINTENANCE_IN_PROGRESS, FAILED, and COMPLETE.
timePatchingEnded (string) --
The time when the patching operation ended.
timePatchingStarted (string) --
The time when the patching operation started.
displayName (string) --
The user-friendly name of the database server. The name doesn't need to be unique.
exadataInfrastructureId (string) --
The ID of the Exadata infrastructure that hosts the database server.
ocid (string) --
The OCID of the database server.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the database server.
maxCpuCount (integer) --
The total number of CPU cores available on the database server.
maxDbNodeStorageInGBs (integer) --
The total amount of local node storage, in gigabytes (GB), that's available on the database server.
maxMemoryInGBs (integer) --
The total amount of memory, in gigabytes (GB), that's available on the database server.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated on the database server.
shape (string) --
The hardware system model of the Exadata infrastructure that the database server is hosted on. The shape determines the amount of CPU, storage, and memory resources available.
createdAt (datetime) --
The date and time when the database server was created.
vmClusterIds (list) --
The IDs of the VM clusters that are associated with the database server.
(string) --
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.
autonomousVmClusterIds (list) --
A list of identifiers for the Autonomous VM clusters.
(string) --
autonomousVirtualMachineIds (list) --
A list of unique identifiers for the Autonomous VMs.
(string) --
Creates a VM cluster on the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.create_cloud_vm_cluster(
cloudExadataInfrastructureId='string',
cpuCoreCount=123,
displayName='string',
giVersion='string',
hostname='string',
sshPublicKeys=[
'string',
],
odbNetworkId='string',
clusterName='string',
dataCollectionOptions={
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
dataStorageSizeInTBs=123.0,
dbNodeStorageSizeInGBs=123,
dbServers=[
'string',
],
tags={
'string': 'string'
},
isLocalBackupEnabled=True|False,
isSparseDiskgroupEnabled=True|False,
licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
memorySizeInGBs=123,
systemVersion='string',
timeZone='string',
clientToken='string',
scanListenerPortTcp=123
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure for this VM cluster.
integer
[REQUIRED]
The number of CPU cores to enable on the VM cluster.
string
[REQUIRED]
A user-friendly name for the VM cluster.
string
[REQUIRED]
A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure.
Example: 19.0.0.0
string
[REQUIRED]
The host name for the VM cluster.
Constraints:
Can't be "localhost" or "hostname".
Can't contain "-version".
The maximum length of the combined hostname and domain is 63 characters.
The hostname must be unique within the subnet.
list
[REQUIRED]
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
string
[REQUIRED]
The unique identifier of the ODB network for the 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 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.
float
The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.
integer
The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster.
list
The list of database servers for the VM cluster.
(string) --
dict
The list of resource tags to apply to the VM cluster.
(string) --
(string) --
boolean
Specifies whether to enable database backups to local Exadata storage for the VM cluster.
boolean
Specifies whether to create a sparse disk group for the VM cluster.
string
The Oracle license model to apply to the VM cluster.
Default: LICENSE_INCLUDED
integer
The amount of memory, in gigabytes (GBs), to allocate for the VM cluster.
string
The version of the operating system of the image for the VM cluster.
string
The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.
Default: UTC
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 a client token 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.
integer
The port number for TCP connections to the single client access name (SCAN) listener.
Valid values: 1024–8999 with the following exceptions: 2484, 6100, 6200, 7060, 7070, 7085, and 7879
Default: 1521
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterId (string) --
The unique identifier for the VM cluster.
Lists all Autonomous VMs in an Autonomous VM cluster.
See also: AWS API Documentation
Request Syntax
client.list_autonomous_virtual_machines(
maxResults=123,
nextToken='string',
cloudAutonomousVmClusterId='string'
)
integer
The maximum number of items to return per page.
string
The pagination token to continue listing from.
string
[REQUIRED]
The unique identifier of the Autonomous VM cluster whose virtual machines you're listing.
dict
Response Syntax
{
'nextToken': 'string',
'autonomousVirtualMachines': [
{
'autonomousVirtualMachineId': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'vmName': 'string',
'dbServerId': 'string',
'dbServerDisplayName': 'string',
'cpuCoreCount': 123,
'memorySizeInGBs': 123,
'dbNodeStorageSizeInGBs': 123,
'clientIpAddress': 'string',
'cloudAutonomousVmClusterId': 'string',
'ocid': 'string',
'ociResourceAnchorName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token from which to continue listing.
autonomousVirtualMachines (list) --
The list of Autonomous VMs in the specified Autonomous VM cluster.
(dict) --
A summary of an Autonomous Virtual Machine (VM) within an Autonomous VM cluster.
autonomousVirtualMachineId (string) --
The unique identifier of the Autonomous VM.
status (string) --
The current status of the Autonomous VM.
statusReason (string) --
Additional information about the current status of the Autonomous VM, if applicable.
vmName (string) --
The name of the Autonomous VM.
dbServerId (string) --
The unique identifier of the database server hosting this Autonomous VM.
dbServerDisplayName (string) --
The display name of the database server hosting this Autonomous VM.
cpuCoreCount (integer) --
The number of CPU cores allocated to this Autonomous VM.
memorySizeInGBs (integer) --
The amount of memory allocated to this Autonomous VM, in gigabytes (GB).
dbNodeStorageSizeInGBs (integer) --
The amount of storage allocated to this Autonomous Virtual Machine, in gigabytes (GB).
clientIpAddress (string) --
The IP address used by clients to connect to this Autonomous VM.
cloudAutonomousVmClusterId (string) --
The unique identifier of the Autonomous VM cluster containing this Autonomous VM.
ocid (string) --
The Oracle Cloud Identifier (OCID) of the Autonomous VM.
ociResourceAnchorName (string) --
The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with this Autonomous VM.
Creates an ODB network.
See also: AWS API Documentation
Request Syntax
client.create_odb_network(
displayName='string',
availabilityZone='string',
availabilityZoneId='string',
clientSubnetCidr='string',
backupSubnetCidr='string',
customDomainName='string',
defaultDnsPrefix='string',
clientToken='string',
s3Access='ENABLED'|'DISABLED',
zeroEtlAccess='ENABLED'|'DISABLED',
s3PolicyDocument='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
A user-friendly name for the ODB network.
string
The Amazon Web Services Availability Zone (AZ) where the ODB network is located.
This operation requires that you specify a value for either availabilityZone or availabilityZoneId.
string
The AZ ID of the AZ where the ODB network is located.
This operation requires that you specify a value for either availabilityZone or availabilityZoneId.
string
[REQUIRED]
The CIDR range of the client subnet for the ODB network.
Constraints:
Must not overlap with the CIDR range of the backup subnet.
Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
Must not use the following CIDR ranges that are reserved by OCI:
100.106.0.0/16 and 100.107.0.0/16
169.254.0.0/16
224.0.0.0 - 239.255.255.255
240.0.0.0 - 255.255.255.255
string
The CIDR range of the backup subnet for the ODB network.
Constraints:
Must not overlap with the CIDR range of the client subnet.
Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
Must not use the following CIDR ranges that are reserved by OCI:
100.106.0.0/16 and 100.107.0.0/16
169.254.0.0/16
224.0.0.0 - 239.255.255.255
240.0.0.0 - 255.255.255.255
string
The domain name to use for the resources in the ODB network.
string
The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
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 a client token 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.
string
Specifies the configuration for Amazon S3 access from the ODB network.
string
Specifies the configuration for Zero-ETL access from the ODB network.
string
Specifies the endpoint policy for Amazon S3 access from the ODB network.
dict
The list of resource tags to apply to the ODB network.
(string) --
(string) --
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the status of the ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
Stops the specified DB node in a VM cluster.
See also: AWS API Documentation
Request Syntax
client.stop_db_node(
cloudVmClusterId='string',
dbNodeId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster that contains the DB node to stop.
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.
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',
'ociResourceAnchorName': 'string',
'percentProgress': ...,
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': '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
},
]
}
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.
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.
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.
Lists all ODB peering connections or those associated with a specific ODB network.
See also: AWS API Documentation
Request Syntax
client.list_odb_peering_connections(
maxResults=123,
nextToken='string',
odbNetworkId='string'
)
integer
The maximum number of ODB peering connections to return in the response.
Default: 20
Constraints:
Must be between 1 and 100.
string
The pagination token for the next page of ODB peering connections.
string
The identifier of the ODB network to list peering connections for.
If not specified, lists all ODB peering connections in the account.
dict
Response Syntax
{
'nextToken': 'string',
'odbPeeringConnections': [
{
'odbPeeringConnectionId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbPeeringConnectionArn': 'string',
'odbNetworkArn': 'string',
'peerNetworkArn': 'string',
'odbPeeringConnectionType': 'string',
'createdAt': datetime(2015, 1, 1),
'percentProgress': ...
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token for the next page of ODB peering connections.
odbPeeringConnections (list) --
The list of ODB peering connections.
(dict) --
A summary of an ODB peering connection.
odbPeeringConnectionId (string) --
The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678.
displayName (string) --
The display name of the ODB peering connection.
status (string) --
The status of the ODB peering connection.
Valid Values: provisioning | active | terminating | terminated | failed
statusReason (string) --
The reason for the current status of the ODB peering connection.
odbPeeringConnectionArn (string) --
The Amazon Resource Name (ARN) of the ODB peering connection.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
peerNetworkArn (string) --
The Amazon Resource Name (ARN) of the peer network.
odbPeeringConnectionType (string) --
The type of the ODB peering connection.
Valid Values: ODB-VPC | ODB-ODB
createdAt (datetime) --
The timestamp when the ODB peering connection was created.
percentProgress (float) --
The percentage progress of the ODB peering connection creation or deletion.
Creates a new Autonomous VM cluster in the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.create_cloud_autonomous_vm_cluster(
cloudExadataInfrastructureId='string',
odbNetworkId='string',
displayName='string',
clientToken='string',
autonomousDataStorageSizeInTBs=123.0,
cpuCoreCountPerNode=123,
dbServers=[
'string',
],
description='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,
]
},
memoryPerOracleComputeUnitInGBs=123,
scanListenerPortNonTls=123,
scanListenerPortTls=123,
tags={
'string': 'string'
},
timeZone='string',
totalContainerDatabases=123
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure where the VM cluster will be created.
string
[REQUIRED]
The unique identifier of the ODB network to be used for the VM cluster.
string
[REQUIRED]
The display name for the Autonomous VM cluster. The name does not need to be unique.
string
A client-provided token to ensure idempotency of the request.
This field is autopopulated if not provided.
float
[REQUIRED]
The data disk group size to be allocated for Autonomous Databases, in terabytes (TB).
integer
[REQUIRED]
The number of CPU cores to be enabled per VM cluster node.
list
The list of database servers to be used for the Autonomous VM cluster.
(string) --
string
A user-provided description of the Autonomous VM cluster.
boolean
Specifies whether to enable mutual TLS (mTLS) authentication for the Autonomous VM cluster.
string
The Oracle license model to apply to the Autonomous VM cluster.
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) --
integer
[REQUIRED]
The amount of memory to be allocated per OCPU, in GB.
integer
The SCAN listener port for non-TLS (TCP) protocol.
integer
The SCAN listener port for TLS (TCP) protocol.
dict
Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.
(string) --
(string) --
string
The time zone to use for the Autonomous VM cluster.
integer
[REQUIRED]
The total number of Autonomous CDBs that you can create in the Autonomous VM cluster.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudAutonomousVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The display name of the created Autonomous VM cluster.
status (string) --
The current status of the Autonomous VM cluster creation process.
statusReason (string) --
Additional information about the current status of the Autonomous VM cluster creation process, if applicable.
cloudAutonomousVmClusterId (string) --
The unique identifier of the created Autonomous VM cluster.
Registers the Amazon Web Services Marketplace token for your Amazon Web Services account to activate your Oracle Database@Amazon Web Services subscription.
See also: AWS API Documentation
Request Syntax
client.accept_marketplace_registration(
marketplaceRegistrationToken='string'
)
string
[REQUIRED]
The registration token that's generated by Amazon Web Services Marketplace and sent to Oracle Database@Amazon Web Services.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_cloud_vm_clusters(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='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 Oracle Exadata infrastructure.
dict
Response Syntax
{
'nextToken': 'string',
'cloudVmClusters': [
{
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU'
},
]
}
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.
cloudVmClusters (list) --
The list of VM clusters along with their properties.
(dict) --
Information about a VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
Information about the data collection options enabled for a 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.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The IORM settings of the Exadata DB system.
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.
isLocalBackupEnabled (boolean) --
Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
isSparseDiskgroupEnabled (boolean) --
Indicates whether the VM cluster is configured with a sparse disk group.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
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.
Returns information about Oracle Grid Infrastructure (GI) software versions that are available for a VM cluster for the specified shape.
See also: AWS API Documentation
Request Syntax
client.list_gi_versions(
maxResults=123,
nextToken='string',
shape='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 shape to return GI versions for. For a list of valid shapes, use the ListDbSystemShapes operation..
dict
Response Syntax
{
'nextToken': 'string',
'giVersions': [
{
'version': '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.
giVersions (list) --
The list of GI versions and their properties.
(dict) --
Information about a specific version of Oracle Grid Infrastructure (GI) software that can be installed on a VM cluster.
version (string) --
The GI software version.
Returns information about the system versions that are available for a VM cluster for the specified giVersion and shape.
See also: AWS API Documentation
Request Syntax
client.list_system_versions(
maxResults=123,
nextToken='string',
giVersion='string',
shape='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
[REQUIRED]
The software version of the Exadata Grid Infrastructure (GI).
string
[REQUIRED]
The Exadata hardware system model.
dict
Response Syntax
{
'nextToken': 'string',
'systemVersions': [
{
'giVersion': 'string',
'shape': 'string',
'systemVersions': [
'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.
systemVersions (list) --
The list of system versions.
(dict) --
Information about the compatible system versions that can be used with a specific Exadata shape and Grid Infrastructure (GI) version.
giVersion (string) --
The version of GI software.
shape (string) --
The Exadata hardware model.
systemVersions (list) --
The Exadata system versions that are compatible with the specified Exadata shape and GI version.
(string) --
Starts the specified DB node in a VM cluster.
See also: AWS API Documentation
Request Syntax
client.start_db_node(
cloudVmClusterId='string',
dbNodeId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster that contains the DB node to start.
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.
Applies tags to the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to apply tags to.
dict
[REQUIRED]
The list of tags to apply to the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes the specified Exadata infrastructure. Before you use this operation, make sure to delete all of the VM clusters that are hosted on this Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.delete_cloud_exadata_infrastructure(
cloudExadataInfrastructureId='string'
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the specified database server.
See also: AWS API Documentation
Request Syntax
client.get_db_server(
cloudExadataInfrastructureId='string',
dbServerId='string'
)
string
[REQUIRED]
The unique identifier of the Oracle Exadata infrastructure that contains the database server.
string
[REQUIRED]
The unique identifier of the database server to retrieve information about.
dict
Response Syntax
{
'dbServer': {
'dbServerId': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cpuCoreCount': 123,
'dbNodeStorageSizeInGBs': 123,
'dbServerPatchingDetails': {
'estimatedPatchDuration': 123,
'patchingStatus': 'COMPLETE'|'FAILED'|'MAINTENANCE_IN_PROGRESS'|'SCHEDULED',
'timePatchingEnded': 'string',
'timePatchingStarted': 'string'
},
'displayName': 'string',
'exadataInfrastructureId': 'string',
'ocid': 'string',
'ociResourceAnchorName': 'string',
'maxCpuCount': 123,
'maxDbNodeStorageInGBs': 123,
'maxMemoryInGBs': 123,
'memorySizeInGBs': 123,
'shape': 'string',
'createdAt': datetime(2015, 1, 1),
'vmClusterIds': [
'string',
],
'computeModel': 'ECPU'|'OCPU',
'autonomousVmClusterIds': [
'string',
],
'autonomousVirtualMachineIds': [
'string',
]
}
}
Response Structure
(dict) --
dbServer (dict) --
The details of the requested database server.
dbServerId (string) --
The unique identifier for the database server.
status (string) --
The current status of the database server.
statusReason (string) --
Additional information about the current status of the database server.
cpuCoreCount (integer) --
The number of CPU cores enabled on the database server.
dbNodeStorageSizeInGBs (integer) --
The allocated local node storage in GBs on the database server.
dbServerPatchingDetails (dict) --
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
estimatedPatchDuration (integer) --
Estimated time, in minutes, to patch one database server.
patchingStatus (string) --
The status of the patching operation. Possible values are SCHEDULED, MAINTENANCE_IN_PROGRESS, FAILED, and COMPLETE.
timePatchingEnded (string) --
The time when the patching operation ended.
timePatchingStarted (string) --
The time when the patching operation started.
displayName (string) --
The user-friendly name of the database server.
exadataInfrastructureId (string) --
The ID of the Exadata infrastructure the database server belongs to.
ocid (string) --
The OCID of the database server.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the database server.
maxCpuCount (integer) --
The total number of CPU cores available.
maxDbNodeStorageInGBs (integer) --
The total local node storage available in GBs.
maxMemoryInGBs (integer) --
The total memory available in GBs.
memorySizeInGBs (integer) --
The allocated memory in GBs on the database server.
shape (string) --
The shape of the database server. The shape determines the amount of CPU, storage, and memory resources available.
createdAt (datetime) --
The date and time when the database server was created.
vmClusterIds (list) --
The OCID of the VM clusters that are associated with the database server.
(string) --
computeModel (string) --
The compute model of the database server (ECPU or OCPU).
autonomousVmClusterIds (list) --
The list of identifiers for the Autonomous VM clusters associated with this database server.
(string) --
autonomousVirtualMachineIds (list) --
The list of unique identifiers for the Autonomous VMs associated with this database server.
(string) --
Initializes the ODB service for the first time in an account.
See also: AWS API Documentation
Request Syntax
client.initialize_service()
dict
Response Syntax
{}
Response Structure
(dict) --
Updates properties of a specified ODB network.
See also: AWS API Documentation
Request Syntax
client.update_odb_network(
odbNetworkId='string',
displayName='string',
peeredCidrsToBeAdded=[
'string',
],
peeredCidrsToBeRemoved=[
'string',
],
s3Access='ENABLED'|'DISABLED',
zeroEtlAccess='ENABLED'|'DISABLED',
s3PolicyDocument='string'
)
string
[REQUIRED]
The unique identifier of the ODB network to update.
string
The new user-friendly name of the ODB network.
list
The list of CIDR ranges from the peered VPC that allow access to the ODB network.
(string) --
list
The list of CIDR ranges from the peered VPC to remove from the ODB network.
(string) --
string
Specifies the updated configuration for Amazon S3 access from the ODB network.
string
Specifies the updated configuration for Zero-ETL access from the ODB network.
string
Specifies the updated endpoint policy for Amazon S3 access from the ODB network.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the status of the ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
Returns information about the tags applied to this resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to list tags for.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The list of tags applied to the resource.
(string) --
(string) --
Deletes the specified VM cluster.
See also: AWS API Documentation
Request Syntax
client.delete_cloud_vm_cluster(
cloudVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the Exadata infrastructures owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_cloud_exadata_infrastructures(
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.
Default: 10
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',
'cloudExadataInfrastructures': [
{
'cloudExadataInfrastructureId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureArn': 'string',
'activatedStorageCount': 123,
'additionalStorageCount': 123,
'availableStorageSizeInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'computeCount': 123,
'cpuCount': 123,
'customerContactsToSendToOCI': [
{
'email': 'string'
},
],
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServerVersion': 'string',
'lastMaintenanceRunId': 'string',
'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,
]
},
'maxCpuCount': 123,
'maxDataStorageInTBs': 123.0,
'maxDbNodeStorageSizeInGBs': 123,
'maxMemoryInGBs': 123,
'memorySizeInGBs': 123,
'monthlyDbServerVersion': 'string',
'monthlyStorageServerVersion': 'string',
'nextMaintenanceRunId': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'ocid': 'string',
'shape': 'string',
'storageCount': 123,
'storageServerVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'totalStorageSizeInGBs': 123,
'percentProgress': ...,
'databaseServerType': 'string',
'storageServerType': 'string',
'computeModel': 'ECPU'|'OCPU'
},
]
}
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.
cloudExadataInfrastructures (list) --
The list of Exadata infrastructures along with their properties.
(dict) --
Information about an Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier for the Exadata infrastructure.
displayName (string) --
The user-friendly name for the Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure.
statusReason (string) --
Additional information about the status of the Exadata infrastructure.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) for the Exadata infrastructure.
activatedStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
additionalStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
availableStorageSizeInGBs (integer) --
The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
availabilityZone (string) --
The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the Exadata infrastructure is located.
computeCount (integer) --
The number of database servers for the Exadata infrastructure.
cpuCount (integer) --
The total number of CPU cores that are allocated to the Exadata infrastructure.
customerContactsToSendToOCI (list) --
The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
(dict) --
A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.
email (string) --
The email address of the contact.
dataStorageSizeInTBs (float) --
The size of the Exadata infrastructure's data disk group, in terabytes (TB).
dbNodeStorageSizeInGBs (integer) --
The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
dbServerVersion (string) --
The software version of the database servers on the Exadata infrastructure.
lastMaintenanceRunId (string) --
The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.
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) --
maxCpuCount (integer) --
The total number of CPU cores available on the Exadata infrastructure.
maxDataStorageInTBs (float) --
The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
maxDbNodeStorageSizeInGBs (integer) --
The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
maxMemoryInGBs (integer) --
The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
monthlyDbServerVersion (string) --
The monthly software version of the database servers (dom0) installed on the Exadata infrastructure.
monthlyStorageServerVersion (string) --
The monthly software version of the storage servers installed on the Exadata infrastructure.
nextMaintenanceRunId (string) --
The OCID of the next maintenance run for the Exadata infrastructure.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exadata infrastructure.
ociUrl (string) --
The HTTPS link to the Exadata infrastructure in OCI.
ocid (string) --
The OCID of the Exadata infrastructure.
shape (string) --
The model name of the Exadata infrastructure.
storageCount (integer) --
The number of storage servers that are activated for the Exadata infrastructure.
storageServerVersion (string) --
The software version of the storage servers on the Exadata infrastructure.
createdAt (datetime) --
The date and time when the Exadata infrastructure was created.
totalStorageSizeInGBs (integer) --
The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.
percentProgress (float) --
The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.
databaseServerType (string) --
The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
storageServerType (string) --
The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
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.
Removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to remove tags from.
list
[REQUIRED]
The names (keys) of the tags to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an Autonomous VM cluster.
See also: AWS API Documentation
Request Syntax
client.delete_cloud_autonomous_vm_cluster(
cloudAutonomousVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the Autonomous VM cluster to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Reboots the specified DB node in a VM cluster.
See also: AWS API Documentation
Request Syntax
client.reboot_db_node(
cloudVmClusterId='string',
dbNodeId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster that contains the DB node to reboot.
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.
Creates a peering connection between an ODB network and either another ODB network or a customer-owned VPC.
A peering connection enables private connectivity between the networks for application-tier communication.
See also: AWS API Documentation
Request Syntax
client.create_odb_peering_connection(
odbNetworkId='string',
peerNetworkId='string',
displayName='string',
clientToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the ODB network that initiates the peering connection.
string
[REQUIRED]
The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.
string
The display name for the ODB peering connection.
string
The client token for the ODB peering connection request.
Constraints:
Must be unique for each request.
This field is autopopulated if not provided.
dict
The tags to assign to the ODB peering connection.
(string) --
(string) --
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbPeeringConnectionId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The display name of the ODB peering connection.
status (string) --
The status of the ODB peering connection.
Valid Values: provisioning | active | terminating | terminated | failed
statusReason (string) --
The reason for the current status of the ODB peering connection.
odbPeeringConnectionId (string) --
The unique identifier of the ODB peering connection.
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'
)
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
[REQUIRED]
The unique identifier of the VM cluster.
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.