PostgresqlClient¶

class oci.psql.PostgresqlClient(config, **kwargs)¶

Use the OCI Database with PostgreSQL API to manage resources such as database systems, database nodes, backups, and configurations. For information, see the user guide documentation for the [service](/iaas/Content/postgresql/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_backup_compartment`(backup_id, …)	Moves a backup from one compartment to another.
`change_configuration_compartment`(…)	Moves a configuration from one compartment to another.
`change_db_system_compartment`(db_system_id, …)	Moves a database system from one compartment to another.
`create_backup`(create_backup_details, **kwargs)	Creates a new backup.
`create_configuration`(…)	Creates a new configuration.
`create_db_system`(create_db_system_details, …)	Creates a new database system.
`delete_backup`(backup_id, **kwargs)	Deletes a backup by identifier.
`delete_configuration`(configuration_id, **kwargs)	Deletes a configuration by identifier.
`delete_db_system`(db_system_id, **kwargs)	Deletes a database system by identifier.
`failover_db_system`(db_system_id, …)	Runs a failover operation.
`get_backup`(backup_id, **kwargs)	Gets a backup by identifier.
`get_configuration`(configuration_id, **kwargs)	Gets a configuration by identifier.
`get_connection_details`(db_system_id, **kwargs)	Gets the database system connection details.
`get_db_system`(db_system_id, **kwargs)	Gets a database system by identifier.
`get_default_configuration`(…)	Gets a default configuration by identifier.
`get_primary_db_instance`(db_system_id, **kwargs)	Gets the primary database instance node details.
`get_work_request`(work_request_id, **kwargs)	Gets details of the work request with the given ID.
`list_backups`(**kwargs)	Returns a list of backups.
`list_configurations`(**kwargs)	Returns a list of configurations.
`list_db_systems`(**kwargs)	Returns a list of database systems.
`list_default_configurations`(**kwargs)	Returns a list of default configurations.
`list_shapes`(**kwargs)	Returns the list of shapes allowed in the region.
`list_work_request_errors`(work_request_id, …)	Returns a (paginated) list of errors for the work request with the given ID.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a (paginated) list of logs for the work request with the given ID.
`list_work_requests`(**kwargs)	Lists the work requests in a compartment.
`patch_db_system`(db_system_id, …)	Modifies the database system by adding or removing database instance nodes.
`reset_master_user_password`(db_system_id, …)	Resets the database system’s master password.
`restart_db_instance_in_db_system`(…)	Restarts the running database instance node.
`restore_db_system`(db_system_id, …)	Restore the database system.
`update_backup`(backup_id, …)	Updates the backup.
`update_configuration`(configuration_id, …)	Updates a display name or description of the configuration.
`update_db_system`(db_system_id, …)	Updates the database system.
`update_db_system_db_instance`(db_system_id, …)	Updates the database instance node.

__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.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_backup_compartment(backup_id, change_backup_compartment_details, **kwargs)¶

Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	backup_id (str) – (required) A unique identifier for the backup. change_backup_compartment_details (oci.psql.models.ChangeBackupCompartmentDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_backup_compartment API.

change_configuration_compartment(configuration_id, change_configuration_compartment_details, **kwargs)¶

Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	configuration_id (str) – (required) A unique identifier for the configuration. change_configuration_compartment_details (oci.psql.models.ChangeConfigurationCompartmentDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_configuration_compartment API.

change_db_system_compartment(db_system_id, change_db_system_compartment_details, **kwargs)¶

Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. change_db_system_compartment_details (oci.psql.models.ChangeDbSystemCompartmentDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_db_system_compartment API.

create_backup(create_backup_details, **kwargs)¶

Creates a new backup.

Parameters:	create_backup_details (oci.psql.models.CreateBackupDetails) – (required) Details for the new 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, retrytoken could be expired or invalidated. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_backup API.

create_configuration(create_configuration_details, **kwargs)¶

Creates a new configuration.

Parameters:	create_configuration_details (oci.psql.models.CreateConfigurationDetails) – (required) Details for the new configuration. 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, retrytoken could be expired or invalidated. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Configuration`
Return type:	`Response`
Example:

Click here to see an example of how to use create_configuration API.

create_db_system(create_db_system_details, **kwargs)¶

Creates a new database system.

Parameters:	create_db_system_details (oci.psql.models.CreateDbSystemDetails) – (required) Details for the new database 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, retrytoken could be expired or invalidated. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbSystem`
Return type:	`Response`
Example:

Click here to see an example of how to use create_db_system API.

delete_backup(backup_id, **kwargs)¶

Deletes a backup by identifier.

Parameters:	backup_id (str) – (required) A unique identifier for the backup. 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) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_backup API.

delete_configuration(configuration_id, **kwargs)¶

Deletes a configuration by identifier.

Parameters:	configuration_id (str) – (required) A unique identifier for the configuration. 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) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_configuration API.

delete_db_system(db_system_id, **kwargs)¶

Deletes a database system by identifier.

Parameters:	db_system_id (str) – (required) A unique identifier for the database 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. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_db_system API.

failover_db_system(db_system_id, failover_db_system_details, **kwargs)¶

Runs a failover operation. Optionally, specify the desired AD for regions with three ADs.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. failover_db_system_details (oci.psql.models.FailoverDbSystemDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use failover_db_system API.

get_backup(backup_id, **kwargs)¶

Gets a backup by identifier.

Parameters:	backup_id (str) – (required) A unique identifier for the backup. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Backup`
Return type:	`Response`
Example:

Click here to see an example of how to use get_backup API.

get_configuration(configuration_id, **kwargs)¶

Gets a configuration by identifier.

Parameters:	configuration_id (str) – (required) A unique identifier for the configuration. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Configuration`
Return type:	`Response`
Example:

Click here to see an example of how to use get_configuration API.

get_connection_details(db_system_id, **kwargs)¶

Gets the database system connection details.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use get_connection_details API.

get_db_system(db_system_id, **kwargs)¶

Gets a database system by identifier.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. opc_request_id (str) – (optional) The client request ID for tracing. excluded_fields (list[str]) – (optional) A filter to exclude database configuration when this query parameter is set to OverrideDbConfig. Allowed values are: “dbConfigurationParams” 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbSystem`
Return type:	`Response`
Example:

Click here to see an example of how to use get_db_system API.

get_default_configuration(default_configuration_id, **kwargs)¶

Gets a default configuration by identifier.

Parameters:	default_configuration_id (str) – (required) A unique identifier for the configuration. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DefaultConfiguration`
Return type:	`Response`
Example:

Click here to see an example of how to use get_default_configuration API.

get_primary_db_instance(db_system_id, **kwargs)¶

Gets the primary database instance node details.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PrimaryDbInstanceDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use get_primary_db_instance API.

get_work_request(work_request_id, **kwargs)¶

Gets details of the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

list_backups(**kwargs)¶

Returns a list of backups.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. time_started (datetime) – (optional) The start date for getting backups. An RFC 3339 formatted datetime string. time_ended (datetime) – (optional) The end date for getting backups. An RFC 3339 formatted datetime string. lifecycle_state (str) – (optional) A filter to return only resources if their lifecycleState matches the given lifecycleState. 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. backup_id (str) – (optional) A unique identifier for the backup. id (str) – (optional) A unique identifier for the database system. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BackupCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_backups API.

list_configurations(**kwargs)¶

Returns a list of configurations.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return only resources if their lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. db_version (str) – (optional) Verison of the PostgreSQL database, such as 14.9. shape (str) – (optional) The name of the shape for the configuration. Example: VM.Standard.E4.Flex configuration_id (str) – (optional) A unique identifier for the configuration. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConfigurationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_configurations API.

list_db_systems(**kwargs)¶

Returns a list of database systems.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return only resources if their lifecycleState matches the given lifecycleState. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) A unique identifier for the database system. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbSystemCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_db_systems API.

list_default_configurations(**kwargs)¶

Returns a list of default configurations.

Parameters:	lifecycle_state (str) – (optional) A filter to return only resources if their lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. db_version (str) – (optional) Verison of the PostgreSQL database, such as 14.9. shape (str) – (optional) The name of the shape for the configuration. Example: VM.Standard.E4.Flex configuration_id (str) – (optional) A unique identifier for the configuration. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DefaultConfigurationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_default_configurations API.

list_shapes(**kwargs)¶

Returns the list of shapes allowed in the region.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. id (str) – (optional) A filter to return the feature by the shape name. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ShapeCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_shapes API.

list_work_request_errors(work_request_id, **kwargs)¶

Returns a (paginated) list of errors for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: “timestamp” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

Returns a (paginated) list of logs for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: “timestamp” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(**kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. work_request_id (str) – (optional) The ID of the asynchronous work request. status (str) – (optional) A filter to return only resources if their lifecycleState matches the given OperationStatus. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” resource_id (str) – (optional) The ID of the resource affected by the request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: “timeAccepted” 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestSummaryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

patch_db_system(db_system_id, patch_db_system_details, **kwargs)¶

Modifies the database system by adding or removing database instance nodes.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. patch_db_system_details (oci.psql.models.PatchDbSystemDetails) – (required) The information to be modified. 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) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use patch_db_system API.

reset_master_user_password(db_system_id, reset_master_user_password_details, **kwargs)¶

Resets the database system’s master password.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. reset_master_user_password_details (oci.psql.models.ResetMasterUserPasswordDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use reset_master_user_password API.

restart_db_instance_in_db_system(db_system_id, restart_db_instance_in_db_system_details, **kwargs)¶

Restarts the running database instance node.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. restart_db_instance_in_db_system_details (oci.psql.models.RestartDbInstanceInDbSystemDetails) – (required) Database instance node restart parameters. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use restart_db_instance_in_db_system API.

restore_db_system(db_system_id, restore_db_system_details, **kwargs)¶

Restore the database system.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. restore_db_system_details (oci.psql.models.RestoreDbSystemDetails) – (required) Database system restore parameters. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use restore_db_system API.

update_backup(backup_id, update_backup_details, **kwargs)¶

Updates the backup.

Parameters:	backup_id (str) – (required) A unique identifier for the backup. update_backup_details (oci.psql.models.UpdateBackupDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Backup`
Return type:	`Response`
Example:

Click here to see an example of how to use update_backup API.

update_configuration(configuration_id, update_configuration_details, **kwargs)¶

Updates a display name or description of the configuration.

Parameters:	configuration_id (str) – (required) A unique identifier for the configuration. update_configuration_details (oci.psql.models.UpdateConfigurationDetails) – (required) Details for updating display name or description for a configuration. 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, retrytoken could be expired or invalidated. 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) The client request ID for tracing. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Configuration`
Return type:	`Response`
Example:

Click here to see an example of how to use update_configuration API.

update_db_system(db_system_id, update_db_system_details, **kwargs)¶

Updates the database system.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. update_db_system_details (oci.psql.models.UpdateDbSystemDetails) – (required) The information to be updated. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_db_system API.

update_db_system_db_instance(db_system_id, db_instance_id, update_db_system_db_instance_details, **kwargs)¶

Updates the database instance node.

Parameters:	db_system_id (str) – (required) A unique identifier for the database system. db_instance_id (str) – (required) A unique identifier for the database instance node. update_db_system_db_instance_details (oci.psql.models.UpdateDbSystemDbInstanceDetails) – (required) Database instance node update parameters. 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) The client request ID for tracing. 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, retrytoken could be expired or invalidated. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_db_system_db_instance API.