DataSafeClient

class oci.data_safe.DataSafeClient(config, **kwargs)

APIs for using Oracle Data Safe.

Methods

__init__(config, **kwargs) Creates a new service client
activate_target_database(…) Reactivates a previously deactivated Data Safe target database.
change_data_safe_private_endpoint_compartment(…) Moves the Data Safe private endpoint and its dependent resources to the specified compartment.
change_on_prem_connector_compartment(…) Moves the specified on-premises connector into a different compartment.
change_target_database_compartment(…) Moves the Data Safe target database to the specified compartment.
create_data_safe_private_endpoint(…) Creates a new Data Safe private endpoint.
create_on_prem_connector(…) Creates a new on-premises connector.
create_target_database(…) Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.
deactivate_target_database(…) Deactivates a target database in Data Safe.
delete_data_safe_private_endpoint(…) Deletes the specified Data Safe private endpoint.
delete_on_prem_connector(…) Deletes the specified on-premises connector.
delete_target_database(target_database_id, …) Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.
download_privilege_script(**kwargs) Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.
enable_data_safe_configuration(…) Enables Data Safe in the tenancy and region.
generate_on_prem_connector_configuration(…) Creates and downloads the configuration of the specified on-premises connector.
get_data_safe_configuration(**kwargs) Gets the details of the Data Safe configuration.
get_data_safe_private_endpoint(…) Gets the details of the specified Data Safe private endpoint.
get_on_prem_connector(on_prem_connector_id, …) Gets the details of the specified on-premises connector.
get_target_database(target_database_id, **kwargs) Returns the details of the specified Data Safe target database.
get_work_request(work_request_id, **kwargs) Gets the details of the specified work request.
list_data_safe_private_endpoints(…) Gets a list of Data Safe private endpoints.
list_on_prem_connectors(compartment_id, **kwargs) Gets a list of on-premises connectors.
list_target_databases(compartment_id, **kwargs) Returns the list of registered target databases in Data Safe.
list_work_request_errors(work_request_id, …) Gets a list of errors for the specified work request.
list_work_request_logs(work_request_id, **kwargs) Gets a list of log entries for the specified work request.
list_work_requests(compartment_id, **kwargs) Gets a list of work requests.
update_data_safe_private_endpoint(…) Updates one or more attributes of the specified Data Safe private endpoint.
update_on_prem_connector(…) Updates one or more attributes of the specified on-premises connector.
update_on_prem_connector_wallet(…) Updates the wallet for the specified on-premises connector to a new version.
update_target_database(target_database_id, …) Updates one or more attributes of the specified Data Safe target database.
__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_target_database(activate_target_database_details, target_database_id, **kwargs)

Reactivates a previously deactivated Data Safe target database.

Parameters:
  • activate_target_database_details (oci.data_safe.models.ActivateTargetDatabaseDetails) – (required) The details used to reactivate a target database in Data Safe.
  • target_database_id (str) – (required) The OCID of the Data Safe target 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 might 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.
  • 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

Example:

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

change_data_safe_private_endpoint_compartment(data_safe_private_endpoint_id, change_data_safe_private_endpoint_compartment_details, **kwargs)

Moves the Data Safe private endpoint and its dependent resources to the specified compartment.

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • change_data_safe_private_endpoint_compartment_details (oci.data_safe.models.ChangeDataSafePrivateEndpointCompartmentDetails) – (required) The details used to change the compartment of a Data Safe private endpoint.
  • 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

Example:

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

change_on_prem_connector_compartment(on_prem_connector_id, change_on_prem_connector_compartment_details, **kwargs)

Moves the specified on-premises connector into a different compartment.

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • change_on_prem_connector_compartment_details (oci.data_safe.models.ChangeOnPremConnectorCompartmentDetails) – (required) The details used to change the compartment of an on-premises connector.
  • 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.
  • 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 might 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 None

Return type:

Response

Example:

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

change_target_database_compartment(target_database_id, change_target_database_compartment_details, **kwargs)

Moves the Data Safe target database to the specified compartment.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • change_target_database_compartment_details (oci.data_safe.models.ChangeTargetDatabaseCompartmentDetails) – (required) Details of the move compartment 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.
  • 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 might 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 None

Return type:

Response

Example:

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

create_data_safe_private_endpoint(create_data_safe_private_endpoint_details, **kwargs)

Creates a new Data Safe private endpoint.

Parameters:
  • create_data_safe_private_endpoint_details (oci.data_safe.models.CreateDataSafePrivateEndpointDetails) – (required) Details to create a new private endpoint.
  • 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 might 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 DataSafePrivateEndpoint

Return type:

Response

Example:

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

create_on_prem_connector(create_on_prem_connector_details, **kwargs)

Creates a new on-premises connector.

Parameters:
  • create_on_prem_connector_details (oci.data_safe.models.CreateOnPremConnectorDetails) – (required) The details used to create a new on-premises connector.
  • 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 might 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 OnPremConnector

Return type:

Response

Example:

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

create_target_database(create_target_database_details, **kwargs)

Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.

Parameters:
  • create_target_database_details (oci.data_safe.models.CreateTargetDatabaseDetails) – (required) Details of the target 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 might 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 TargetDatabase

Return type:

Response

Example:

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

deactivate_target_database(target_database_id, **kwargs)

Deactivates a target database in Data Safe.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target 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 might 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.
  • 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

Example:

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

delete_data_safe_private_endpoint(data_safe_private_endpoint_id, **kwargs)

Deletes the specified Data Safe private endpoint.

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • 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

Example:

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

delete_on_prem_connector(on_prem_connector_id, **kwargs)

Deletes the specified on-premises connector.

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • 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

Example:

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

delete_target_database(target_database_id, **kwargs)

Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target 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 None

Return type:

Response

Example:

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

download_privilege_script(**kwargs)

Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

Parameters:
  • 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 might 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 stream

Return type:

Response

Example:

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

enable_data_safe_configuration(enable_data_safe_configuration_details, **kwargs)

Enables Data Safe in the tenancy and region.

Parameters:
  • enable_data_safe_configuration_details (oci.data_safe.models.EnableDataSafeConfigurationDetails) – (required) The details used to enable Data Safe.
  • compartment_id (str) – (optional) A filter to return only resources that match the specified compartment 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

Example:

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

generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, **kwargs)

Creates and downloads the configuration of the specified on-premises connector.

Parameters:
  • generate_on_prem_connector_configuration_details (oci.data_safe.models.GenerateOnPremConnectorConfigurationDetails) – (required) The details used to create and download on-premises connector’s configuration.
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • 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 might 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 stream

Return type:

Response

Example:

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

get_data_safe_configuration(**kwargs)

Gets the details of the Data Safe configuration.

Parameters:
  • compartment_id (str) – (optional) A filter to return only resources that match the specified compartment 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 DataSafeConfiguration

Return type:

Response

Example:

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

get_data_safe_private_endpoint(data_safe_private_endpoint_id, **kwargs)

Gets the details of the specified Data Safe private endpoint.

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • 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 DataSafePrivateEndpoint

Return type:

Response

Example:

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

get_on_prem_connector(on_prem_connector_id, **kwargs)

Gets the details of the specified on-premises connector.

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • 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 OnPremConnector

Return type:

Response

Example:

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

get_target_database(target_database_id, **kwargs)

Returns the details of the specified Data Safe target database.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • 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 TargetDatabase

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

Gets the details of the specified work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • 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 WorkRequest

Return type:

Response

Example:

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

list_data_safe_private_endpoints(compartment_id, **kwargs)

Gets a list of Data Safe private endpoints.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • vcn_id (str) – (optional) A filter to return only resources that match the specified VCN OCID.
  • lifecycle_state (str) –

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

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

  • limit (int) –

    (optional) For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

  • page (str) –

    (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
  • access_level (str) –

    (optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • 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 DataSafePrivateEndpointSummary

Return type:

Response

Example:

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

list_on_prem_connectors(compartment_id, **kwargs)

Gets a list of on-premises connectors.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • on_prem_connector_id (str) – (optional) A filter to return only the on-premises connector that matches the specified id.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • on_prem_connector_lifecycle_state (str) –

    (optional) A filter to return only on-premises connector resources that match the specified lifecycle state.

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

  • limit (int) –

    (optional) For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

  • page (str) –

    (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
  • access_level (str) –

    (optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • 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 OnPremConnectorSummary

Return type:

Response

Example:

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

list_target_databases(compartment_id, **kwargs)

Returns the list of registered target databases in Data Safe.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • target_database_id (str) – (optional) A filter to return the target database that matches the specified OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • lifecycle_state (str) –

    (optional) A filter to return the target databases that matches the current state of the target database.

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

  • database_type (str) –

    (optional) A filter to return target databases that match the database type of the target database.

    Allowed values are: “DATABASE_CLOUD_SERVICE”, “AUTONOMOUS_DATABASE”, “INSTALLED_DATABASE”

  • infrastructure_type (str) –

    (optional) A filter to return target databases that match the infrastructure type of the target database.

    Allowed values are: “ORACLE_CLOUD”, “CLOUD_AT_CUSTOMER”, “ON_PREMISES”, “NON_ORACLE_CLOUD”

  • limit (int) –

    (optional) For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

  • page (str) –

    (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
  • access_level (str) –

    (optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • 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 TargetDatabaseSummary

Return type:

Response

Example:

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

list_work_request_errors(work_request_id, **kwargs)

Gets a list of errors for the specified work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • page (str) –

    (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • limit (int) –

    (optional) For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

  • 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 WorkRequestError

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)

Gets a list of log entries for the specified work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • page (str) –

    (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • limit (int) –

    (optional) For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

  • 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 WorkRequestLogEntry

Return type:

Response

Example:

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

list_work_requests(compartment_id, **kwargs)

Gets a list of work requests.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • operation_type (str) – (optional) A filter to return only work requests that match the specific operation type.
  • resource_id (str) – (optional) A filter to return only work requests that match the specified resource OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • page (str) –

    (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • limit (int) –

    (optional) For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

  • 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 WorkRequestSummary

Return type:

Response

Example:

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

update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, **kwargs)

Updates one or more attributes of the specified Data Safe private endpoint.

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • update_data_safe_private_endpoint_details (oci.data_safe.models.UpdateDataSafePrivateEndpointDetails) – (required) The details used to update a Data Safe private endpoint.
  • 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

Example:

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

update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, **kwargs)

Updates one or more attributes of the specified on-premises connector.

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • update_on_prem_connector_details (oci.data_safe.models.UpdateOnPremConnectorDetails) – (required) The details used to update a on-premises connector.
  • 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

Example:

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

update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, **kwargs)

Updates the wallet for the specified on-premises connector to a new version.

Parameters:
  • update_on_prem_connector_wallet_details (oci.data_safe.models.UpdateOnPremConnectorWalletDetails) – (required) The details used to update an on-premises connector’s wallet.
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • 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 might 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.
  • 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

Example:

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

update_target_database(target_database_id, update_target_database_details, **kwargs)

Updates one or more attributes of the specified Data Safe target database.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • update_target_database_details (oci.data_safe.models.UpdateTargetDatabaseDetails) – (required) Details used to update the target database in Data Safe.
  • 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.
  • 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 might 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 None

Return type:

Response

Example:

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