DatabaseClient

class oci.database.DatabaseClient(config, **kwargs)

The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](/iaas/Content/Database/Concepts/databaseoverview.htm).

Methods

__init__(config, **kwargs) Creates a new service client
activate_exadata_infrastructure(…) Activates the specified Exadata infrastructure.
autonomous_database_manual_refresh(…) Initiates a data refresh for an Autonomous Database refreshable clone.
change_autonomous_container_database_compartment(…) Move the Autonomous Container Database and its dependent resources to the specified compartment.
change_autonomous_database_compartment(…) Move the Autonomous Database and its dependent resources to the specified compartment.
change_autonomous_exadata_infrastructure_compartment(…) Move the Autonomous Exadata Infrastructure and its dependent resources to the specified compartment.
change_autonomous_vm_cluster_compartment(…) To move an Autonomous VM cluster and its dependent resources to another compartment, use the change_autonomous_vm_cluster_compartment() operation.
change_backup_destination_compartment(…) Move the backup destination and its dependent resources to the specified compartment.
change_database_software_image_compartment(…) Move the Database Software Image and its dependent resources to the specified compartment.
change_db_system_compartment(…) Move the DB system and its dependent resources to the specified compartment.
change_exadata_infrastructure_compartment(…) To move an Exadata infrastructure and its dependent resources to another compartment, use the change_exadata_infrastructure_compartment() operation.
change_vm_cluster_compartment(…) To move a VM cluster and its dependent resources to another compartment, use the change_vm_cluster_compartment() operation.
complete_external_backup_job(backup_id, …) Changes the status of the standalone backup resource to ACTIVE after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.
create_autonomous_container_database(…) Create a new Autonomous Container Database in the specified Autonomous Exadata Infrastructure.
create_autonomous_data_warehouse(…) Deprecated. To create a new Autonomous Data Warehouse, use the create_autonomous_database() operation and specify DW as the workload type.
create_autonomous_data_warehouse_backup(…) Deprecated. To create a new Autonomous Data Warehouse backup for a specified database, use the create_autonomous_database_backup() operation.
create_autonomous_database(…) Creates a new Autonomous Database.
create_autonomous_database_backup(…) Creates a new Autonomous Database backup for the specified database based on the provided request parameters.
create_autonomous_vm_cluster(…) Creates an Autonomous VM cluster.
create_backup(create_backup_details, **kwargs) Creates a new backup in the specified database based on the request parameters you provide.
create_backup_destination(…) Creates a backup destination.
create_console_connection(…) Creates a new console connection to the specified dbNode.
create_data_guard_association(database_id, …) Creates a new Data Guard association.
create_database(create_new_database_details, …) Creates a new database in the specified Database Home.
create_database_software_image(…) create database software image in the specified compartment.
create_db_home(…) Creates a new Database Home in the specified DB system based on the request parameters you provide.
create_exadata_infrastructure(…) Create Exadata infrastructure.
create_external_backup_job(…) Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.
create_vm_cluster(create_vm_cluster_details, …) Creates a VM cluster.
create_vm_cluster_network(…) Creates the VM cluster network.
db_node_action(db_node_id, action, **kwargs) Performs one of the following power actions on the specified DB node:
delete_autonomous_data_warehouse(…) Deprecated. To delete an Autonomous Data Warehouse, use the delete_autonomous_database() operation.
delete_autonomous_database(…) Deletes the specified Autonomous Database.
delete_autonomous_vm_cluster(…) Deletes the specified Autonomous VM cluster.
delete_backup(backup_id, **kwargs) Deletes a full backup.
delete_backup_destination(…) Deletes a backup destination.
delete_console_connection(db_node_id, …) Deletes the specified Db node console connection.
delete_database(database_id, **kwargs) Deletes the database.
delete_database_software_image(…) Delete a database software image
delete_db_home(db_home_id, **kwargs) Deletes a Database Home.
delete_exadata_infrastructure(…) Deletes the Exadata infrastructure.
delete_vm_cluster(vm_cluster_id, **kwargs) Deletes the specified VM cluster.
delete_vm_cluster_network(…) Deletes the specified VM cluster network.
deregister_autonomous_database_data_safe(…) Asynchronously deregisters this Autonomous Database with Data Safe.
download_exadata_infrastructure_config_file(…) Downloads the configuration file for the specified Exadata infrastructure.
download_vm_cluster_network_config_file(…) Downloads the configuration file for the specified VM Cluster Network.
fail_over_autonomous_database(…) Initiates a failover the specified Autonomous Database to a standby.
failover_data_guard_association(database_id, …) Performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association’s primary role after the existing primary database fails or becomes unreachable.
generate_autonomous_data_warehouse_wallet(…) Deprecated. To create and download a wallet for an Autonomous Data Warehouse, use the generate_autonomous_database_wallet() operation.
generate_autonomous_database_wallet(…) Creates and downloads a wallet for the specified Autonomous Database.
generate_recommended_vm_cluster_network(…) Generates a recommended VM cluster network configuration.
get_autonomous_container_database(…) Gets information about the specified Autonomous Container Database.
get_autonomous_data_warehouse(…) Deprecated. To get the details of an Autonomous Data Warehouse, use the get_autonomous_database() operation.
get_autonomous_data_warehouse_backup(…) Deprecated. To get information about a specified Autonomous Data Warehouse backup, use the get_autonomous_database_backup() operation.
get_autonomous_database(…) Gets the details of the specified Autonomous Database.
get_autonomous_database_backup(…) Gets information about the specified Autonomous Database backup.
get_autonomous_database_regional_wallet(**kwargs) Gets the Autonomous Database regional wallet details.
get_autonomous_database_wallet(…) Gets the wallet details for the specified Autonomous Database.
get_autonomous_exadata_infrastructure(…) Gets information about the specified Autonomous Exadata Infrastructure.
get_autonomous_patch(autonomous_patch_id, …) Gets information about the specified Autonomous Patch.
get_autonomous_vm_cluster(…) Gets information about the specified Autonomous VM cluster.
get_backup(backup_id, **kwargs) Gets information about the specified backup.
get_backup_destination(…) Gets information about the specified backup destination.
get_console_connection(db_node_id, …) Gets the specified Db node console connection’s information.
get_data_guard_association(database_id, …) Gets the specified Data Guard association’s configuration information.
get_database(database_id, **kwargs) Gets information about a specific database.
get_database_software_image(…) Gets information about the specified database software image.
get_db_home(db_home_id, **kwargs) Gets information about the specified Database Home.
get_db_home_patch(db_home_id, patch_id, **kwargs) Gets information about a specified patch package.
get_db_home_patch_history_entry(db_home_id, …) Gets the patch history details for the specified patchHistoryEntryId
get_db_node(db_node_id, **kwargs) Gets information about the specified database node.
get_db_system(db_system_id, **kwargs) Gets information about the specified DB system.
get_db_system_patch(db_system_id, patch_id, …) Gets information about a specified patch package.
get_db_system_patch_history_entry(…) Gets the patch history details for the specified patchHistoryEntryId.
get_exadata_infrastructure(…) Gets information about the specified Exadata infrastructure.
get_exadata_infrastructure_ocpus(…) Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure instance.
get_exadata_iorm_config(db_system_id, **kwargs) Gets IORM Setting for the requested Exadata DB System.
get_external_backup_job(backup_id, **kwargs) Gets information about the specified external backup job.
get_maintenance_run(maintenance_run_id, **kwargs) Gets information about the specified maintenance run.
get_vm_cluster(vm_cluster_id, **kwargs) Gets information about the specified VM cluster.
get_vm_cluster_network(…) Gets information about the specified VM cluster network.
get_vm_cluster_patch(vm_cluster_id, …) Gets information about a specified patch package.
get_vm_cluster_patch_history_entry(…) Gets the patch history details for the specified patchHistoryEntryId.
launch_autonomous_exadata_infrastructure(…) Launches a new Autonomous Exadata Infrastructure in the specified compartment and availability domain.
launch_db_system(launch_db_system_details, …) Creates a new DB system in the specified compartment and availability domain.
list_autonomous_container_databases(…) Gets a list of the Autonomous Container Databases in the specified compartment.
list_autonomous_data_warehouse_backups(**kwargs) Deprecated. To get a list of Autonomous Data Warehouse backups, use the list_autonomous_database_backups() operation.
list_autonomous_data_warehouses(…) Deprecated. To get a list of Autonomous Data Warehouses, use the list_autonomous_databases() operation and specify DW as the workload type.
list_autonomous_database_backups(**kwargs) Gets a list of Autonomous Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.
list_autonomous_database_clones(…) Gets a list of the Autonomous Database clones for the specified Autonomous Database.
list_autonomous_databases(compartment_id, …) Gets a list of Autonomous Databases.
list_autonomous_db_preview_versions(…) Gets a list of supported Autonomous Database versions.
list_autonomous_db_versions(compartment_id, …) Gets a list of supported Autonomous Database versions.
list_autonomous_exadata_infrastructure_shapes(…) Gets a list of the shapes that can be used to launch a new Autonomous Exadata Infrastructure DB system.
list_autonomous_exadata_infrastructures(…) Gets a list of the Autonomous Exadata Infrastructures in the specified compartment.
list_autonomous_vm_clusters(compartment_id, …) Gets a list of Autonomous VM clusters in the specified compartment.
list_backup_destination(compartment_id, **kwargs) Gets a list of backup destinations in the specified compartment.
list_backups(**kwargs) Gets a list of backups based on the databaseId or compartmentId specified.
list_console_connections(db_node_id, **kwargs) Lists the console connections for the specified Db node.
list_container_database_patches(…) Lists the patches applicable to the requested container database.
list_data_guard_associations(database_id, …) Lists all Data Guard associations for the specified database.
list_database_software_images(…) Gets a list of the database software images in the specified compartment.
list_databases(compartment_id, **kwargs) Gets a list of the databases in the specified Database Home.
list_db_home_patch_history_entries(…) Gets history of the actions taken for patches for the specified Database Home.
list_db_home_patches(db_home_id, **kwargs) Lists patches applicable to the requested Database Home.
list_db_homes(compartment_id, **kwargs) Gets a list of Database Homes in the specified DB system and compartment.
list_db_nodes(compartment_id, **kwargs) Gets a list of database nodes in the specified DB system and compartment.
list_db_system_patch_history_entries(…) Gets the history of the patch actions performed on the specified DB system.
list_db_system_patches(db_system_id, **kwargs) Lists the patches applicable to the requested DB system.
list_db_system_shapes(compartment_id, **kwargs) Gets a list of the shapes that can be used to launch a new DB system.
list_db_systems(compartment_id, **kwargs) Gets a list of the DB systems in the specified compartment.
list_db_versions(compartment_id, **kwargs) Gets a list of supported Oracle Database versions.
list_exadata_infrastructures(compartment_id, …) Gets a list of the Exadata infrastructure in the specified compartment.
list_gi_versions(compartment_id, **kwargs) Gets a list of supported GI versions for VM Cluster.
list_maintenance_runs(compartment_id, **kwargs) Gets a list of the maintenance runs in the specified compartment.
list_vm_cluster_networks(…) Gets a list of the VM cluster networks in the specified compartment.
list_vm_cluster_patch_history_entries(…) Gets the history of the patch actions performed on the specified Vm cluster.
list_vm_cluster_patches(vm_cluster_id, **kwargs) Lists the patches applicable to the requested Vm cluster.
list_vm_clusters(compartment_id, **kwargs) Gets a list of the VM clusters in the specified compartment.
register_autonomous_database_data_safe(…) Asynchronously registers this Autonomous Database with Data Safe.
reinstate_data_guard_association(…) Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.
restart_autonomous_container_database(…) Rolling restarts the specified Autonomous Container Database.
restart_autonomous_database(…) Restarts the specified Autonomous Database.
restore_autonomous_data_warehouse(…) Deprecated. To restore an Autonomous Data Warehouse, use the restore_autonomous_database() operation.
restore_autonomous_database(…) Restores an Autonomous Database based on the provided request parameters.
restore_database(database_id, …) Restore a Database based on the request parameters you provide.
start_autonomous_data_warehouse(…) Deprecated. To start an Autonomous Data Warehouse, use the start_autonomous_database() operation.
start_autonomous_database(…) Starts the specified Autonomous Database.
stop_autonomous_data_warehouse(…) Deprecated. To stop an Autonomous Data Warehouse, use the stop_autonomous_database() operation.
stop_autonomous_database(…) Stops the specified Autonomous Database.
switchover_autonomous_database(…) Initiates a switchover of the specified Autonomous Database to the associated standby database.
switchover_data_guard_association(…) Performs a switchover to transition the primary database of a Data Guard association into a standby role.
terminate_autonomous_container_database(…) Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database.
terminate_autonomous_exadata_infrastructure(…) Terminates an Autonomous Exadata Infrastructure, which permanently deletes the Exadata Infrastructure and any container databases and databases contained in the Exadata Infrastructure.
terminate_db_system(db_system_id, **kwargs) Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it.
update_autonomous_container_database(…) Updates the properties of an Autonomous Container Database, such as the OCPU core count and storage size.
update_autonomous_data_warehouse(…) Deprecated. To update the CPU core count and storage size of an Autonomous Data Warehouse, use the update_autonomous_database() operation.
update_autonomous_database(…) Updates one or more attributes of the specified Autonomous Database.
update_autonomous_database_regional_wallet(…) Updates the Autonomous Database regional wallet.
update_autonomous_database_wallet(…) Updates the wallet for the specified Autonomous Database.
update_autonomous_exadata_infrastructure(…) Updates the properties of an Autonomous Exadata Infrastructure, such as the CPU core count.
update_autonomous_vm_cluster(…) Updates the specified Autonomous VM cluster.
update_backup_destination(…) If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users.
update_database(database_id, …) Update a Database based on the request parameters you provide.
update_database_software_image(…) Updates the properties of a Database Software Image, like Display Nmae
update_db_home(db_home_id, …) Patches the specified dbHome.
update_db_system(db_system_id, …) Updates the properties of a DB system, such as the CPU core count.
update_exadata_infrastructure(…) Updates the Exadata infrastructure.
update_exadata_iorm_config(db_system_id, …) Update IORM Settings for the requested Exadata DB System.
update_maintenance_run(maintenance_run_id, …) Updates the properties of a maintenance run, such as the state of a maintenance run.
update_vm_cluster(vm_cluster_id, …) Updates the specified VM cluster.
update_vm_cluster_network(…) Updates the specified VM cluster network.
validate_vm_cluster_network(…) Validates the specified VM cluster network.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

activate_exadata_infrastructure(exadata_infrastructure_id, activate_exadata_infrastructure_details, **kwargs)

Activates the specified Exadata infrastructure.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • activate_exadata_infrastructure_details (ActivateExadataInfrastructureDetails) – (required) The activation details for the Exadata infrastructure.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

autonomous_database_manual_refresh(autonomous_database_id, autonomous_database_manual_refresh_details, **kwargs)

Initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • autonomous_database_manual_refresh_details (AutonomousDatabaseManualRefreshDetails) – (required) Request details for manually refreshing an Autonomous Database refreshable clone.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

change_autonomous_container_database_compartment(change_compartment_details, autonomous_container_database_id, **kwargs)

Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see Moving Database Resources to a Different Compartment.

Parameters:
  • change_compartment_details (ChangeCompartmentDetails) – (required) Request to move Autonomous Container Database to a different compartment
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_autonomous_database_compartment(change_compartment_details, autonomous_database_id, **kwargs)

Move the Autonomous Database and its dependent resources to the specified compartment. For more information about moving Autonomous Databases, see Moving Database Resources to a Different Compartment.

Parameters:
  • change_compartment_details (ChangeCompartmentDetails) – (required) Request to move Autonomous Database to a different compartment
  • autonomous_database_id (str) –

    (required) The database OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_autonomous_exadata_infrastructure_compartment(change_compartment_details, autonomous_exadata_infrastructure_id, **kwargs)

Move the Autonomous Exadata Infrastructure and its dependent resources to the specified compartment. For more information about moving Autonomous Exadata Infrastructures, see Moving Database Resources to a Different Compartment.

Parameters:
  • change_compartment_details (ChangeCompartmentDetails) – (required) Request to move Autonomous Exadata Infrastructure to a different compartment
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous Exadata Infrastructure OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_autonomous_vm_cluster_compartment(change_autonomous_vm_cluster_compartment_details, autonomous_vm_cluster_id, **kwargs)

To move an Autonomous VM cluster and its dependent resources to another compartment, use the change_autonomous_vm_cluster_compartment() operation.

Parameters:
  • change_autonomous_vm_cluster_compartment_details (ChangeAutonomousVmClusterCompartmentDetails) – (required) Request to move Autonomous VM cluster to a different compartment
  • autonomous_vm_cluster_id (str) –

    (required) The autonomous VM cluster OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_backup_destination_compartment(change_compartment_details, backup_destination_id, **kwargs)

Move the backup destination and its dependent resources to the specified compartment. For more information about moving backup destinations, see Moving Database Resources to a Different Compartment.

Parameters:
  • change_compartment_details (ChangeCompartmentDetails) – (required) Request to move backup destination to a different compartment
  • backup_destination_id (str) –

    (required) The OCID of the backup destination.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_database_software_image_compartment(change_compartment_details, database_software_image_id, **kwargs)

Move the Database Software Image and its dependent resources to the specified compartment. For more information about moving Databse Software Images, see Moving Database Resources to a Different Compartment.

Parameters:
  • change_compartment_details (ChangeCompartmentDetails) – (required) Request to move Database Software Image to a different compartment
  • database_software_image_id (str) –

    (required) The DB system OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_db_system_compartment(change_compartment_details, db_system_id, **kwargs)

Move the DB system and its dependent resources to the specified compartment. For more information about moving DB systems, see Moving Database Resources to a Different Compartment.

Parameters:
  • change_compartment_details (ChangeCompartmentDetails) – (required) Request to move Db System to a different compartment
  • db_system_id (str) –

    (required) The DB system OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_exadata_infrastructure_compartment(change_exadata_infrastructure_compartment_details, exadata_infrastructure_id, **kwargs)

To move an Exadata infrastructure and its dependent resources to another compartment, use the change_exadata_infrastructure_compartment() operation.

Parameters:
  • change_exadata_infrastructure_compartment_details (ChangeExadataInfrastructureCompartmentDetails) – (required) Request to move Exadata infrastructure to a different compartment
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_vm_cluster_compartment(change_vm_cluster_compartment_details, vm_cluster_id, **kwargs)

To move a VM cluster and its dependent resources to another compartment, use the change_vm_cluster_compartment() operation.

Parameters:
  • change_vm_cluster_compartment_details (ChangeVmClusterCompartmentDetails) – (required) Request to move VM cluster to a different compartment
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

complete_external_backup_job(backup_id, complete_external_backup_job_details, **kwargs)

Changes the status of the standalone backup resource to ACTIVE after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Parameters:
  • backup_id (str) –

    (required) The backup OCID.

  • complete_external_backup_job_details (CompleteExternalBackupJobDetails) – (required) Updates the status of the backup resource.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalBackupJob

Return type:

Response

create_autonomous_container_database(create_autonomous_container_database_details, **kwargs)

Create a new Autonomous Container Database in the specified Autonomous Exadata Infrastructure.

Parameters:
  • create_autonomous_container_database_details (CreateAutonomousContainerDatabaseDetails) – (required) Request to create an Autonomous Container Database in a specified Autonomous Exadata Infrastructure.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

create_autonomous_data_warehouse(create_autonomous_data_warehouse_details, **kwargs)

Deprecated. To create a new Autonomous Data Warehouse, use the create_autonomous_database() operation and specify DW as the workload type.

Parameters:
  • create_autonomous_data_warehouse_details (CreateAutonomousDataWarehouseDetails) – (required) Request to create a new Autonomous Data Warehouse.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouse

Return type:

Response

create_autonomous_data_warehouse_backup(create_autonomous_data_warehouse_backup_details, **kwargs)

Deprecated. To create a new Autonomous Data Warehouse backup for a specified database, use the create_autonomous_database_backup() operation.

Parameters:
  • create_autonomous_data_warehouse_backup_details (CreateAutonomousDataWarehouseBackupDetails) – (required) Request to create a new Autonomous Data Warehouse backup.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouseBackup

Return type:

Response

create_autonomous_database(create_autonomous_database_details, **kwargs)

Creates a new Autonomous Database.

Parameters:
  • create_autonomous_database_details (CreateAutonomousDatabaseBase) – (required) Request to create a new Autonomous Database.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

create_autonomous_database_backup(create_autonomous_database_backup_details, **kwargs)

Creates a new Autonomous Database backup for the specified database based on the provided request parameters.

Parameters:
  • create_autonomous_database_backup_details (CreateAutonomousDatabaseBackupDetails) – (required) Request to create a new Autonomous Database backup.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseBackup

Return type:

Response

create_autonomous_vm_cluster(create_autonomous_vm_cluster_details, **kwargs)

Creates an Autonomous VM cluster.

Parameters:
  • create_autonomous_vm_cluster_details (CreateAutonomousVmClusterDetails) – (required) Request to create an Autonomous VM cluster.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousVmCluster

Return type:

Response

create_backup(create_backup_details, **kwargs)

Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

Parameters:
  • create_backup_details (CreateBackupDetails) – (required) Request to create a new database backup.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Backup

Return type:

Response

create_backup_destination(create_backup_destination_details, **kwargs)

Creates a backup destination.

Parameters:
  • create_backup_destination_details (CreateBackupDestinationDetails) – (required) Request to create a new backup destination.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BackupDestination

Return type:

Response

create_console_connection(create_console_connection_details, db_node_id, **kwargs)

Creates a new console connection to the specified dbNode. After the console connection has been created and is available, you connect to the console using SSH.

Parameters:
  • create_console_connection_details (CreateConsoleConnectionDetails) – (required) Request object for creating an CreateConsoleConnection
  • db_node_id (str) –

    (required) The database node OCID.

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleConnection

Return type:

Response

create_data_guard_association(database_id, create_data_guard_association_details, **kwargs)

Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see Using Oracle Data Guard.

All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • create_data_guard_association_details (CreateDataGuardAssociationDetails) – (required) A request to create a Data Guard association.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

create_database(create_new_database_details, **kwargs)

Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata DB systems and Exadata Cloud at Customer.

Parameters:
  • create_new_database_details (CreateDatabaseBase) – (required) Request to create a new database.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

create_database_software_image(create_database_software_image_details, **kwargs)

create database software image in the specified compartment.

Parameters:
  • create_database_software_image_details (CreateDatabaseSoftwareImageDetails) – (required) Request to create database software image.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DatabaseSoftwareImage

Return type:

Response

create_db_home(create_db_home_with_db_system_id_details, **kwargs)

Creates a new Database Home in the specified DB system based on the request parameters you provide. Applies to bare metal DB systems, Exadata DB systems, and Exadata Cloud at Customer systems.

Parameters:
  • create_db_home_with_db_system_id_details (CreateDbHomeBase) – (required) Request to create a new Database Home.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbHome

Return type:

Response

create_exadata_infrastructure(create_exadata_infrastructure_details, **kwargs)

Create Exadata infrastructure.

Parameters:
  • create_exadata_infrastructure_details (CreateExadataInfrastructureDetails) – (required) Request to create Exadata infrastructure.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

create_external_backup_job(create_external_backup_job_details, **kwargs)

Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Parameters:
  • create_external_backup_job_details (CreateExternalBackupJobDetails) – (required) Request to create a cloud backup resource for a database running outside the cloud.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalBackupJob

Return type:

Response

create_vm_cluster(create_vm_cluster_details, **kwargs)

Creates a VM cluster.

Parameters:
  • create_vm_cluster_details (CreateVmClusterDetails) – (required) Request to create a VM cluster.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmCluster

Return type:

Response

create_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_details, **kwargs)

Creates the VM cluster network.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • vm_cluster_network_details (VmClusterNetworkDetails) – (required) Request to create the VM cluster network.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetwork

Return type:

Response

db_node_action(db_node_id, action, **kwargs)

Performs one of the following power actions on the specified DB node: - start - power on - stop - power off - softreset - ACPI shutdown and power on - reset - power off and power on

Note: Stopping a node affects billing differently, depending on the type of DB system: Bare metal and Exadata DB systems - The _stop_ state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system (terminate_db_system()) to remove its resources from billing and quotas. Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.

Parameters:
  • db_node_id (str) –

    (required) The database node OCID.

  • action (str) –

    (required) The action to perform on the DB Node.

    Allowed values are: “STOP”, “START”, “SOFTRESET”, “RESET”

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbNode

Return type:

Response

delete_autonomous_data_warehouse(autonomous_data_warehouse_id, **kwargs)

Deprecated. To delete an Autonomous Data Warehouse, use the delete_autonomous_database() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_autonomous_database(autonomous_database_id, **kwargs)

Deletes the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_autonomous_vm_cluster(autonomous_vm_cluster_id, **kwargs)

Deletes the specified Autonomous VM cluster.

Parameters:
  • autonomous_vm_cluster_id (str) –

    (required) The autonomous VM cluster OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_backup(backup_id, **kwargs)

Deletes a full backup. You cannot delete automatic backups using this API.

Parameters:
  • backup_id (str) –

    (required) The backup OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_backup_destination(backup_destination_id, **kwargs)

Deletes a backup destination.

Parameters:
  • backup_destination_id (str) –

    (required) The OCID of the backup destination.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_console_connection(db_node_id, console_connection_id, **kwargs)

Deletes the specified Db node console connection.

Parameters:
  • db_node_id (str) –

    (required) The database node OCID.

  • console_connection_id (str) – (required) The OCID of the console connection.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_database(database_id, **kwargs)

Deletes the database. Applies only to Exadata DB systems.

The data in this database is local to the DB system and will be lost when the database is deleted. Oracle recommends that you back up any data in the DB system prior to deleting it. You can use the performFinalBackup parameter to have the Exadata DB system database backed up before it is deleted.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • perform_final_backup (bool) –

    (optional) Whether to perform a final backup of the database or not. Default is false.

    If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

    This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_database_software_image(database_software_image_id, **kwargs)

Delete a database software image

Parameters:
  • database_software_image_id (str) –

    (required) The DB system OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_db_home(db_home_id, **kwargs)

Deletes a Database Home. Applies to bare metal DB systems, Exadata DB systems, and Exadata Cloud at Customer systems.

Oracle recommends that you use the performFinalBackup parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud at Customer system or an Exadata DB system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the performFinalBackup parameter to back up data.

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • perform_final_backup (bool) –

    (optional) Whether to perform a final backup of the database or not. Default is false.

    If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

    This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_exadata_infrastructure(exadata_infrastructure_id, **kwargs)

Deletes the Exadata infrastructure.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_vm_cluster(vm_cluster_id, **kwargs)

Deletes the specified VM cluster.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)

Deletes the specified VM cluster network.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • vm_cluster_network_id (str) –

    (required) The VM cluster network OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

deregister_autonomous_database_data_safe(autonomous_database_id, **kwargs)

Asynchronously deregisters this Autonomous Database with Data Safe.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • deregister_autonomous_database_data_safe_details (DeregisterAutonomousDatabaseDataSafeDetails) – (optional) Details for deregistering an Autonomous Database with Data Safe.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

download_exadata_infrastructure_config_file(exadata_infrastructure_id, **kwargs)

Downloads the configuration file for the specified Exadata infrastructure.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

download_vm_cluster_network_config_file(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)

Downloads the configuration file for the specified VM Cluster Network.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • vm_cluster_network_id (str) –

    (required) The VM cluster network OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

fail_over_autonomous_database(autonomous_database_id, **kwargs)

Initiates a failover the specified Autonomous Database to a standby.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

failover_data_guard_association(database_id, data_guard_association_id, failover_data_guard_association_details, **kwargs)

Performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association’s primary role after the existing primary database fails or becomes unreachable.

A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s OCID.

  • failover_data_guard_association_details (FailoverDataGuardAssociationDetails) – (required) A request to perform a failover, transitioning a standby database into a primary database.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

generate_autonomous_data_warehouse_wallet(autonomous_data_warehouse_id, generate_autonomous_data_warehouse_wallet_details, **kwargs)

Deprecated. To create and download a wallet for an Autonomous Data Warehouse, use the generate_autonomous_database_wallet() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • generate_autonomous_data_warehouse_wallet_details (GenerateAutonomousDataWarehouseWalletDetails) – (required) Request to create a new Autonomous Data Warehouse wallet.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

generate_autonomous_database_wallet(autonomous_database_id, generate_autonomous_database_wallet_details, **kwargs)

Creates and downloads a wallet for the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • generate_autonomous_database_wallet_details (GenerateAutonomousDatabaseWalletDetails) – (required) Request to create a new Autonomous Database wallet.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Generates a recommended VM cluster network configuration.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • generate_recommended_network_details (GenerateRecommendedNetworkDetails) – (required) Request to generate a recommended VM cluster network configuration.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetworkDetails

Return type:

Response

get_autonomous_container_database(autonomous_container_database_id, **kwargs)

Gets information about the specified Autonomous Container Database.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

get_autonomous_data_warehouse(autonomous_data_warehouse_id, **kwargs)

Deprecated. To get the details of an Autonomous Data Warehouse, use the get_autonomous_database() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouse

Return type:

Response

get_autonomous_data_warehouse_backup(autonomous_data_warehouse_backup_id, **kwargs)

Deprecated. To get information about a specified Autonomous Data Warehouse backup, use the get_autonomous_database_backup() operation.

Parameters:
  • autonomous_data_warehouse_backup_id (str) –

    (required) The OCID of the Autonomous Data Warehouse backup.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouseBackup

Return type:

Response

get_autonomous_database(autonomous_database_id, **kwargs)

Gets the details of the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

get_autonomous_database_backup(autonomous_database_backup_id, **kwargs)

Gets information about the specified Autonomous Database backup.

Parameters:
  • autonomous_database_backup_id (str) –

    (required) The OCID of the Autonomous Database backup.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseBackup

Return type:

Response

get_autonomous_database_regional_wallet(**kwargs)

Gets the Autonomous Database regional wallet details.

Parameters:
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseWallet

Return type:

Response

get_autonomous_database_wallet(autonomous_database_id, **kwargs)

Gets the wallet details for the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseWallet

Return type:

Response

get_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, **kwargs)

Gets information about the specified Autonomous Exadata Infrastructure.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous Exadata Infrastructure OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousExadataInfrastructure

Return type:

Response

get_autonomous_patch(autonomous_patch_id, **kwargs)

Gets information about the specified Autonomous Patch.

Parameters:
  • autonomous_patch_id (str) –

    (required) The Autonomous Patch OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousPatch

Return type:

Response

get_autonomous_vm_cluster(autonomous_vm_cluster_id, **kwargs)

Gets information about the specified Autonomous VM cluster.

Parameters:
  • autonomous_vm_cluster_id (str) –

    (required) The autonomous VM cluster OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousVmCluster

Return type:

Response

get_backup(backup_id, **kwargs)

Gets information about the specified backup.

Parameters:
  • backup_id (str) –

    (required) The backup OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Backup

Return type:

Response

get_backup_destination(backup_destination_id, **kwargs)

Gets information about the specified backup destination.

Parameters:
  • backup_destination_id (str) –

    (required) The OCID of the backup destination.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BackupDestination

Return type:

Response

get_console_connection(db_node_id, console_connection_id, **kwargs)

Gets the specified Db node console connection’s information.

Parameters:
  • db_node_id (str) –

    (required) The database node OCID.

  • console_connection_id (str) – (required) The OCID of the console connection.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleConnection

Return type:

Response

get_data_guard_association(database_id, data_guard_association_id, **kwargs)

Gets the specified Data Guard association’s configuration information.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

get_database(database_id, **kwargs)

Gets information about a specific database.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

get_database_software_image(database_software_image_id, **kwargs)

Gets information about the specified database software image.

Parameters:
  • database_software_image_id (str) –

    (required) The DB system OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DatabaseSoftwareImage

Return type:

Response

get_db_home(db_home_id, **kwargs)

Gets information about the specified Database Home.

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbHome

Return type:

Response

get_db_home_patch(db_home_id, patch_id, **kwargs)

Gets information about a specified patch package.

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • patch_id (str) –

    (required) The OCID of the patch.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

get_db_home_patch_history_entry(db_home_id, patch_history_entry_id, **kwargs)

Gets the patch history details for the specified patchHistoryEntryId

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • patch_history_entry_id (str) –

    (required) The OCID of the patch history entry.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchHistoryEntry

Return type:

Response

get_db_node(db_node_id, **kwargs)

Gets information about the specified database node.

Parameters:
  • db_node_id (str) –

    (required) The database node OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbNode

Return type:

Response

get_db_system(db_system_id, **kwargs)

Gets information about the specified DB system.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbSystem

Return type:

Response

get_db_system_patch(db_system_id, patch_id, **kwargs)

Gets information about a specified patch package.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • patch_id (str) –

    (required) The OCID of the patch.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

get_db_system_patch_history_entry(db_system_id, patch_history_entry_id, **kwargs)

Gets the patch history details for the specified patchHistoryEntryId.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • patch_history_entry_id (str) –

    (required) The OCID of the patch history entry.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchHistoryEntry

Return type:

Response

get_exadata_infrastructure(exadata_infrastructure_id, **kwargs)

Gets information about the specified Exadata infrastructure.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

get_exadata_infrastructure_ocpus(autonomous_exadata_infrastructure_id, **kwargs)

Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure instance.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous Exadata Infrastructure OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type OCPUs

Return type:

Response

get_exadata_iorm_config(db_system_id, **kwargs)

Gets IORM Setting for the requested Exadata DB System. The default IORM Settings is pre-created in all the Exadata DB System.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataIormConfig

Return type:

Response

get_external_backup_job(backup_id, **kwargs)

Gets information about the specified external backup job.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Parameters:
  • backup_id (str) –

    (required) The backup OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalBackupJob

Return type:

Response

get_maintenance_run(maintenance_run_id, **kwargs)

Gets information about the specified maintenance run.

Parameters:
  • maintenance_run_id (str) – (required) The maintenance run OCID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MaintenanceRun

Return type:

Response

get_vm_cluster(vm_cluster_id, **kwargs)

Gets information about the specified VM cluster.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmCluster

Return type:

Response

get_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)

Gets information about the specified VM cluster network.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • vm_cluster_network_id (str) –

    (required) The VM cluster network OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetwork

Return type:

Response

get_vm_cluster_patch(vm_cluster_id, patch_id, **kwargs)

Gets information about a specified patch package.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • patch_id (str) –

    (required) The OCID of the patch.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

get_vm_cluster_patch_history_entry(vm_cluster_id, patch_history_entry_id, **kwargs)

Gets the patch history details for the specified patchHistoryEntryId.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • patch_history_entry_id (str) –

    (required) The OCID of the patch history entry.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchHistoryEntry

Return type:

Response

launch_autonomous_exadata_infrastructure(launch_autonomous_exadata_infrastructure_details, **kwargs)

Launches a new Autonomous Exadata Infrastructure in the specified compartment and availability domain.

Parameters:
  • launch_autonomous_exadata_infrastructure_details (LaunchAutonomousExadataInfrastructureDetails) – (required) Request to launch a Autonomous Exadata Infrastructure.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousExadataInfrastructure

Return type:

Response

launch_db_system(launch_db_system_details, **kwargs)

Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.

An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see the following:

Parameters:
  • launch_db_system_details (LaunchDbSystemBase) – (required) Request to launch a DB system.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbSystem

Return type:

Response

list_autonomous_container_databases(compartment_id, **kwargs)

Gets a list of the Autonomous Container Databases in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • autonomous_exadata_infrastructure_id (str) –

    (optional) The Autonomous Exadata Infrastructure OCID.

  • autonomous_vm_cluster_id (str) –

    (optional) The Autonomous VM Cluster OCID.

  • infrastructure_type (str) –

    (optional) A filter to return only resources that match the given Infrastructure Type.

    Allowed values are: “CLOUD”, “CLOUD_AT_CUSTOMER”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “BACKUP_IN_PROGRESS”, “RESTORING”, “RESTORE_FAILED”, “RESTARTING”, “MAINTENANCE_IN_PROGRESS”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousContainerDatabaseSummary

Return type:

Response

list_autonomous_data_warehouse_backups(**kwargs)

Deprecated. To get a list of Autonomous Data Warehouse backups, use the list_autonomous_database_backups() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (optional) The database OCID.

  • compartment_id (str) –

    (optional) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDataWarehouseBackupSummary

Return type:

Response

list_autonomous_data_warehouses(compartment_id, **kwargs)

Deprecated. To get a list of Autonomous Data Warehouses, use the list_autonomous_databases() operation and specify DW as the workload type.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “UNAVAILABLE”, “RESTORE_IN_PROGRESS”, “BACKUP_IN_PROGRESS”, “SCALE_IN_PROGRESS”, “AVAILABLE_NEEDS_ATTENTION”, “UPDATING”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDataWarehouseSummary

Return type:

Response

list_autonomous_database_backups(**kwargs)

Gets a list of Autonomous Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.

Parameters:
  • autonomous_database_id (str) –

    (optional) The database OCID.

  • compartment_id (str) –

    (optional) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseBackupSummary

Return type:

Response

list_autonomous_database_clones(compartment_id, autonomous_database_id, **kwargs)

Gets a list of the Autonomous Database clones for the specified Autonomous Database.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • autonomous_database_id (str) –

    (required) The database OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “UNAVAILABLE”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “SCALE_IN_PROGRESS”, “AVAILABLE_NEEDS_ATTENTION”, “UPDATING”, “MAINTENANCE_IN_PROGRESS”, “RESTARTING”, “RECREATING”, “ROLE_CHANGE_IN_PROGRESS”, “UPGRADING”

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “NONE”, “TIMECREATED”, “DISPLAYNAME”

  • clone_type (str) –

    (optional) A filter to return only resources that match the given clone type exactly.

    Allowed values are: “REFRESHABLE_CLONE”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseSummary

Return type:

Response

list_autonomous_databases(compartment_id, **kwargs)

Gets a list of Autonomous Databases.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • autonomous_container_database_id (str) –

    (optional) The Autonomous Container Database OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • infrastructure_type (str) –

    (optional) A filter to return only resources that match the given Infrastructure Type.

    Allowed values are: “CLOUD”, “CLOUD_AT_CUSTOMER”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “UNAVAILABLE”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “SCALE_IN_PROGRESS”, “AVAILABLE_NEEDS_ATTENTION”, “UPDATING”, “MAINTENANCE_IN_PROGRESS”, “RESTARTING”, “RECREATING”, “ROLE_CHANGE_IN_PROGRESS”, “UPGRADING”

  • db_workload (str) –

    (optional) A filter to return only autonomous database resources that match the specified workload type.

    Allowed values are: “OLTP”, “DW”, “AJD”

  • db_version (str) – (optional) A filter to return only autonomous database resources that match the specified dbVersion.
  • is_free_tier (bool) – (optional) Filter on the value of the resource’s ‘isFreeTier’ property. A value of true returns only Always Free resources. A value of false excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • is_refreshable_clone (bool) – (optional) Filter on the value of the resource’s ‘isRefreshableClone’ property. A value of true returns only refreshable clones. A value of false excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.
  • is_data_guard_enabled (bool) – (optional) A filter to return only resources that have Data Guard enabled.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseSummary

Return type:

Response

list_autonomous_db_preview_versions(compartment_id, **kwargs)

Gets a list of supported Autonomous Database versions. Note that preview version software is only available for databases with shared Exadata infrastructure.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for DBWORKLOAD is ascending.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “DBWORKLOAD”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDbPreviewVersionSummary

Return type:

Response

list_autonomous_db_versions(compartment_id, **kwargs)

Gets a list of supported Autonomous Database versions.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • db_workload (str) –

    (optional) A filter to return only autonomous database resources that match the specified workload type.

    Allowed values are: “OLTP”, “DW”, “AJD”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDbVersionSummary

Return type:

Response

list_autonomous_exadata_infrastructure_shapes(availability_domain, compartment_id, **kwargs)

Gets a list of the shapes that can be used to launch a new Autonomous Exadata Infrastructure DB system. The shape determines resources to allocate to the DB system (CPU cores, memory and storage).

Parameters:
  • availability_domain (str) – (required) The name of the Availability Domain.
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousExadataInfrastructureShapeSummary

Return type:

Response

list_autonomous_exadata_infrastructures(compartment_id, **kwargs)

Gets a list of the Autonomous Exadata Infrastructures in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousExadataInfrastructureSummary

Return type:

Response

list_autonomous_vm_clusters(compartment_id, **kwargs)

Gets a list of Autonomous VM clusters in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • exadata_infrastructure_id (str) – (optional) If provided, filters the results for the given Exadata Infrastructure.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousVmClusterSummary

Return type:

Response

list_backup_destination(compartment_id, **kwargs)

Gets a list of backup destinations in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • type (str) – (optional) A filter to return only resources that match the given type of the Backup Destination.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of BackupDestinationSummary

Return type:

Response

list_backups(**kwargs)

Gets a list of backups based on the databaseId or compartmentId specified. Either one of the query parameters must be provided.

Parameters:
  • database_id (str) –

    (optional) The OCID of the database.

  • compartment_id (str) –

    (optional) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of BackupSummary

Return type:

Response

list_console_connections(db_node_id, **kwargs)

Lists the console connections for the specified Db node.

Parameters:
  • db_node_id (str) –

    (required) The database node OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ConsoleConnectionSummary

Return type:

Response

list_container_database_patches(autonomous_container_database_id, compartment_id, **kwargs)

Lists the patches applicable to the requested container database.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database OCID.

  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousPatchSummary

Return type:

Response

list_data_guard_associations(database_id, **kwargs)

Lists all Data Guard associations for the specified database.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DataGuardAssociationSummary

Return type:

Response

list_database_software_images(compartment_id, **kwargs)

Gets a list of the database software images in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • image_type (str) –

    (optional) A filter to return only resources that match the given image type exactly.

    Allowed values are: “GRID_IMAGE”, “DATABASE_IMAGE”

  • image_shape_family (str) –

    (optional) A filter to return only resources that match the given image shape family exactly.

    Allowed values are: “VM_BM_SHAPE”, “EXADATA_SHAPE”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DatabaseSoftwareImageSummary

Return type:

Response

list_databases(compartment_id, **kwargs)

Gets a list of the databases in the specified Database Home.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • db_home_id (str) –

    (optional) A Database Home OCID.

  • system_id (str) –

    (optional) The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive.

    Allowed values are: “DBNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “BACKUP_IN_PROGRESS”, “TERMINATING”, “TERMINATED”, “RESTORE_FAILED”, “FAILED”

  • db_name (str) – (optional) A filter to return only resources that match the entire database name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DatabaseSummary

Return type:

Response

list_db_home_patch_history_entries(db_home_id, **kwargs)

Gets history of the actions taken for patches for the specified Database Home.

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchHistoryEntrySummary

Return type:

Response

list_db_home_patches(db_home_id, **kwargs)

Lists patches applicable to the requested Database Home.

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchSummary

Return type:

Response

list_db_homes(compartment_id, **kwargs)

Gets a list of Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • db_system_id (str) –

    (optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • vm_cluster_id (str) –

    (optional) The OCID of the VM cluster.

  • backup_id (str) –

    (optional) The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbHomeSummary

Return type:

Response

list_db_nodes(compartment_id, **kwargs)

Gets a list of database nodes in the specified DB system and compartment. A database node is a server running database software.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • db_system_id (str) –

    (optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • vm_cluster_id (str) –

    (optional) The OCID of the VM cluster.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) Sort by TIMECREATED. Default order for TIMECREATED is descending.

    Allowed values are: “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbNodeSummary

Return type:

Response

list_db_system_patch_history_entries(db_system_id, **kwargs)

Gets the history of the patch actions performed on the specified DB system.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchHistoryEntrySummary

Return type:

Response

list_db_system_patches(db_system_id, **kwargs)

Lists the patches applicable to the requested DB system.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchSummary

Return type:

Response

list_db_system_shapes(compartment_id, **kwargs)

Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • availability_domain (str) – (optional) The name of the Availability Domain.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbSystemShapeSummary

Return type:

Response

list_db_systems(compartment_id, **kwargs)

Gets a list of the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • backup_id (str) –

    (optional) The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbSystemSummary

Return type:

Response

list_db_versions(compartment_id, **kwargs)

Gets a list of supported Oracle Database versions.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • db_system_shape (str) – (optional) If provided, filters the results to the set of database versions which are supported for the given shape.
  • db_system_id (str) –

    (optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • storage_management (str) –

    (optional) The DB system storage management option. Used to list database versions available for that storage manager. Valid values are: * ASM - Automatic storage management * LVM - Logical volume management

    Allowed values are: “ASM”, “LVM”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbVersionSummary

Return type:

Response

list_exadata_infrastructures(compartment_id, **kwargs)

Gets a list of the Exadata infrastructure in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “REQUIRES_ACTIVATION”, “ACTIVATING”, “ACTIVE”, “ACTIVATION_FAILED”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, “DISCONNECTED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExadataInfrastructureSummary

Return type:

Response

list_gi_versions(compartment_id, **kwargs)

Gets a list of supported GI versions for VM Cluster.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • shape (str) – (optional) If provided, filters the results for the given shape.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of GiVersionSummary

Return type:

Response

list_maintenance_runs(compartment_id, **kwargs)

Gets a list of the maintenance runs in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • target_resource_id (str) – (optional) The target resource ID.
  • target_resource_type (str) –

    (optional) The type of the target resource.

    Allowed values are: “AUTONOMOUS_EXADATA_INFRASTRUCTURE”, “AUTONOMOUS_CONTAINER_DATABASE”, “EXADATA_DB_SYSTEM”

  • maintenance_type (str) –

    (optional) The maintenance type.

    Allowed values are: “PLANNED”, “UNPLANNED”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIME_SCHEDULED”, “TIME_ENDED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “SCHEDULED”, “IN_PROGRESS”, “SUCCEEDED”, “SKIPPED”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of MaintenanceRunSummary

Return type:

Response

list_vm_cluster_networks(exadata_infrastructure_id, compartment_id, **kwargs)

Gets a list of the VM cluster networks in the specified compartment.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • compartment_id (str) –

    (required) The compartment OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “REQUIRES_VALIDATION”, “VALIDATING”, “VALIDATED”, “VALIDATION_FAILED”, “UPDATING”, “ALLOCATED”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VmClusterNetworkSummary

Return type:

Response

list_vm_cluster_patch_history_entries(vm_cluster_id, **kwargs)

Gets the history of the patch actions performed on the specified Vm cluster.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchHistoryEntrySummary

Return type:

Response

list_vm_cluster_patches(vm_cluster_id, **kwargs)

Lists the patches applicable to the requested Vm cluster.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchSummary

Return type:

Response

list_vm_clusters(compartment_id, **kwargs)

Gets a list of the VM clusters in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment OCID.

  • exadata_infrastructure_id (str) – (optional) If provided, filters the results for the given Exadata Infrastructure.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VmClusterSummary

Return type:

Response

register_autonomous_database_data_safe(autonomous_database_id, **kwargs)

Asynchronously registers this Autonomous Database with Data Safe.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • register_autonomous_database_data_safe_details (RegisterAutonomousDatabaseDataSafeDetails) – (optional) Request to register an Autonomous Database with Data Safe.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

reinstate_data_guard_association(database_id, data_guard_association_id, reinstate_data_guard_association_details, **kwargs)

Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s OCID.

  • reinstate_data_guard_association_details (ReinstateDataGuardAssociationDetails) – (required) A request to reinstate a database in a standby role.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

restart_autonomous_container_database(autonomous_container_database_id, **kwargs)

Rolling restarts the specified Autonomous Container Database.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

restart_autonomous_database(autonomous_database_id, **kwargs)

Restarts the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

restore_autonomous_data_warehouse(autonomous_data_warehouse_id, restore_autonomous_data_warehouse_details, **kwargs)

Deprecated. To restore an Autonomous Data Warehouse, use the restore_autonomous_database() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • restore_autonomous_data_warehouse_details (RestoreAutonomousDataWarehouseDetails) – (required) Request to perform an Autonomous Data Warehouse restore.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouse

Return type:

Response

restore_autonomous_database(autonomous_database_id, restore_autonomous_database_details, **kwargs)

Restores an Autonomous Database based on the provided request parameters.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • restore_autonomous_database_details (RestoreAutonomousDatabaseDetails) – (required) Request to perform an Autonomous Database restore.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

restore_database(database_id, restore_database_details, **kwargs)

Restore a Database based on the request parameters you provide.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • restore_database_details (RestoreDatabaseDetails) – (required) Request to perform database restore.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

start_autonomous_data_warehouse(autonomous_data_warehouse_id, **kwargs)

Deprecated. To start an Autonomous Data Warehouse, use the start_autonomous_database() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouse

Return type:

Response

start_autonomous_database(autonomous_database_id, **kwargs)

Starts the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

stop_autonomous_data_warehouse(autonomous_data_warehouse_id, **kwargs)

Deprecated. To stop an Autonomous Data Warehouse, use the stop_autonomous_database() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouse

Return type:

Response

stop_autonomous_database(autonomous_database_id, **kwargs)

Stops the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

switchover_autonomous_database(autonomous_database_id, **kwargs)

Initiates a switchover of the specified Autonomous Database to the associated standby database. Applicable only to databases with Autonomous Data Guard enabled.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

switchover_data_guard_association(database_id, data_guard_association_id, switchover_data_guard_association_details, **kwargs)

Performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the dataGuardAssociationId assumes the primary database role.

A switchover guarantees no data loss.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s OCID.

  • switchover_data_guard_association_details (SwitchoverDataGuardAssociationDetails) – (required) Request to swtichover a primary to a standby.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

terminate_autonomous_container_database(autonomous_container_database_id, **kwargs)

Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

terminate_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, **kwargs)

Terminates an Autonomous Exadata Infrastructure, which permanently deletes the Exadata Infrastructure and any container databases and databases contained in the Exadata Infrastructure. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the system is terminated. Oracle recommends that you back up any data in the Autonomous Exadata Infrastructure prior to terminating it.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous Exadata Infrastructure OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

terminate_db_system(db_system_id, **kwargs)

Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

update_autonomous_container_database(autonomous_container_database_id, update_autonomous_container_database_details, **kwargs)

Updates the properties of an Autonomous Container Database, such as the OCPU core count and storage size.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database OCID.

  • update_autonomous_container_database_details (UpdateAutonomousContainerDatabaseDetails) – (required) Request to update the properties of an Autonomous Container Database.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

update_autonomous_data_warehouse(autonomous_data_warehouse_id, update_autonomous_data_warehouse_details, **kwargs)

Deprecated. To update the CPU core count and storage size of an Autonomous Data Warehouse, use the update_autonomous_database() operation.

Parameters:
  • autonomous_data_warehouse_id (str) –

    (required) The database OCID.

  • update_autonomous_data_warehouse_details (UpdateAutonomousDataWarehouseDetails) – (required) Request to update the properties of an Autonomous Data Warehouse.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDataWarehouse

Return type:

Response

update_autonomous_database(autonomous_database_id, update_autonomous_database_details, **kwargs)

Updates one or more attributes of the specified Autonomous Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • update_autonomous_database_details (UpdateAutonomousDatabaseDetails) – (required) Request to update the properties of an Autonomous Database.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

update_autonomous_database_regional_wallet(update_autonomous_database_wallet_details, **kwargs)

Updates the Autonomous Database regional wallet.

Parameters:
  • update_autonomous_database_wallet_details (UpdateAutonomousDatabaseWalletDetails) – (required) Request to update the properties of Autonomous Database regional wallet.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

update_autonomous_database_wallet(autonomous_database_id, update_autonomous_database_wallet_details, **kwargs)

Updates the wallet for the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database OCID.

  • update_autonomous_database_wallet_details (UpdateAutonomousDatabaseWalletDetails) – (required) Request to update the properties of an Autonomous Database wallet.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

update_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, update_autonomous_exadata_infrastructures_details, **kwargs)

Updates the properties of an Autonomous Exadata Infrastructure, such as the CPU core count.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous Exadata Infrastructure OCID.

  • update_autonomous_exadata_infrastructures_details (UpdateAutonomousExadataInfrastructureDetails) – (required) Request to update the properties of a Autonomous Exadata Infrastructure.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousExadataInfrastructure

Return type:

Response

update_autonomous_vm_cluster(autonomous_vm_cluster_id, update_autonomous_vm_cluster_details, **kwargs)

Updates the specified Autonomous VM cluster.

Parameters:
  • autonomous_vm_cluster_id (str) –

    (required) The autonomous VM cluster OCID.

  • update_autonomous_vm_cluster_details (UpdateAutonomousVmClusterDetails) – (required) Request to update the attributes of an Autonomous VM cluster.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousVmCluster

Return type:

Response

update_backup_destination(backup_destination_id, update_backup_destination_details, **kwargs)

If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. - For an NFS backup destination, updates the NFS location.

Parameters:
  • backup_destination_id (str) –

    (required) The OCID of the backup destination.

  • update_backup_destination_details (UpdateBackupDestinationDetails) – (required) For a RECOVERY_APPLIANCE backup destination, request to update the connection string and/or the list of VPC users. For an NFS backup destination, request to update the NFS location.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BackupDestination

Return type:

Response

update_database(database_id, update_database_details, **kwargs)

Update a Database based on the request parameters you provide.

Parameters:
  • database_id (str) –

    (required) The database OCID.

  • update_database_details (UpdateDatabaseDetails) – (required) Request to perform database update.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

update_database_software_image(database_software_image_id, update_database_software_image_details, **kwargs)

Updates the properties of a Database Software Image, like Display Nmae

Parameters:
  • database_software_image_id (str) –

    (required) The DB system OCID.

  • update_database_software_image_details (UpdateDatabaseSoftwareImageDetails) – (required) Request to update the properties of a DB system.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DatabaseSoftwareImage

Return type:

Response

update_db_home(db_home_id, update_db_home_details, **kwargs)

Patches the specified dbHome.

Parameters:
  • db_home_id (str) –

    (required) The Database Home OCID.

  • update_db_home_details (UpdateDbHomeDetails) – (required) Request to update the properties of a DB Home.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbHome

Return type:

Response

update_db_system(db_system_id, update_db_system_details, **kwargs)

Updates the properties of a DB system, such as the CPU core count.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • update_db_system_details (UpdateDbSystemDetails) – (required) Request to update the properties of a DB system.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbSystem

Return type:

Response

update_exadata_infrastructure(exadata_infrastructure_id, update_exadata_infrastructure_details, **kwargs)

Updates the Exadata infrastructure.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • update_exadata_infrastructure_details (UpdateExadataInfrastructureDetails) – (required) Request to update the properties of an Exadata infrastructure
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

update_exadata_iorm_config(db_system_id, exadata_iorm_config_update_details, **kwargs)

Update IORM Settings for the requested Exadata DB System.

Parameters:
  • db_system_id (str) –

    (required) The DB system OCID.

  • exadata_iorm_config_update_details (ExadataIormConfigUpdateDetails) – (required) Request to perform database update.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataIormConfig

Return type:

Response

update_maintenance_run(maintenance_run_id, update_maintenance_run_details, **kwargs)

Updates the properties of a maintenance run, such as the state of a maintenance run.

Parameters:
  • maintenance_run_id (str) – (required) The maintenance run OCID.
  • update_maintenance_run_details (UpdateMaintenanceRunDetails) – (required) Request to update the properties of a maintenance run.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MaintenanceRun

Return type:

Response

update_vm_cluster(vm_cluster_id, update_vm_cluster_details, **kwargs)

Updates the specified VM cluster.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster OCID.

  • update_vm_cluster_details (UpdateVmClusterDetails) – (required) Request to update the attributes of a VM cluster.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmCluster

Return type:

Response

update_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, update_vm_cluster_network_details, **kwargs)

Updates the specified VM cluster network.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • vm_cluster_network_id (str) –

    (required) The VM cluster network OCID.

  • update_vm_cluster_network_details (UpdateVmClusterNetworkDetails) – (required) Request to update the properties of a VM cluster network.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetwork

Return type:

Response

validate_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)

Validates the specified VM cluster network.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure OCID.

  • vm_cluster_network_id (str) –

    (required) The VM cluster network OCID.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetwork

Return type:

Response