CloudGuardClient¶

class oci.cloud_guard.CloudGuardClient(config, **kwargs)¶

Use the Cloud Guard and Security Zones API to automate processes that you would otherwise perform through the Cloud Guard Console or the Security Zones Console. For more information on these services, see the [Cloud Guard](/iaas/cloud-guard/home.htm) and [Security Zones](/iaas/security-zone/home.htm) documentation.

Note: For Cloud Guard, you can perform Create, Update, and Delete operations only from the reporting region of your Cloud Guard tenancy. You can perform Read operations from any region.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_compartment`(security_zone_id, …)	Add an existing compartment to a security zone.
`cancel_work_request`(work_request_id, **kwargs)	Cancels the work request with the given ID.
`change_data_source_compartment`(…)	Moves the DataSource from current compartment to another.
`change_detector_recipe_compartment`(…)	Moves the detector recipe (DetectorRecipe object), identified by detectorRecipeId, from the current compartment to another compartment.
`change_managed_list_compartment`(…)	Moves the managed list (ManagedList object), identified by managedListId, from the current compartment to another compartment.
`change_responder_recipe_compartment`(…)	Moves the ResponderRecipe from current compartment to another.
`change_security_recipe_compartment`(…)	Moves a security zone recipe to a different compartment.
`change_security_zone_compartment`(…)	Moves a security zone to a different compartment.
`create_data_mask_rule`(…)	Creates a new DataMaskRule object definition.
`create_data_source`(…)	Creates a DataSource
`create_detector_recipe`(…)	Creates a new DetectorRecipe object.
`create_detector_recipe_detector_rule`(…)	Create the DetectorRule
`create_managed_list`(…)	Creates a new ManagedList object.
`create_responder_recipe`(…)	Create a ResponderRecipe.
`create_security_recipe`(…)	Creates a security zone recipe.
`create_security_zone`(…)	Creates a security zone for a compartment.
`create_target`(create_target_details, **kwargs)	Creates a new Target
`create_target_detector_recipe`(target_id, …)	Attach a DetectorRecipe with the Target
`create_target_responder_recipe`(target_id, …)	Attach a ResponderRecipe with the Target
`delete_data_mask_rule`(data_mask_rule_id, …)	Deletes a DataMaskRule object, identified by dataMaskRuleId.
`delete_data_source`(data_source_id, **kwargs)	Deletes a DataSource identified by dataSourceId
`delete_detector_recipe`(detector_recipe_id, …)	Deletes a detector recipe (DetectorRecipe object) identified by detectorRecipeId.
`delete_detector_recipe_detector_rule`(…)	Deletes DetectorRecipeDetectorRule
`delete_detector_recipe_detector_rule_data_source`(…)	Delete the DetectorRecipeDetectorRuleDataSource resource by identifier
`delete_managed_list`(managed_list_id, **kwargs)	Deletes a managed list identified by managedListId.
`delete_responder_recipe`(responder_recipe_id, …)	Delete the ResponderRecipe resource by identifier
`delete_security_recipe`(security_recipe_id, …)	Deletes a security zone recipe.
`delete_security_zone`(security_zone_id, **kwargs)	Deletes an existing security zone with a given identifier.
`delete_target`(target_id, **kwargs)	Deletes a Target identified by targetId
`delete_target_detector_recipe`(target_id, …)	Delete the TargetDetectorRecipe resource by identifier
`delete_target_responder_recipe`(target_id, …)	Delete the TargetResponderRecipe resource by identifier
`execute_responder_execution`(…)	Executes the responder execution.
`get_condition_metadata_type`(…)	Returns a ConditionMetatDataType object with its details.
`get_configuration`(compartment_id, **kwargs)	Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.
`get_data_mask_rule`(data_mask_rule_id, **kwargs)	Returns a DataMaskRule object, identified by DataMaskRuleId.
`get_data_source`(data_source_id, **kwargs)	Returns a DataSource identified by dataSourceId
`get_detector`(detector_id, **kwargs)	Returns a Detector object, identified by detectorId.
`get_detector_recipe`(detector_recipe_id, **kwargs)	Returns a detector recipe (DetectorRecipe object) identified by detectorRecipeId.
`get_detector_recipe_detector_rule`(…)	Returns a detector rule (DetectorRule object) identified by detectorRuleId.
`get_detector_rule`(detector_id, …)	Returns a detector rule (DetectorRule object) identified by detectorRuleId.
`get_managed_list`(managed_list_id, **kwargs)	Returns a managed list identified by managedListId.
`get_problem`(problem_id, **kwargs)	Returns the Problem object identified by a problemId.
`get_resource_profile`(resource_profile_id, …)	Returns resource profile details
`get_responder_execution`(…)	Returns a Responder Execution identified by responderExecutionId
`get_responder_recipe`(responder_recipe_id, …)	Get a ResponderRecipe by identifier
`get_responder_recipe_responder_rule`(…)	Get ResponderRule by identifier
`get_responder_rule`(responder_rule_id, **kwargs)	Get a ResponderRule by identifier
`get_security_policy`(security_policy_id, **kwargs)	Gets a security zone policy using its identifier.
`get_security_recipe`(security_recipe_id, **kwargs)	Gets a security zone recipe by identifier.
`get_security_zone`(security_zone_id, **kwargs)	Gets a security zone by its identifier.
`get_sighting`(sighting_id, **kwargs)	Returns Sighting details
`get_target`(target_id, **kwargs)	Returns a Target identified by targetId
`get_target_detector_recipe`(target_id, …)	Get a TargetDetectorRecipe by identifier
`get_target_detector_recipe_detector_rule`(…)	Get DetectorRule by identifier
`get_target_responder_recipe`(target_id, …)	Get a TargetResponderRecipe by identifier
`get_target_responder_recipe_responder_rule`(…)	Get ResponderRule by identifier
`get_work_request`(work_request_id, **kwargs)	Gets details of the work request with the given ID.
`list_condition_metadata_types`(…)	Returns a list of ConditionMetadataType objects.
`list_data_mask_rules`(compartment_id, **kwargs)	Returns a list of all DataMaskRule objects in the specified compartmentId (OCID) and its subcompartments.
`list_data_source_events`(data_source_id, **kwargs)	Returns a list of events from CloudGuard DataSource
`list_data_sources`(compartment_id, **kwargs)	Returns a list of all Data Sources in a compartment
`list_detector_recipe_detector_rules`(…)	Returns a list of detector rules (DetectorRule objects) for a detector recipe (DetectorRecipe object), identified by detectorRecipeId.
`list_detector_recipes`(compartment_id, **kwargs)	Returns a list of all detector recipes (DetectorRecipe objects) in a compartment, identified by compartmentId.
`list_detector_rules`(detector_id, …)	Returns a list of detector rules for the DetectorRecipe object identified by detectorId.
`list_detectors`(compartment_id, **kwargs)	Returns a detector catalog (DetectorCollection object) with a list of DetectorSummary objects.
`list_impacted_resources`(problem_id, **kwargs)	Returns a list of impacted resources for a Cloud Guard problem with a specified problem ID.
`list_managed_list_types`(compartment_id, **kwargs)	Returns all managed list types (listType parameter) that Cloud Guard supports.
`list_managed_lists`(compartment_id, **kwargs)	Returns a list of all ManagedList objects in a compartment, identified by compartmentId.
`list_policies`(compartment_id, **kwargs)	Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.
`list_problem_endpoints`(problem_id, **kwargs)	Returns a list of endpoints associated with a problem, identified by problemId.
`list_problem_entities`(problem_id, **kwargs)	Returns a list of entities for a CloudGuard Problem
`list_problem_histories`(compartment_id, …)	Returns a list of actions taken on a Cloud Guard problem.
`list_problems`(compartment_id, **kwargs)	Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.
`list_recommendations`(compartment_id, **kwargs)	Returns a list of all Recommendations.
`list_resource_profile_endpoints`(…)	Returns a list of endpoints for Cloud Guard resource profile
`list_resource_profile_impacted_resources`(…)	Returns a list of impacted resources for Cloud Guard resource profile
`list_resource_profiles`(compartment_id, **kwargs)	Returns a list of all resource profiles identified by the Cloud Guard The ListResourceProfiles operation returns only resource profiles that match the passed filters.
`list_resource_types`(compartment_id, **kwargs)	Returns a list of resource types.
`list_responder_activities`(problem_id, **kwargs)	Returns a list of Responder activities done on CloudGuard Problem
`list_responder_executions`(compartment_id, …)	Returns a list of Responder Executions.
`list_responder_recipe_responder_rules`(…)	Returns a list of ResponderRule associated with ResponderRecipe.
`list_responder_recipes`(compartment_id, **kwargs)	Returns a list of all ResponderRecipes in a compartment The ListResponderRecipe operation returns only the targets in compartmentId passed.
`list_responder_rules`(compartment_id, **kwargs)	Returns a list of ResponderRule.
`list_security_policies`(compartment_id, **kwargs)	Returns a list of security zone policies.
`list_security_recipes`(compartment_id, **kwargs)	Gets a list of all security zone recipes in a compartment.
`list_security_zones`(compartment_id, **kwargs)	Gets a list of all security zones in a compartment.
`list_sighting_endpoints`(sighting_id, **kwargs)	Returns Sighting endpoints details
`list_sighting_impacted_resources`(…)	Return a list of Impacted Resources for a CloudGuard Sighting
`list_sightings`(compartment_id, **kwargs)	Returns a list of all Sightings identified by the Cloud Guard The ListSightings operation returns only sightings that match the passed filters.
`list_tactics`(compartment_id, **kwargs)	Returns a list of tactics associated with detector rules.
`list_target_detector_recipe_detector_rules`(…)	Returns a list of DetectorRule associated with DetectorRecipe within a Target.
`list_target_detector_recipes`(target_id, …)	Returns a list of all detector recipes associated with the target identified by targetId
`list_target_responder_recipe_responder_rules`(…)	Returns a list of ResponderRule associated with ResponderRecipe within a Target.
`list_target_responder_recipes`(target_id, …)	Returns a list of all responder recipes associated with the target identified by targetId
`list_targets`(compartment_id, **kwargs)	Returns a list of all Targets in a compartment The ListTargets operation returns only the targets in compartmentId passed.
`list_techniques`(compartment_id, **kwargs)	Returns a list of techniques associated with detector rules.
`list_work_request_errors`(work_request_id, …)	Return a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Return a (paginated) list of logs for a given work request.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a compartment.
`remove_compartment`(security_zone_id, …)	Removes an existing compartment from a security zone.
`request_risk_scores`(compartment_id, **kwargs)	Examines the number of problems related to the resource and the relative severity of those problems.
`request_security_score_summarized_trend`(…)	Measures the number of resources examined across all regions and compares it with the number of problems detected, for a given time period.
`request_security_scores`(compartment_id, **kwargs)	Measures the number of resources examined across all regions and compares it with the number of problems detected.
`request_summarized_activity_problems`(…)	Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.
`request_summarized_problems`(list_dimensions, …)	Returns the number of problems matching the key-value pairs in dimensionMap.
`request_summarized_responder_executions`(…)	Returns the number of Responder Executions, for a given set of dimensions.
`request_summarized_risk_scores`(…)	DEPRECATED
`request_summarized_security_scores`(…)	DEPRECATED
`request_summarized_top_trend_resource_profile_risk_scores`(…)	Summarizes the resource profile risk score top trends for the given time range based on the search filters.
`request_summarized_trend_problems`(…)	Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period.
`request_summarized_trend_resource_risk_scores`(…)	Summarizes the resource risk score trend for the given time range based on the search filters.
`request_summarized_trend_responder_executions`(…)	Returns the number of remediations performed by Responders, for a given time period.
`request_summarized_trend_security_scores`(…)	DEPRECATED
`skip_bulk_responder_execution`(…)	Skips the execution for a bulk of responder executions
`skip_responder_execution`(…)	Skips the execution of the responder execution.
`trigger_responder`(problem_id, …)	Sends the problem identified by problemId to the responder engine, to be processed by rule that’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed.
`update_bulk_problem_status`(…)	Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.
`update_configuration`(…)	Update configuration details for a Cloud Guard tenancy, identified by root compartment OCID.
`update_data_mask_rule`(data_mask_rule_id, …)	Updates a data mask rule (DataMaskRule object) identified by dataMaskRuleId.
`update_data_source`(data_source_id, …)	Updates a data source identified by dataSourceId
`update_detector_recipe`(detector_recipe_id, …)	Updates a detector recipe (DetectorRecipe object) identified by detectorRecipeId.
`update_detector_recipe_detector_rule`(…)	Updates a detector rule (DetectorRule object) identified by detectorRuleId.
`update_managed_list`(managed_list_id, …)	Updates a ManagedList object, identified by managedList.
`update_problem_status`(problem_id, …)	Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.
`update_responder_recipe`(responder_recipe_id, …)	Update the ResponderRecipe resource by identifier
`update_responder_recipe_responder_rule`(…)	Update the ResponderRule by identifier
`update_security_recipe`(security_recipe_id, …)	Updates a security zone recipe.
`update_security_zone`(security_zone_id, …)	Updates the security zone identified by its id
`update_target`(target_id, …)	Updates a Target identified by targetId
`update_target_detector_recipe`(target_id, …)	Update the TargetDetectorRecipe resource by identifier
`update_target_detector_recipe_detector_rule`(…)	Update the DetectorRule by identifier
`update_target_responder_recipe`(target_id, …)	Update the TargetResponderRecipe resource by identifier
`update_target_responder_recipe_responder_rule`(…)	Update the ResponderRule by identifier

__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.

add_compartment(security_zone_id, add_compartment_details, **kwargs)¶

Add an existing compartment to a security zone. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone’s policies.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone) add_compartment_details (oci.cloud_guard.models.AddCompartmentDetails) – (required) The compartment to add to the security zone. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityZone`
Return type:	`Response`
Example:

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

cancel_work_request(work_request_id, **kwargs)¶

Cancels the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 cancel_work_request API.

change_data_source_compartment(data_source_id, change_data_source_compartment_details, **kwargs)¶

Moves the DataSource from current compartment to another.

Parameters:	data_source_id (str) – (required) DataSource OCID change_data_source_compartment_details (oci.cloud_guard.models.ChangeDataSourceCompartmentDetails) – (required) The compartment id of the DataSource 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_source_compartment API.

change_detector_recipe_compartment(detector_recipe_id, change_detector_recipe_compartment_details, **kwargs)¶

Moves the detector recipe (DetectorRecipe object), identified by detectorRecipeId, from the current compartment to another compartment.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID change_detector_recipe_compartment_details (oci.cloud_guard.models.ChangeDetectorRecipeCompartmentDetails) – (required) The target compartment id. 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_detector_recipe_compartment API.

change_managed_list_compartment(managed_list_id, change_managed_list_compartment_details, **kwargs)¶

Moves the managed list (ManagedList object), identified by managedListId, from the current compartment to another compartment.

Parameters:	managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request. change_managed_list_compartment_details (oci.cloud_guard.models.ChangeManagedListCompartmentDetails) – (required) The compartment id of the ManagedList 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_managed_list_compartment API.

change_responder_recipe_compartment(responder_recipe_id, change_responder_recipe_compartment_details, **kwargs)¶

Moves the ResponderRecipe from current compartment to another.

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe change_responder_recipe_compartment_details (oci.cloud_guard.models.ChangeResponderRecipeCompartmentDetails) – (required) The target compartment id. 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_responder_recipe_compartment API.

change_security_recipe_compartment(security_recipe_id, change_security_recipe_compartment_details, **kwargs)¶

Moves a security zone recipe to a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	security_recipe_id (str) – (required) The unique identifier of the security zone recipe (SecurityRecipe) change_security_recipe_compartment_details (oci.cloud_guard.models.ChangeSecurityRecipeCompartmentDetails) – (required) The compartment to which you want to move the recipe. 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_security_recipe_compartment API.

change_security_zone_compartment(security_zone_id, change_security_zone_compartment_details, **kwargs)¶

Moves a security zone to a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone) change_security_zone_compartment_details (oci.cloud_guard.models.ChangeSecurityZoneCompartmentDetails) – (required) The compartment to which you want to move the security zone. 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_security_zone_compartment API.

create_data_mask_rule(create_data_mask_rule_details, **kwargs)¶

Creates a new DataMaskRule object definition.

Parameters:	create_data_mask_rule_details (oci.cloud_guard.models.CreateDataMaskRuleDetails) – (required) Definition for the new Data Mask Rule. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataMaskRule`
Return type:	`Response`
Example:

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

create_data_source(create_data_source_details, **kwargs)¶

Creates a DataSource

Parameters:	create_data_source_details (oci.cloud_guard.models.CreateDataSourceDetails) – (required) Details for the new DataSource. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_source API.

create_detector_recipe(create_detector_recipe_details, **kwargs)¶

Creates a new DetectorRecipe object.

Parameters:	create_detector_recipe_details (oci.cloud_guard.models.CreateDetectorRecipeDetails) – (required) Details for the new DetectorRecipe. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipe`
Return type:	`Response`
Example:

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

create_detector_recipe_detector_rule(detector_recipe_id, create_detector_recipe_detector_rule_details, **kwargs)¶

Create the DetectorRule

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID create_detector_recipe_detector_rule_details (oci.cloud_guard.models.CreateDetectorRecipeDetectorRuleDetails) – (required) The details with which detector rule has to be created. 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipeDetectorRule`
Return type:	`Response`
Example:

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

create_managed_list(create_managed_list_details, **kwargs)¶

Creates a new ManagedList object.

Parameters:	create_managed_list_details (oci.cloud_guard.models.CreateManagedListDetails) – (required) Details for the new ManagedList. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ManagedList`
Return type:	`Response`
Example:

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

create_responder_recipe(create_responder_recipe_details, **kwargs)¶

Create a ResponderRecipe.

Parameters:	create_responder_recipe_details (oci.cloud_guard.models.CreateResponderRecipeDetails) – (required) Details for ResponderRecipe. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipe`
Return type:	`Response`
Example:

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

create_security_recipe(create_security_recipe_details, **kwargs)¶

Creates a security zone recipe. A security zone recipe is a collection of security zone policies.

Parameters:	create_security_recipe_details (oci.cloud_guard.models.CreateSecurityRecipeDetails) – (required) Details for the new SecurityRecipe. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityRecipe`
Return type:	`Response`
Example:

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

create_security_zone(create_security_zone_details, **kwargs)¶

Creates a security zone for a compartment. A security zone enforces all security zone policies in a given security zone recipe. Any actions that violate a policy are denied. By default, any subcompartments are also in the same security zone.

Parameters:	create_security_zone_details (oci.cloud_guard.models.CreateSecurityZoneDetails) – (required) Details for the new SecurityZone. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityZone`
Return type:	`Response`
Example:

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

create_target(create_target_details, **kwargs)¶

Creates a new Target

Parameters:	create_target_details (oci.cloud_guard.models.CreateTargetDetails) – (required) Details for the new Target. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Target`
Return type:	`Response`
Example:

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

create_target_detector_recipe(target_id, attach_target_detector_recipe_details, **kwargs)¶

Attach a DetectorRecipe with the Target

Parameters:	target_id (str) – (required) OCID of target attach_target_detector_recipe_details (oci.cloud_guard.models.AttachTargetDetectorRecipeDetails) – (required) Details for associating DetectorRecipe to Target 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipe`
Return type:	`Response`
Example:

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

create_target_responder_recipe(target_id, attach_target_responder_recipe_details, **kwargs)¶

Attach a ResponderRecipe with the Target

Parameters:	target_id (str) – (required) OCID of target attach_target_responder_recipe_details (oci.cloud_guard.models.AttachTargetResponderRecipeDetails) – (required) Details for associating ResponderRecipe to Target 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipe`
Return type:	`Response`
Example:

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

delete_data_mask_rule(data_mask_rule_id, **kwargs)¶

Deletes a DataMaskRule object, identified by dataMaskRuleId.

Parameters:	data_mask_rule_id (str) – (required) OCID of dataMaskRule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_mask_rule API.

delete_data_source(data_source_id, **kwargs)¶

Deletes a DataSource identified by dataSourceId

Parameters:	data_source_id (str) – (required) DataSource 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) 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_source API.

delete_detector_recipe(detector_recipe_id, **kwargs)¶

Deletes a detector recipe (DetectorRecipe object) identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe 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) 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_detector_recipe API.

delete_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, **kwargs)¶

Deletes DetectorRecipeDetectorRule

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID detector_rule_id (str) – (required) The key of Detector Rule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_detector_recipe_detector_rule API.

delete_detector_recipe_detector_rule_data_source(detector_recipe_id, detector_rule_id, data_source_id, **kwargs)¶

Delete the DetectorRecipeDetectorRuleDataSource resource by identifier

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID detector_rule_id (str) – (required) The key of Detector Rule. data_source_id (str) – (required) DataSource 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_detector_recipe_detector_rule_data_source API.

delete_managed_list(managed_list_id, **kwargs)¶

Deletes a managed list identified by managedListId.

Parameters:	managed_list_id (str) – (required) The cloudguard list OCID to be passed in 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_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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_managed_list API.

delete_responder_recipe(responder_recipe_id, **kwargs)¶

Delete the ResponderRecipe resource by identifier

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_responder_recipe API.

delete_security_recipe(security_recipe_id, **kwargs)¶

Deletes a security zone recipe. The recipe can’t be associated with an existing security zone.

Parameters:	security_recipe_id (str) – (required) The unique identifier of the security zone recipe (SecurityRecipe) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_security_recipe API.

delete_security_zone(security_zone_id, **kwargs)¶

Deletes an existing security zone with a given identifier.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_security_zone API.

delete_target(target_id, **kwargs)¶

Deletes a Target identified by targetId

Parameters:	target_id (str) – (required) OCID of target 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_target API.

delete_target_detector_recipe(target_id, target_detector_recipe_id, **kwargs)¶

Delete the TargetDetectorRecipe resource by identifier

Parameters:	target_id (str) – (required) OCID of target target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_target_detector_recipe API.

delete_target_responder_recipe(target_id, target_responder_recipe_id, **kwargs)¶

Delete the TargetResponderRecipe resource by identifier

Parameters:	target_id (str) – (required) OCID of target target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_target_responder_recipe API.

execute_responder_execution(responder_execution_id, compartment_id, **kwargs)¶

Executes the responder execution. When provided, If-Match is checked against ETag values of the resource.

Parameters:	responder_execution_id (str) – (required) The identifier of the responder execution. compartment_id (str) – (required) The ID of the compartment in which to list resources. 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, then a retry of the original creation request might be rejected. execute_responder_execution_details (oci.cloud_guard.models.ExecuteResponderExecutionDetails) – (optional) Details for Responder Configuration 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 execute_responder_execution API.

get_condition_metadata_type(condition_metadata_type_id, **kwargs)¶

Returns a ConditionMetatDataType object with its details.

Parameters:	condition_metadata_type_id (str) – (required) The type of the condition meta data. Allowed values are: “ActivityCondition”, “SecurityCondition”, “CloudGuardCondition”, “ThreatCondition” opc_request_id (str) – (optional) The client request ID for tracing. service_type (str) – (optional) ServiceType filter for the condition meta data. resource_type (str) – (optional) Resource filter for the condition meta data. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ConditionMetadataType`
Return type:	`Response`
Example:

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

get_configuration(compartment_id, **kwargs)¶

Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_mask_rule(data_mask_rule_id, **kwargs)¶

Returns a DataMaskRule object, identified by DataMaskRuleId.

Parameters:	data_mask_rule_id (str) – (required) OCID of dataMaskRule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataMaskRule`
Return type:	`Response`
Example:

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

get_data_source(data_source_id, **kwargs)¶

Returns a DataSource identified by dataSourceId

Parameters:	data_source_id (str) – (required) DataSource OCID 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataSource`
Return type:	`Response`
Example:

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

get_detector(detector_id, **kwargs)¶

Returns a Detector object, identified by detectorId.

Parameters:	detector_id (str) – (required) The Name of Detector. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Detector`
Return type:	`Response`
Example:

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

get_detector_recipe(detector_recipe_id, **kwargs)¶

Returns a detector recipe (DetectorRecipe object) identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipe`
Return type:	`Response`
Example:

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

get_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, **kwargs)¶

Returns a detector rule (DetectorRule object) identified by detectorRuleId.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID detector_rule_id (str) – (required) The key of Detector Rule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipeDetectorRule`
Return type:	`Response`
Example:

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

get_detector_rule(detector_id, detector_rule_id, **kwargs)¶

Returns a detector rule (DetectorRule object) identified by detectorRuleId.

Parameters:	detector_id (str) – (required) The Name of Detector. detector_rule_id (str) – (required) The key of Detector Rule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRule`
Return type:	`Response`
Example:

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

get_managed_list(managed_list_id, **kwargs)¶

Returns a managed list identified by managedListId.

Parameters:	managed_list_id (str) – (required) The cloudguard list OCID to be passed in the 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ManagedList`
Return type:	`Response`
Example:

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

get_problem(problem_id, **kwargs)¶

Returns the Problem object identified by a problemId.

Parameters:	problem_id (str) – (required) OCId of the problem. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Problem`
Return type:	`Response`
Example:

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

get_resource_profile(resource_profile_id, **kwargs)¶

Returns resource profile details

Parameters:	resource_profile_id (str) – (required) OCID of the resource profile. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceProfile`
Return type:	`Response`
Example:

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

get_responder_execution(responder_execution_id, **kwargs)¶

Returns a Responder Execution identified by responderExecutionId

Parameters:	responder_execution_id (str) – (required) The identifier of the responder execution. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderExecution`
Return type:	`Response`
Example:

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

get_responder_recipe(responder_recipe_id, **kwargs)¶

Get a ResponderRecipe by identifier

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipe`
Return type:	`Response`
Example:

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

get_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, **kwargs)¶

Get ResponderRule by identifier

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe responder_rule_id (str) – (required) The id of ResponderRule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipeResponderRule`
Return type:	`Response`
Example:

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

get_responder_rule(responder_rule_id, **kwargs)¶

Get a ResponderRule by identifier

Parameters:	responder_rule_id (str) – (required) The id of ResponderRule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRule`
Return type:	`Response`
Example:

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

get_security_policy(security_policy_id, **kwargs)¶

Gets a security zone policy using its identifier. When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is denied.

Parameters:	security_policy_id (str) – (required) The unique identifier of the security zone policy (SecurityPolicy) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityPolicy`
Return type:	`Response`
Example:

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

get_security_recipe(security_recipe_id, **kwargs)¶

Gets a security zone recipe by identifier. A security zone recipe is a collection of security zone policies.

Parameters:	security_recipe_id (str) – (required) The unique identifier of the security zone recipe (SecurityRecipe) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityRecipe`
Return type:	`Response`
Example:

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

get_security_zone(security_zone_id, **kwargs)¶

Gets a security zone by its identifier. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone’s compartments that violate a policy are denied.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityZone`
Return type:	`Response`
Example:

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

get_sighting(sighting_id, **kwargs)¶

Returns Sighting details

Parameters:	sighting_id (str) – (required) OCID of the sighting. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Sighting`
Return type:	`Response`
Example:

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

get_target(target_id, **kwargs)¶

Returns a Target identified by targetId

Parameters:	target_id (str) – (required) OCID of target 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Target`
Return type:	`Response`
Example:

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

get_target_detector_recipe(target_id, target_detector_recipe_id, **kwargs)¶

Get a TargetDetectorRecipe by identifier

Parameters:	target_id (str) – (required) OCID of target target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipe`
Return type:	`Response`
Example:

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

get_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, **kwargs)¶

Get DetectorRule by identifier

Parameters:	target_id (str) – (required) OCID of target target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe detector_rule_id (str) – (required) The id of DetectorRule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipeDetectorRule`
Return type:	`Response`
Example:

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

get_target_responder_recipe(target_id, target_responder_recipe_id, **kwargs)¶

Get a TargetResponderRecipe by identifier

Parameters:	target_id (str) – (required) OCID of target target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipe`
Return type:	`Response`
Example:

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

get_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, **kwargs)¶

Get ResponderRule by identifier

Parameters:	target_id (str) – (required) OCID of target target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe responder_rule_id (str) – (required) The id of ResponderRule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipeResponderRule`
Return type:	`Response`
Example:

Click here to see an example of how to use get_target_responder_recipe_responder_rule 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_condition_metadata_types(compartment_id, **kwargs)¶

Returns a list of ConditionMetadataType objects.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ConditionMetadataTypeCollection`
Return type:	`Response`
Example:

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

list_data_mask_rules(compartment_id, **kwargs)¶

Returns a list of all DataMaskRule objects in the specified compartmentId (OCID) and its subcompartments.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. data_mask_rule_status (str) – (optional) The status of the dataMaskRule. Allowed values are: “ENABLED”, “DISABLED” target_id (str) – (optional) OCID of target iam_group_id (str) – (optional) OCID of iamGroup target_type (str) – (optional) Type of target 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataMaskRuleCollection`
Return type:	`Response`
Example:

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

list_data_source_events(data_source_id, **kwargs)¶

Returns a list of events from CloudGuard DataSource

Parameters:	data_source_id (str) – (required) DataSource OCID region (str) – (optional) A filter to return only resource their region matches the given region. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 timeCreated is descending. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataSourceEventCollection`
Return type:	`Response`
Example:

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

list_data_sources(compartment_id, **kwargs)¶

Returns a list of all Data Sources in a compartment

The ListDataSources operation returns only the data Sources in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListdataSources on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. data_source_feed_provider (str) – (optional) A filter to return only resources their feedProvider matches the given DataSourceFeedProvider. Allowed values are: “LOGGINGQUERY” lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. logging_query_type (str) – (optional) A filter to return only resources their query type matches the given LoggingQueryType. Allowed values are: “INSIGHT” 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 depending on the the setting of accessLevel. 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 ‘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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataSourceCollection`
Return type:	`Response`
Example:

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

list_detector_recipe_detector_rules(detector_recipe_id, compartment_id, **kwargs)¶

Returns a list of detector rules (DetectorRule objects) for a detector recipe (DetectorRecipe object), identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName”, “riskLevel” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipeDetectorRuleCollection`
Return type:	`Response`
Example:

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

list_detector_recipes(compartment_id, **kwargs)¶

Returns a list of all detector recipes (DetectorRecipe objects) in a compartment, identified by compartmentId.

The ListDetectorRecipes operation returns only the detector recipes in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListDetectorRecipes on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. resource_metadata_only (bool) – (optional) Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 depending on the the setting of accessLevel. 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 ‘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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipeCollection`
Return type:	`Response`
Example:

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

list_detector_rules(detector_id, compartment_id, **kwargs)¶

Returns a list of detector rules for the DetectorRecipe object identified by detectorId.

Parameters:	detector_id (str) – (required) The Name of Detector. compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRuleCollection`
Return type:	`Response`
Example:

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

list_detectors(compartment_id, **kwargs)¶

Returns a detector catalog (DetectorCollection object) with a list of DetectorSummary objects.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorCollection`
Return type:	`Response`
Example:

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

list_impacted_resources(problem_id, **kwargs)¶

Returns a list of impacted resources for a Cloud Guard problem with a specified problem ID.

Parameters:	problem_id (str) – (required) OCId of the problem. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ImpactedResourceCollection`
Return type:	`Response`
Example:

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

list_managed_list_types(compartment_id, **kwargs)¶

Returns all managed list types (listType parameter) that Cloud Guard supports.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName”, “riskLevel” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ManagedListTypeCollection`
Return type:	`Response`
Example:

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

list_managed_lists(compartment_id, **kwargs)¶

Returns a list of all ManagedList objects in a compartment, identified by compartmentId. The ListManagedLists operation returns only the managed lists in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return ManagedLists in only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListManagedLists on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. resource_metadata_only (bool) – (optional) Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” list_type (str) – (optional) The type of the ManagedList. Allowed values are: “CIDR_BLOCK”, “USERS”, “GROUPS”, “IPV4ADDRESS”, “IPV6ADDRESS”, “RESOURCE_OCID”, “REGION”, “COUNTRY”, “STATE”, “CITY”, “TAGS”, “GENERIC”, “FUSION_APPS_ROLE”, “FUSION_APPS_PERMISSION” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 depending on the the setting of accessLevel. 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 ‘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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ManagedListCollection`
Return type:	`Response`
Example:

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

list_policies(compartment_id, **kwargs)¶

Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `PolicyCollection`
Return type:	`Response`
Example:

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

list_problem_endpoints(problem_id, **kwargs)¶

Returns a list of endpoints associated with a problem, identified by problemId.

Parameters:	problem_id (str) – (required) OCId of the problem. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ProblemEndpointCollection`
Return type:	`Response`
Example:

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

list_problem_entities(problem_id, **kwargs)¶

Returns a list of entities for a CloudGuard Problem

Parameters:	problem_id (str) – (required) OCId of the problem. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 timeCreated is descending. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ProblemEntityCollection`
Return type:	`Response`
Example:

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

list_problem_histories(compartment_id, problem_id, **kwargs)¶

Returns a list of actions taken on a Cloud Guard problem.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. problem_id (str) – (required) OCId of the problem. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ProblemHistoryCollection`
Return type:	`Response`
Example:

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

list_problems(compartment_id, **kwargs)¶

Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.

The ListProblems operation returns only the problems in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListProblems on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_last_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_last_detected_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to current time. time_first_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_first_detected_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to current time. lifecycle_detail (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “OPEN”, “RESOLVED”, “DISMISSED”, “DELETED” lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “ACTIVE”, “INACTIVE” region (str) – (optional) OCI Monitoring region. risk_level (str) – (optional) Risk level of the Problem. resource_type (str) – (optional) Resource Type associated with the resource. city (str) – (optional) City of the problem. state (str) – (optional) State of the problem. country (str) – (optional) Country of the problem. label (str) – (optional) Label associated with the Problem. detector_rule_id_list (list[str]) – (optional) Comma seperated list of detector rule ids to be passed in to match against Problems. detector_type (str) – (optional) The field to list the Problems by Detector Type. Valid values are IAAS_ACTIVITY_DETECTOR and IAAS_CONFIGURATION_DETECTOR Allowed values are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR” target_id (str) – (optional) The ID of the target in which to list resources. problem_category (str) – (optional) Setting this to SECURITY_ZONE returns only security-zone related violations. Allowed values are: “SECURITY_ZONE” 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 depending on the the setting of accessLevel. 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” resource_id (str) – (optional) The ID of the resource associated with the problem. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default. Allowed values are: “riskLevel”, “timeLastDetected”, “resourceName” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ProblemCollection`
Return type:	`Response`
Example:

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

list_recommendations(compartment_id, **kwargs)¶

Returns a list of all Recommendations.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. 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 riskLevel and timeCreated is descending. If no value is specified riskLevel is default. Allowed values are: “riskLevel”, “timeCreated” target_id (str) – (optional) The ID of the target in which to list resources. 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 depending on the the setting of accessLevel. 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” lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” lifecycle_detail (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “OPEN”, “RESOLVED”, “DISMISSED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `RecommendationSummaryCollection`
Return type:	`Response`
Example:

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

list_resource_profile_endpoints(resource_profile_id, **kwargs)¶

Returns a list of endpoints for Cloud Guard resource profile

Parameters:	resource_profile_id (str) – (required) OCID of the resource profile. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceProfileEndpointCollection`
Return type:	`Response`
Example:

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

list_resource_profile_impacted_resources(resource_profile_id, **kwargs)¶

Returns a list of impacted resources for Cloud Guard resource profile

Parameters:	resource_profile_id (str) – (required) OCID of the resource profile. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceProfileImpactedResourceCollection`
Return type:	`Response`
Example:

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

list_resource_profiles(compartment_id, **kwargs)¶

Returns a list of all resource profiles identified by the Cloud Guard The ListResourceProfiles operation returns only resource profiles that match the passed filters.

The ListResourceProfiles operation returns only the resource profiles in compartmentId passed. The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListResourceProfiles on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_last_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_last_detected_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to current time. time_first_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_first_detected_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to current time. 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 depending on the the setting of accessLevel. 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” resource_types (list[str]) – (optional) A filter to return only resources that match the list of resource types given risk_score_greater_than_or_equal_to (float) – (optional) risk score filter risk_score_less_than_or_equal_to (float) – (optional) risk score filter techniques (list[str]) – (optional) A filter to return only resources that match the list of techniques given tactics (list[str]) – (optional) A filter to return only resources that match the list of tactics given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 resource profiles. Only one sort order may be provided. Default order for timeLastDetected is descending. If no value is specified timeLastDetected is default. Allowed values are: “riskScore”, “riskScoreGrowth”, “timeFirstDetected”, “timeLastDetected”, “sightingsCount”, “displayName”, “type” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceProfileCollection`
Return type:	`Response`
Example:

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

list_resource_types(compartment_id, **kwargs)¶

Returns a list of resource types.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. detector_id (str) – (optional) Detector type Allowed values are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR” lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName”, “riskLevel” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceTypeCollection`
Return type:	`Response`
Example:

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

list_responder_activities(problem_id, **kwargs)¶

Returns a list of Responder activities done on CloudGuard Problem

Parameters:	problem_id (str) – (required) OCId of the problem. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 responderRuleName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “responderRuleName” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderActivityCollection`
Return type:	`Response`
Example:

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

list_responder_executions(compartment_id, **kwargs)¶

Returns a list of Responder Executions. A Responder Execution is an entity that tracks the collective execution of multiple Responder Rule Executions for a given Problem.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. 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 depending on the the setting of accessLevel. 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” responder_rule_ids (list[str]) – (optional) Responder Rule Ids filter for the Responder Executions. time_created_greater_than_or_equal_to (datetime) – (optional) Creation Start time for filtering time_created_less_than_or_equal_to (datetime) – (optional) Creation End time for filtering time_completed_greater_than_or_equal_to (datetime) – (optional) Completion End Time time_completed_less_than_or_equal_to (datetime) – (optional) Completion Start Time target_id (str) – (optional) The ID of the target in which to list resources. resource_type (str) – (optional) Resource Type associated with the resource. responder_type (str) – (optional) The field to list the Responder Executions by Responder Type. Valid values are REMEDIATION and NOTIFICATION Allowed values are: “REMEDIATION”, “NOTIFICATION” responder_execution_status (str) – (optional) The status of the responder execution in which to list responders. Allowed values are: “STARTED”, “AWAITING_CONFIRMATION”, “AWAITING_INPUT”, “SUCCEEDED”, “FAILED”, “SKIPPED”, “ALL” responder_execution_mode (str) – (optional) The mode of the responder execution in which to list responders. Allowed values are: “MANUAL”, “AUTOMATED”, “ALL” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 responderRuleName and resourceName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “responderRuleName”, “resourceName”, “timeCompleted” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderExecutionCollection`
Return type:	`Response`
Example:

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

list_responder_recipe_responder_rules(responder_recipe_id, compartment_id, **kwargs)¶

Returns a list of ResponderRule associated with ResponderRecipe.

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName”, “riskLevel” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipeResponderRuleCollection`
Return type:	`Response`
Example:

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

list_responder_recipes(compartment_id, **kwargs)¶

Returns a list of all ResponderRecipes in a compartment The ListResponderRecipe operation returns only the targets in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListResponderRecipe on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. resource_metadata_only (bool) – (optional) Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 depending on the the setting of accessLevel. 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 ‘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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipeCollection`
Return type:	`Response`
Example:

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

list_responder_rules(compartment_id, **kwargs)¶

Returns a list of ResponderRule.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRuleCollection`
Return type:	`Response`
Example:

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

list_security_policies(compartment_id, **kwargs)¶

Returns a list of security zone policies. Specify any compartment.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) The unique identifier of the security zone policy (SecurityPolicy) limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityPolicyCollection`
Return type:	`Response`
Example:

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

list_security_recipes(compartment_id, **kwargs)¶

Gets a list of all security zone recipes in a compartment.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) The unique identifier of the security zone recipe (SecurityRecipe) limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityRecipeCollection`
Return type:	`Response`
Example:

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

list_security_zones(compartment_id, **kwargs)¶

Gets a list of all security zones in a compartment.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) The unique identifier of the security zone (SecurityZone) security_recipe_id (str) – (optional) The unique identifier of the security zone recipe (SecurityRecipe) is_required_security_zones_in_subtree (bool) – (optional) security zones in the subtree limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityZoneCollection`
Return type:	`Response`
Example:

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

list_sighting_endpoints(sighting_id, **kwargs)¶

Returns Sighting endpoints details

Parameters:	sighting_id (str) – (required) OCID of the sighting. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SightingEndpointCollection`
Return type:	`Response`
Example:

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

list_sighting_impacted_resources(sighting_id, **kwargs)¶

Return a list of Impacted Resources for a CloudGuard Sighting

Parameters:	sighting_id (str) – (required) OCID of the sighting. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SightingImpactedResourceCollection`
Return type:	`Response`
Example:

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

list_sightings(compartment_id, **kwargs)¶

Returns a list of all Sightings identified by the Cloud Guard The ListSightings operation returns only sightings that match the passed filters.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSightings on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. problem_id (str) – (optional) OCID of the problem. resource_profile_id (str) – (optional) OCID of the resource profile. 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. Allowed values are: “timeCreated” time_last_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_last_detected_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to current time. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SightingCollection`
Return type:	`Response`
Example:

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

list_tactics(compartment_id, **kwargs)¶

Returns a list of tactics associated with detector rules.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TacticCollection`
Return type:	`Response`
Example:

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

list_target_detector_recipe_detector_rules(target_id, target_detector_recipe_id, compartment_id, **kwargs)¶

Returns a list of DetectorRule associated with DetectorRecipe within a Target.

Parameters:	target_id (str) – (required) OCID of target target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName”, “riskLevel” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipeDetectorRuleCollection`
Return type:	`Response`
Example:

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

list_target_detector_recipes(target_id, compartment_id, **kwargs)¶

Returns a list of all detector recipes associated with the target identified by targetId

Parameters:	target_id (str) – (required) OCID of target compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipeCollection`
Return type:	`Response`
Example:

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

list_target_responder_recipe_responder_rules(target_id, target_responder_recipe_id, compartment_id, **kwargs)¶

Returns a list of ResponderRule associated with ResponderRecipe within a Target.

Parameters:	target_id (str) – (required) OCID of target target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName”, “riskLevel” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipeResponderRuleCollection`
Return type:	`Response`
Example:

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

list_target_responder_recipes(target_id, compartment_id, **kwargs)¶

Returns a list of all responder recipes associated with the target identified by targetId

Parameters:	target_id (str) – (required) OCID of target compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipeCollection`
Return type:	`Response`
Example:

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

list_targets(compartment_id, **kwargs)¶

Returns a list of all Targets in a compartment The ListTargets operation returns only the targets in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListTargets on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. is_non_security_zone_targets_only_query (bool) – (optional) Default is false. When set to true, only the targets that would be deleted as part of security zone creation will be returned. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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. If no value is specified timeCreated is default. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetCollection`
Return type:	`Response`
Example:

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

list_techniques(compartment_id, **kwargs)¶

Returns a list of techniques associated with detector rules.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. tactics (list[str]) – (optional) A filter to return only resources that match the list of tactics given. lifecycle_state (str) – (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 displayName is ascending. If no value is specified displayName is default. Allowed values are: “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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TechniqueCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Return a (paginated) list of errors for a given work request.

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) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 timeCreated is descending. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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)¶

Return a (paginated) list of logs for a given work request.

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) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 timeCreated is descending. Allowed values are: “timeCreated” 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. status (str) – (optional) A filter to return only resources 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 work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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.

remove_compartment(security_zone_id, remove_compartment_details, **kwargs)¶

Removes an existing compartment from a security zone. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can’t remove the primary compartment that was used to create the security zone.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone) remove_compartment_details (oci.cloud_guard.models.RemoveCompartmentDetails) – (required) The compartment to remove from the security zone. 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) 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityZone`
Return type:	`Response`
Example:

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

request_risk_scores(compartment_id, **kwargs)¶

Examines the number of problems related to the resource and the relative severity of those problems.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `RiskScoreAggregationCollection`
Return type:	`Response`
Example:

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

request_security_score_summarized_trend(compartment_id, **kwargs)¶

Measures the number of resources examined across all regions and compares it with the number of problems detected, for a given time period.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_score_computed_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s current time - 30 days. time_score_computed_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to today’s current time. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityScoreTrendAggregationCollection`
Return type:	`Response`
Example:

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

request_security_scores(compartment_id, **kwargs)¶

Measures the number of resources examined across all regions and compares it with the number of problems detected.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityScoreAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_activity_problems(compartment_id, **kwargs)¶

Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform summarize API on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

The compartmentId to be passed with accessLevel and compartmentIdInSubtree params has to be the root compartment id (tenant-id) only.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. include_unknown_locations (bool) – (optional) Default is false. When set to true, the summary of activity problems that has unknown values for city, state or country will be included. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ActivityProblemAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_problems(list_dimensions, compartment_id, **kwargs)¶

Returns the number of problems matching the key-value pairs in dimensionMap.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform summarize API on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	list_dimensions (oci.cloud_guard.models.list[str]) – (required) The possible attributes based on which the problems can be distinguished. Allowed values are: “RESOURCE_TYPE”, “REGION”, “COMPARTMENT_ID”, “RISK_LEVEL” compartment_id (str) – (required) The ID of the compartment in which to list resources. 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ProblemAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_responder_executions(responder_executions_dimensions, compartment_id, **kwargs)¶

Returns the number of Responder Executions, for a given set of dimensions.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform summarize API on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	responder_executions_dimensions (oci.cloud_guard.models.list[str]) – (required) The possible attributes based on which the responder executions can be distinguished Allowed values are: “RESPONDER_RULE_TYPE”, “RESPONDER_EXECUTION_STATUS” compartment_id (str) – (required) The ID of the compartment in which to list resources. responder_type_filter (list[str]) – (optional) The possible filters for Responder Type Dimension to distinguish Responder Executions. If no values are passed, the metric for responder executions of all reponder types are returned Allowed values are: “REMEDIATION”, “NOTIFICATION” responder_execution_status_filter (list[str]) – (optional) The possible filters for Responder Type Dimension to distinguish Responder Executions. If no values are passed, the metric for responder executions of all status are returned Allowed values are: “STARTED”, “AWAITING_CONFIRMATION”, “SUCCEEDED”, “FAILED”, “SKIPPED” 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderExecutionAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_risk_scores(compartment_id, **kwargs)¶

DEPRECATED

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `RiskScoreAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_security_scores(compartment_id, **kwargs)¶

DEPRECATED

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityScoreAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_top_trend_resource_profile_risk_scores(compartment_id, **kwargs)¶

Summarizes the resource profile risk score top trends for the given time range based on the search filters.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_score_computed_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s current time - 30 days. time_score_computed_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to today’s current time. 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 depending on the the setting of accessLevel. sort_by (str) – (optional) The field to sort trendlines for resource profiles. Only one sort order may be provided. If no value is specified riskScore is default. Allowed values are: “riskScore”, “riskScoreGrowth”, “timeFirstDetected”, “timeLastDetected” count (int) – (optional) Number of resource profile risk score trend-lines to be displayed. Default value is 10. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceProfileRiskScoreAggregationSummaryCollection`
Return type:	`Response`
Example:

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

request_summarized_trend_problems(compartment_id, **kwargs)¶

Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform summarize API on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_first_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_first_detected_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to current time. 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ProblemTrendAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_trend_resource_risk_scores(request_summarized_trend_resource_risk_scores_details, compartment_id, **kwargs)¶

Summarizes the resource risk score trend for the given time range based on the search filters.

Parameters:	request_summarized_trend_resource_risk_scores_details (oci.cloud_guard.models.RequestSummarizedTrendResourceRiskScoresDetails) – (required) The filter to fetch risk score trend. compartment_id (str) – (required) The ID of the compartment in which to list resources. time_score_computed_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s current time - 30 days. time_score_computed_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to today’s current time. 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResourceRiskScoreAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_trend_responder_executions(compartment_id, **kwargs)¶

Returns the number of remediations performed by Responders, for a given time period.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform summarize API on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_completed_greater_than_or_equal_to (datetime) – (optional) Completion End Time time_completed_less_than_or_equal_to (datetime) – (optional) Completion Start Time 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 depending on the the setting of accessLevel. 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” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderExecutionTrendAggregationCollection`
Return type:	`Response`
Example:

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

request_summarized_trend_security_scores(compartment_id, **kwargs)¶

DEPRECATED

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_score_computed_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s current time - 30 days. time_score_computed_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to today’s current time. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityScoreTrendAggregationCollection`
Return type:	`Response`
Example:

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

skip_bulk_responder_execution(skip_bulk_responder_execution_details, **kwargs)¶

Skips the execution for a bulk of responder executions The operation is atomic in nature

Parameters:	skip_bulk_responder_execution_details (oci.cloud_guard.models.SkipBulkResponderExecutionDetails) – (required) A list of responder execution ids to skip the execution 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 skip_bulk_responder_execution API.

skip_responder_execution(responder_execution_id, compartment_id, **kwargs)¶

Skips the execution of the responder execution. When provided, If-Match is checked against ETag values of the resource.

Parameters:	responder_execution_id (str) – (required) The identifier of the responder execution. compartment_id (str) – (required) The ID of the compartment in which to list resources. 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 skip_responder_execution API.

trigger_responder(problem_id, trigger_responder_details, **kwargs)¶

Sends the problem identified by problemId to the responder engine, to be processed by rule that’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed.

Parameters:	problem_id (str) – (required) OCId of the problem. trigger_responder_details (oci.cloud_guard.models.TriggerResponderDetails) – (required) The responder may update the problem. 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) The client request ID for tracing. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 trigger_responder API.

update_bulk_problem_status(update_bulk_problem_status_details, **kwargs)¶

Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.

Parameters:	update_bulk_problem_status_details (oci.cloud_guard.models.UpdateBulkProblemStatusDetails) – (required) A list of problem ids to be passed in to update the Problem status 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_bulk_problem_status API.

update_configuration(update_configuration_details, compartment_id, **kwargs)¶

Update configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created.

Parameters:	update_configuration_details (oci.cloud_guard.models.UpdateConfigurationDetails) – (required) Update Configuration Details of Cloud Guard for a Tenancy. compartment_id (str) – (required) The ID of the compartment in which to list resources. 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, 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. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_mask_rule(data_mask_rule_id, update_data_mask_rule_details, **kwargs)¶

Updates a data mask rule (DataMaskRule object) identified by dataMaskRuleId.

Parameters:	data_mask_rule_id (str) – (required) OCID of dataMaskRule update_data_mask_rule_details (oci.cloud_guard.models.UpdateDataMaskRuleDetails) – (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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DataMaskRule`
Return type:	`Response`
Example:

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

update_data_source(data_source_id, update_data_source_details, **kwargs)¶

Updates a data source identified by dataSourceId

Parameters:	data_source_id (str) – (required) DataSource OCID update_data_source_details (oci.cloud_guard.models.UpdateDataSourceDetails) – (required) Details for the DataSource 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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_data_source API.

update_detector_recipe(detector_recipe_id, update_detector_recipe_details, **kwargs)¶

Updates a detector recipe (DetectorRecipe object) identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID update_detector_recipe_details (oci.cloud_guard.models.UpdateDetectorRecipeDetails) – (required) Details for the DetectorRecipe 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipe`
Return type:	`Response`
Example:

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

update_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, update_detector_recipe_detector_rule_details, **kwargs)¶

Updates a detector rule (DetectorRule object) identified by detectorRuleId.

Parameters:	detector_recipe_id (str) – (required) DetectorRecipe OCID detector_rule_id (str) – (required) The key of Detector Rule. update_detector_recipe_detector_rule_details (oci.cloud_guard.models.UpdateDetectorRecipeDetectorRuleDetails) – (required) The details to be updated for DetectorRule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `DetectorRecipeDetectorRule`
Return type:	`Response`
Example:

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

update_managed_list(managed_list_id, update_managed_list_details, **kwargs)¶

Updates a ManagedList object, identified by managedList.

Parameters:	managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request. update_managed_list_details (oci.cloud_guard.models.UpdateManagedListDetails) – (required) Details for the ManagedList 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, 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ManagedList`
Return type:	`Response`
Example:

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

update_problem_status(problem_id, update_problem_status_details, **kwargs)¶

Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.

Parameters:	problem_id (str) – (required) OCId of the problem. update_problem_status_details (oci.cloud_guard.models.UpdateProblemStatusDetails) – (required) The additional details for the problem. 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) The client request ID for tracing. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Problem`
Return type:	`Response`
Example:

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

update_responder_recipe(responder_recipe_id, update_responder_recipe_details, **kwargs)¶

Update the ResponderRecipe resource by identifier

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe update_responder_recipe_details (oci.cloud_guard.models.UpdateResponderRecipeDetails) – (required) The details 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipe`
Return type:	`Response`
Example:

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

update_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, update_responder_recipe_responder_rule_details, **kwargs)¶

Update the ResponderRule by identifier

Parameters:	responder_recipe_id (str) – (required) OCID of ResponderRecipe responder_rule_id (str) – (required) The id of ResponderRule update_responder_recipe_responder_rule_details (oci.cloud_guard.models.UpdateResponderRecipeResponderRuleDetails) – (required) The details to be updated for ResponderRule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `ResponderRecipeResponderRule`
Return type:	`Response`
Example:

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

update_security_recipe(security_recipe_id, update_security_recipe_details, **kwargs)¶

Updates a security zone recipe. A security zone recipe is a collection of security zone policies.

Parameters:	security_recipe_id (str) – (required) The unique identifier of the security zone recipe (SecurityRecipe) update_security_recipe_details (oci.cloud_guard.models.UpdateSecurityRecipeDetails) – (required) The information to be updated in the security zone recipe. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityRecipe`
Return type:	`Response`
Example:

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

update_security_zone(security_zone_id, update_security_zone_details, **kwargs)¶

Updates the security zone identified by its id

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone) update_security_zone_details (oci.cloud_guard.models.UpdateSecurityZoneDetails) – (required) The security zone 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `SecurityZone`
Return type:	`Response`
Example:

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

update_target(target_id, update_target_details, **kwargs)¶

Updates a Target identified by targetId

Parameters:	target_id (str) – (required) OCID of target update_target_details (oci.cloud_guard.models.UpdateTargetDetails) – (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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `Target`
Return type:	`Response`
Example:

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

update_target_detector_recipe(target_id, target_detector_recipe_id, update_target_detector_recipe_details, **kwargs)¶

Update the TargetDetectorRecipe resource by identifier

Parameters:	target_id (str) – (required) OCID of target target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe update_target_detector_recipe_details (oci.cloud_guard.models.UpdateTargetDetectorRecipeDetails) – (required) The details 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipe`
Return type:	`Response`
Example:

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

update_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, update_target_detector_recipe_detector_rule_details, **kwargs)¶

Update the DetectorRule by identifier

Parameters:	target_id (str) – (required) OCID of target target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe detector_rule_id (str) – (required) The id of DetectorRule update_target_detector_recipe_detector_rule_details (oci.cloud_guard.models.UpdateTargetDetectorRecipeDetectorRuleDetails) – (required) The details to be updated for DetectorRule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetDetectorRecipeDetectorRule`
Return type:	`Response`
Example:

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

update_target_responder_recipe(target_id, target_responder_recipe_id, update_target_responder_recipe_details, **kwargs)¶

Update the TargetResponderRecipe resource by identifier

Parameters:	target_id (str) – (required) OCID of target target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe update_target_responder_recipe_details (oci.cloud_guard.models.UpdateTargetResponderRecipeDetails) – (required) The details 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipe`
Return type:	`Response`
Example:

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

update_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, update_target_responder_recipe_responder_rule_details, **kwargs)¶

Update the ResponderRule by identifier

Parameters:	target_id (str) – (required) OCID of target target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe responder_rule_id (str) – (required) The id of ResponderRule update_target_responder_recipe_responder_rule_details (oci.cloud_guard.models.UpdateTargetResponderRecipeResponderRuleDetails) – (required) The details to be updated for ResponderRule. 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 will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. 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 `TargetResponderRecipeResponderRule`
Return type:	`Response`
Example:

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