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, …)	Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId.
`cancel_work_request`(work_request_id, **kwargs)	Cancels a work request identified by workRequestId.
`change_data_source_compartment`(…)	Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.
`change_detector_recipe_compartment`(…)	Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment.
`change_managed_list_compartment`(…)	Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.
`change_responder_recipe_compartment`(…)	Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment.
`change_saved_query_compartment`(…)	Moves the SavedQuery resource into a different compartment.
`change_security_recipe_compartment`(…)	Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment.
`change_security_zone_compartment`(…)	Moves a security zone, identified by securityZoneId, to a different compartment.
`create_adhoc_query`(…)	Creates a AdhocQuery resource.
`create_data_mask_rule`(…)	Creates a new DataMaskRule resource definition.
`create_data_source`(…)	Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.
`create_detector_recipe`(…)	Creates a new DetectorRecipe resource.
`create_detector_recipe_detector_rule`(…)	Creates a detector rule.
`create_managed_list`(…)	Creates a new ManagedList resource.
`create_responder_recipe`(…)	Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.
`create_saved_query`(…)	Creates a SavedQuery resource.
`create_security_recipe`(…)	Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.
`create_security_zone`(…)	Creates a security zone (SecurityZone resource) for a compartment.
`create_target`(create_target_details, **kwargs)	Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.
`create_target_detector_recipe`(target_id, …)	Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.
`create_target_responder_recipe`(target_id, …)	Attaches a responder recipe to a target.
`create_wlp_agent`(create_wlp_agent_details, …)	Creates and registers a WLP agent for an on-premise resource.
`delete_adhoc_query`(adhoc_query_id, **kwargs)	Deletes a AdhocQuery resource identified by adhocQueryId.
`delete_data_mask_rule`(data_mask_rule_id, …)	Deletes a DataMaskRule resource, identified by dataMaskRuleId.
`delete_data_source`(data_source_id, **kwargs)	Deletes a data source (DataSource resource) identified by dataSourceId.
`delete_detector_recipe`(detector_recipe_id, …)	Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
`delete_detector_recipe_detector_rule`(…)	Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.
`delete_detector_recipe_detector_rule_data_source`(…)	Deletes 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, …)	Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
`delete_saved_query`(saved_query_id, **kwargs)	Deletes a SavedQuery resource identified by savedQueryId.
`delete_security_recipe`(security_recipe_id, …)	Deletes a security zone recipe, identified by securityRecipeId.
`delete_security_zone`(security_zone_id, **kwargs)	Deletes a security zone, identified by securityZoneId.
`delete_target`(target_id, **kwargs)	Deletes a target (Target resource) identified by targetId.
`delete_target_detector_recipe`(target_id, …)	Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.
`delete_target_responder_recipe`(target_id, …)	Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.
`delete_wlp_agent`(wlp_agent_id, **kwargs)	Deletes and unregisters the WLP agent for an on-premise resource.
`execute_responder_execution`(…)	Executes the responder execution.
`get_adhoc_query`(adhoc_query_id, **kwargs)	Returns an adhoc query identified by adhocQueryId.
`get_adhoc_query_result_content`(…)	Downloads the results for a given adhoc ID (from includes results from all monitoring regions).
`get_condition_metadata_type`(…)	Returns a ConditionMetatDataType resource 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 resource, identified by dataMaskRuleId.
`get_data_source`(data_source_id, **kwargs)	Returns a data source (DataSource resource) identified by dataSourceId.
`get_detector`(detector_id, **kwargs)	Returns a Detector resource, identified by detectorId.
`get_detector_recipe`(detector_recipe_id, **kwargs)	Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
`get_detector_recipe_detector_rule`(…)	Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
`get_detector_rule`(detector_id, …)	Returns a detector rule (DetectorRule resource) 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 resource identified by problemId.
`get_resource`(resource_id, **kwargs)	Returns a resource identified by resourceId
`get_resource_profile`(resource_profile_id, …)	Returns details for a resource profile, identified by resourceProfileId.
`get_resource_vulnerability`(resource_id, …)	Returns the vulnerability details associated with the cveId where resource is an instance
`get_responder_execution`(…)	Returns a responder execution identified by responderExecutionId.
`get_responder_recipe`(responder_recipe_id, …)	Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
`get_responder_recipe_responder_rule`(…)	Returns a responder rule (ResponderRule resource) identified by responderRuleId.
`get_responder_rule`(responder_rule_id, **kwargs)	Returns a responder rule (ResponderRule resource) identified by resonderRuleId.
`get_saved_query`(saved_query_id, **kwargs)	Returns a SavedQuery resource identified by savedQueryId.
`get_security_policy`(security_policy_id, **kwargs)	Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId).
`get_security_recipe`(security_recipe_id, **kwargs)	Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
`get_security_zone`(security_zone_id, **kwargs)	Returns a security zone (SecurityZone resource) identified by securityZoneId.
`get_sighting`(sighting_id, **kwargs)	Returns a single sighting (Sighting resource) identified by sightingId.
`get_target`(target_id, **kwargs)	Returns a target (Target resource) identified by targetId.
`get_target_detector_recipe`(target_id, …)	Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.
`get_target_detector_recipe_detector_rule`(…)	Returns DetectorRule resource by identified by targetDetectorRecipeId.
`get_target_responder_recipe`(target_id, …)	Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.
`get_target_responder_recipe_responder_rule`(…)	Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.
`get_wlp_agent`(wlp_agent_id, **kwargs)	Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.
`get_work_request`(work_request_id, **kwargs)	Returns details for a work request (WorkRequest resource) identified by workRequestId.
`list_adhoc_queries`(compartment_id, **kwargs)	Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId.
`list_adhoc_query_results`(adhoc_query_id, …)	Lists the results for a given adhoc ID (from includes results from all monitoring regions).
`list_condition_metadata_types`(…)	Returns a list of ConditionMetadataType resources.
`list_data_mask_rules`(compartment_id, **kwargs)	Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.
`list_data_source_events`(data_source_id, **kwargs)	Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.
`list_data_sources`(compartment_id, **kwargs)	Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId.
`list_detector_recipe_detector_rules`(…)	Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.
`list_detector_recipes`(compartment_id, **kwargs)	Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.
`list_detector_rules`(detector_id, …)	Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.
`list_detectors`(compartment_id, **kwargs)	Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.
`list_impacted_resources`(problem_id, **kwargs)	Returns a list of impacted resources for a problem identified by problemId.
`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 resources 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 problem.
`list_problem_histories`(compartment_id, …)	Returns a list of actions taken on a 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 recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.
`list_resource_ports`(resource_id, **kwargs)	Returns the list of open ports associated with the resourceId where resource is an instance
`list_resource_profile_endpoints`(…)	Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.
`list_resource_profile_impacted_resources`(…)	Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.
`list_resource_profiles`(compartment_id, **kwargs)	Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.
`list_resource_types`(compartment_id, **kwargs)	Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.
`list_resource_vulnerabilities`(resource_id, …)	Returns the list of vulnerabilities associated with the resourceId where resource is an instance
`list_resources`(compartment_id, **kwargs)	Returns a list of all resources in a compartment
`list_responder_activities`(problem_id, **kwargs)	Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.
`list_responder_executions`(compartment_id, …)	Returns a list of responder executions.
`list_responder_recipe_responder_rules`(…)	Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.
`list_responder_recipes`(compartment_id, **kwargs)	Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.
`list_responder_rules`(compartment_id, **kwargs)	Returns a list of responder rules for the ResponderRecipe resource identified by responderId.
`list_saved_queries`(compartment_id, **kwargs)	Returns a list of saved queries run in a tenancy.
`list_security_policies`(compartment_id, **kwargs)	Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.
`list_security_recipes`(compartment_id, **kwargs)	Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.
`list_security_zones`(compartment_id, **kwargs)	Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId.
`list_sighting_endpoints`(sighting_id, **kwargs)	Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.
`list_sighting_impacted_resources`(…)	Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.
`list_sightings`(compartment_id, **kwargs)	For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.
`list_tactics`(compartment_id, **kwargs)	Returns a list of TacticSummary resources for a compartment, identified by compartmentId.
`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 target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId.
`list_target_responder_recipe_responder_rules`(…)	Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target.
`list_target_responder_recipes`(target_id, …)	Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.
`list_targets`(compartment_id, **kwargs)	Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId.
`list_techniques`(compartment_id, **kwargs)	Returns a list of techniques associated with detector rules.
`list_wlp_agents`(compartment_id, **kwargs)	Returns a list of WLP agents in a compartment.
`list_work_request_errors`(work_request_id, …)	Returns a list of errors for a work request identified by workRequestId.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.
`list_work_requests`(compartment_id, **kwargs)	Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.
`remove_compartment`(security_zone_id, …)	Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId.
`request_risk_scores`(compartment_id, **kwargs)	Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.
`request_security_score_summarized_trend`(…)	Returns a page of SecurityScoreTrendAggregation resources.
`request_security_scores`(compartment_id, **kwargs)	Returns a page of SecurityScoreAggregation resources.
`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, identified by parameters specified, in a page of ResponderExecutionAggregation resources.
`request_summarized_risk_scores`(…)	DEPRECATED
`request_summarized_security_scores`(…)	DEPRECATED
`request_summarized_top_trend_resource_profile_risk_scores`(…)	Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.
`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`(…)	Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.
`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`(…)	Updates 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 resource) identified by dataMaskRuleId.
`update_data_source`(data_source_id, …)	Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.
`update_detector_recipe`(detector_recipe_id, …)	Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
`update_detector_recipe_detector_rule`(…)	Updates a detector rule (DetectorRule resource) identified by detectorRuleId.
`update_managed_list`(managed_list_id, …)	Updates a ManagedList resource, 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, …)	Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.
`update_responder_recipe_responder_rule`(…)	Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.
`update_saved_query`(saved_query_id, …)	Updates a saved query identified by savedQueryId.
`update_security_recipe`(security_recipe_id, …)	Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.
`update_security_zone`(security_zone_id, …)	Updates a security zone (SecurityZone resource) identified by securityZoneId.
`update_target`(target_id, …)	Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.
`update_target_detector_recipe`(target_id, …)	Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.
`update_target_detector_recipe_detector_rule`(…)	Updates the DetectorRule resource identified by targetDetectorRecipeId
`update_target_responder_recipe`(target_id, …)	Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId.
`update_target_responder_recipe_responder_rule`(…)	Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId.
`update_wlp_agent`(wlp_agent_id, …)	Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.

__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)¶

Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass. 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 resource). add_compartment_details (oci.cloud_guard.models.AddCompartmentDetails) – (required) Parameters for an existing compartment to be added to a 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 a work request identified by workRequestId.

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 a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.

Parameters:	data_source_id (str) – (required) Data source OCID. change_data_source_compartment_details (oci.cloud_guard.models.ChangeDataSourceCompartmentDetails) – (required) The compartment OCID of the DataSource resource if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_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 resource), identified by detectorRecipeId, from the current compartment to another compartment. When provided, If-Match is checked against etag values of the resource.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID change_detector_recipe_compartment_details (oci.cloud_guard.models.ChangeDetectorRecipeCompartmentDetails) – (required) The target compartment OCID if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) 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 resource), identified by managedListId, from the current compartment to another compartment.

Parameters:	managed_list_id (str) – (required) The managed list OCID to be passed in the request. change_managed_list_compartment_details (oci.cloud_guard.models.ChangeManagedListCompartmentDetails) – (required) The compartment OCID 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 responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder recipe. change_responder_recipe_compartment_details (oci.cloud_guard.models.ChangeResponderRecipeCompartmentDetails) – (required) The target compartment OCID if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) 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_saved_query_compartment(saved_query_id, change_saved_query_compartment_details, **kwargs)¶

Moves the SavedQuery resource into a different compartment. When provided, If-Match is checked against etag values of the resource.

Parameters:	saved_query_id (str) – (required) Saved query OCID change_saved_query_compartment_details (oci.cloud_guard.models.ChangeSavedQueryCompartmentDetails) – (required) The compartment OCID of the SavedQuery resource if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_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_saved_query_compartment API.

change_security_recipe_compartment(security_recipe_id, change_security_recipe_compartment_details, **kwargs)¶

Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another 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 SecurityRecipe resource if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_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, identified by securityZoneId, to a different compartment. Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. 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 resource). 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_adhoc_query(create_adhoc_query_details, **kwargs)¶

Creates a AdhocQuery resource.

Parameters:	create_adhoc_query_details (oci.cloud_guard.models.CreateAdhocQueryDetails) – (required) Details for the new AdhocQuery resource 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 `AdhocQuery`
Return type:	`Response`
Example:

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

create_data_mask_rule(create_data_mask_rule_details, **kwargs)¶

Creates a new DataMaskRule resource 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 data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.

Parameters:	create_data_source_details (oci.cloud_guard.models.CreateDataSourceDetails) – (required) Details for the new DataSource resource 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 resource.

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)¶

Creates a detector rule.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID create_detector_recipe_detector_rule_details (oci.cloud_guard.models.CreateDetectorRecipeDetectorRuleDetails) – (required) The details with which detector rule is 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 resource.

Parameters:	create_managed_list_details (oci.cloud_guard.models.CreateManagedListDetails) – (required) Details for the new ManagedList resources 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)¶

Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.

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_saved_query(create_saved_query_details, **kwargs)¶

Creates a SavedQuery resource.

Parameters:	create_saved_query_details (oci.cloud_guard.models.CreateSavedQueryDetails) – (required) Details for the new SavedQuery resource 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 `SavedQuery`
Return type:	`Response`
Example:

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

create_security_recipe(create_security_recipe_details, **kwargs)¶

Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.

Parameters:	create_security_recipe_details (oci.cloud_guard.models.CreateSecurityRecipeDetails) – (required) Details for the new SecurityRecipe resource 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 (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource.

Parameters:	create_security_zone_details (oci.cloud_guard.models.CreateSecurityZoneDetails) – (required) Details for the new SecurityZone resource 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 target (Target resource), using parameters passed in a CreateTargetDetails resource.

Parameters:	create_target_details (oci.cloud_guard.models.CreateTargetDetails) – (required) Contains generic target information which is required for all target types 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)¶

Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. Attach a DetectorRecipe with the Target

Parameters:	target_id (str) – (required) OCID of the target attach_target_detector_recipe_details (oci.cloud_guard.models.AttachTargetDetectorRecipeDetails) – (required) Details for associating DetectorRecipe with 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)¶

Attaches a responder recipe to a target.

Parameters:	target_id (str) – (required) OCID of the target attach_target_responder_recipe_details (oci.cloud_guard.models.AttachTargetResponderRecipeDetails) – (required) Details for attaching a responder recipe to a 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.

create_wlp_agent(create_wlp_agent_details, **kwargs)¶

Creates and registers a WLP agent for an on-premise resource.

Parameters:	create_wlp_agent_details (oci.cloud_guard.models.CreateWlpAgentDetails) – (required) Details for the WLP agent to be created 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 `WlpAgent`
Return type:	`Response`
Example:

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

delete_adhoc_query(adhoc_query_id, **kwargs)¶

Deletes a AdhocQuery resource identified by adhocQueryId.

Parameters:	adhoc_query_id (str) – (required) Adhoc query 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_adhoc_query API.

delete_data_mask_rule(data_mask_rule_id, **kwargs)¶

Deletes a DataMaskRule resource, identified by dataMaskRuleId.

Parameters:	data_mask_rule_id (str) – (required) OCID of the data mask 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_data_mask_rule API.

delete_data_source(data_source_id, **kwargs)¶

Deletes a data source (DataSource resource) identified by dataSourceId.

Parameters:	data_source_id (str) – (required) Data source 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 resource) identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe 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 the DetectorRecipeDetectorRule resource identified by detectorRuleId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID detector_rule_id (str) – (required) The unique identifier of a 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)¶

Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID detector_rule_id (str) – (required) The unique identifier of a detector rule. data_source_id (str) – (required) Data source 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 managed 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)¶

Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder 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 None
Return type:	`Response`
Example:

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

delete_saved_query(saved_query_id, **kwargs)¶

Deletes a SavedQuery resource identified by savedQueryId.

Parameters:	saved_query_id (str) – (required) Saved query 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_saved_query API.

delete_security_recipe(security_recipe_id, **kwargs)¶

Deletes a security zone recipe, identified by securityRecipeId. 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 a security zone, identified by securityZoneId.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone resource). if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_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 (Target resource) identified by targetId.

Parameters:	target_id (str) – (required) OCID of the 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)¶

Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.

Parameters:	target_id (str) – (required) OCID of the target target_detector_recipe_id (str) – (required) OCID of the target detector 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 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)¶

Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.

Parameters:	target_id (str) – (required) OCID of the target target_responder_recipe_id (str) – (required) OCID of the target responder 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 None
Return type:	`Response`
Example:

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

delete_wlp_agent(wlp_agent_id, **kwargs)¶

Deletes and unregisters the WLP agent for an on-premise resource. x-obmcs-splat: routing:

strategy: route-to-any-ad

serviceList: [ ‘cloudguard-cp-SPLAT_ENV’ ] resources:

wlpAgent:

serviceResourceName: WlpAgent targetCompartmentId: downstream.getOr404(‘cloudguard-cp-SPLAT_ENV’, ‘GetWlpAgent’, request.resourceId).compartmentId actionKind: delete resourceOcid: request.resourceId reconciliationCanStartAfterSecs: 30 permissions: [ “WLP_AGENT_DELETE” ]

authorization:: mode: automated check: resources[‘wlpAgent’].grantedPermissions.contains(‘WLP_AGENT_DELETE’) allowCrossTenancy: true
tagStore:: mode: automated

maximumAttemptCount: 3 throttling:

perUserLimit:

rpsLimit: 15

perTenantLimit:

rpsLimit: 30

quotas:: mode: automated
search:: mode: backfilling operationResourceName: wlpAgent
lock:: mode: test operationResourceName: wlpAgent

Parameters:	wlp_agent_id (str) – (required) WLP agent 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_wlp_agent 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 unique identifier of the responder execution. compartment_id (str) – (required) The OCID 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_adhoc_query(adhoc_query_id, **kwargs)¶

Returns an adhoc query identified by adhocQueryId.

Parameters:	adhoc_query_id (str) – (required) Adhoc query 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 `AdhocQuery`
Return type:	`Response`
Example:

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

get_adhoc_query_result_content(adhoc_query_id, **kwargs)¶

Downloads the results for a given adhoc ID (from includes results from all monitoring regions).

Parameters:	adhoc_query_id (str) – (required) Adhoc query 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 stream
Return type:	`Response`
Example:

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

get_condition_metadata_type(condition_metadata_type_id, **kwargs)¶

Returns a ConditionMetatDataType resource with its details.

Parameters:	condition_metadata_type_id (str) – (required) The type of the condition metadata. Allowed values are: “ActivityCondition”, “SecurityCondition”, “CloudGuardCondition”, “InstanceSecurityCondition”, “ThreatCondition” opc_request_id (str) – (optional) The client request ID for tracing. service_type (str) – (optional) Service type filter for the condition metadata. resource_type (str) – (optional) Resource filter for the condition metadata. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/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 OCID 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 resource, identified by dataMaskRuleId.

Parameters:	data_mask_rule_id (str) – (required) OCID of the data mask 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 `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 data source (DataSource resource) identified by dataSourceId.

Parameters:	data_source_id (str) – (required) Data source 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 resource, identified by detectorId.

Parameters:	detector_id (str) – (required) Detector name. 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 resource) identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe 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 resource) identified by detectorRuleId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID detector_rule_id (str) – (required) The unique identifier of a 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 resource) identified by detectorRuleId.

Parameters:	detector_id (str) – (required) Detector name. detector_rule_id (str) – (required) The unique identifier of a 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 managed 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 resource identified by 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(resource_id, **kwargs)¶

Returns a resource identified by resourceId

Parameters:	resource_id (str) – (required) CloudGuard resource 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 `Resource`
Return type:	`Response`
Example:

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

get_resource_profile(resource_profile_id, **kwargs)¶

Returns details for a resource profile, identified by resourceProfileId.

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_resource_vulnerability(resource_id, vulnerability_key, **kwargs)¶

Returns the vulnerability details associated with the cveId where resource is an instance

Parameters:	resource_id (str) – (required) CloudGuard resource OCID vulnerability_key (str) – (required) CloudGuard vulnerability id 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 `ResourceVulnerability`
Return type:	`Response`
Example:

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

get_responder_execution(responder_execution_id, **kwargs)¶

Returns a responder execution identified by responderExecutionId.

Parameters:	responder_execution_id (str) – (required) The unique 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)¶

Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder recipe. 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)¶

Returns a responder rule (ResponderRule resource) identified by responderRuleId.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder recipe. responder_rule_id (str) – (required) Unique identifier of the responder 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 `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)¶

Returns a responder rule (ResponderRule resource) identified by resonderRuleId.

Parameters:	responder_rule_id (str) – (required) Unique identifier of the responder 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 `ResponderRule`
Return type:	`Response`
Example:

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

get_saved_query(saved_query_id, **kwargs)¶

Returns a SavedQuery resource identified by savedQueryId.

Parameters:	saved_query_id (str) – (required) Saved query 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 `SavedQuery`
Return type:	`Response`
Example:

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

get_security_policy(security_policy_id, **kwargs)¶

Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId). When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked.

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)¶

Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.

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)¶

Returns a security zone (SecurityZone resource) identified by securityZoneId.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone resource). 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 a single sighting (Sighting resource) identified by sightingId.

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 (Target resource) identified by targetId.

Parameters:	target_id (str) – (required) OCID of the 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)¶

Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.

Parameters:	target_id (str) – (required) OCID of the target target_detector_recipe_id (str) – (required) OCID of the target detector recipe. 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)¶

Returns DetectorRule resource by identified by targetDetectorRecipeId.

Parameters:	target_id (str) – (required) OCID of the target target_detector_recipe_id (str) – (required) OCID of the target detector recipe. detector_rule_id (str) – (required) The unique identifier of the 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 `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)¶

Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.

Parameters:	target_id (str) – (required) OCID of the target target_responder_recipe_id (str) – (required) OCID of the target responder recipe. 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)¶

Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.

Parameters:	target_id (str) – (required) OCID of the target target_responder_recipe_id (str) – (required) OCID of the target responder recipe. responder_rule_id (str) – (required) Unique identifier of the responder 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 `TargetResponderRecipeResponderRule`
Return type:	`Response`
Example:

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

get_wlp_agent(wlp_agent_id, **kwargs)¶

Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.

Parameters:	wlp_agent_id (str) – (required) WLP agent 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 `WlpAgent`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

Returns details for a work request (WorkRequest resource) identified by workRequestId.

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_adhoc_queries(compartment_id, **kwargs)¶

Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId. List is returned in a AdhocQueryCollection resource with page of AdhocQuerySummary resources.

The ListAdhocQueries operation returns only the adhoc queries 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 ListAdhocQueries 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 OCID of the compartment in which to list resources. adhoc_query_status (str) – (optional) The status of the adhoc query created. Default value for state is provisioning. If no value is specified state is provisioning. Allowed values are: “CREATING”, “CREATED”, “IN_PROGRESS”, “PARTIALLY_COMPLETED”, “EXPIRED”, “COMPLETED”, “FAILED” time_started_filter_query_param (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. time_ended_filter_query_param (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to 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. 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 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 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 `AdhocQueryCollection`
Return type:	`Response`
Example:

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

list_adhoc_query_results(adhoc_query_id, compartment_id, **kwargs)¶

Lists the results for a given adhoc ID (from includes results from all monitoring regions).

Parameters:	adhoc_query_id (str) – (required) Adhoc query OCID. compartment_id (str) – (required) The OCID 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. sort_order (str) – (optional) The sort order to use 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 `AdhocQueryResultCollection`
Return type:	`Response`
Example:

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

list_condition_metadata_types(compartment_id, **kwargs)¶

Returns a list of ConditionMetadataType resources.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field lifecycle 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 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 resources in the specified compartmentId (OCID) and its subcompartments.

Parameters:	compartment_id (str) – (required) The OCID 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 lifecycle 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 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 data mask rule Allowed values are: “ENABLED”, “DISABLED” target_id (str) – (optional) OCID of the target iam_group_id (str) – (optional) OCID of the IAM group 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 data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.

Parameters:	data_source_id (str) – (required) Data source OCID. region (str) – (optional) A filter to return only resource where 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 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 (DataSource resources) for a compartment identified by compartmentId. List is returned in a DataSourceCollection resource with page of DataSourceSummary resources.

The ListAdhocQueries operation returns only the adhoc queries 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 ListAdhocQueries 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 OCID 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 when their feed provider matches the given feed provider (DataSourceFeedProvider resource). Allowed values are: “LOGGINGQUERY”, “SCHEDULEDQUERY” lifecycle_state (str) – (optional) The field lifecycle 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 where 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 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 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 resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID compartment_id (str) – (required) The OCID 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 lifecycle 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 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 resources) 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 OCID 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 is returned. lifecycle_state (str) – (optional) The field lifecycle 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 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 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 resource identified by detectorId.

Parameters:	detector_id (str) – (required) Detector name. compartment_id (str) – (required) The OCID 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 lifecycle 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 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 resource) with a list of DetectorSummary resources.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return lifecycle_state (str) – (optional) The field lifecycle 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 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 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 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 OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field lifecycle 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 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 resources 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 OCID 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 is returned. lifecycle_state (str) – (optional) The field lifecycle 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 managed list. 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 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 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 OCID 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 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 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 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 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 problem.

Parameters:	compartment_id (str) – (required) The OCID 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 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 OCID 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. Allowed values are: “OPEN”, “RESOLVED”, “DISMISSED”, “DELETED” lifecycle_state (str) – (optional) The field lifecycle 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 or province of the problem. country (str) – (optional) Country of the problem. label (str) – (optional) User-defined 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. Allowed values are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_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 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 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 recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. sort_order (str) – (optional) The sort order to use 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 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 lifecycle 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 lifecycle state. Only one state can be provided. Default value for 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_ports(resource_id, **kwargs)¶

Returns the list of open ports associated with the resourceId where resource is an instance

Parameters:	resource_id (str) – (required) CloudGuard resource OCID open_port (str) – (optional) open port associated with the resource. 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 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 `ResourcePortCollection`
Return type:	`Response`
Example:

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

list_resource_profile_endpoints(resource_profile_id, **kwargs)¶

Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.

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 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 (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.

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 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 profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.

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 OCID 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 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 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 single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.

Parameters:	compartment_id (str) – (required) The OCID 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”, “IAAS_INSTANCE_SECURITY_DETECTOR” lifecycle_state (str) – (optional) The field lifecycle 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 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_resource_vulnerabilities(resource_id, **kwargs)¶

Returns the list of vulnerabilities associated with the resourceId where resource is an instance

Parameters:	resource_id (str) – (required) CloudGuard resource OCID cve_id (str) – (optional) CVE ID associated with the resource. risk_level (str) – (optional) Risk level 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 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 `ResourceVulnerabilityCollection`
Return type:	`Response`
Example:

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

list_resources(compartment_id, **kwargs)¶

Returns a list of all resources in a compartment

The ListResources operation returns only the resources 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 ListResources 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 OCID of the compartment in which to list resources. target_id (str) – (optional) The ID of the target in which to list resources. region (str) – (optional) OCI monitoring region. cvss_score (int) – (optional) Cvss score associated with the resource. cvss_score_greater_than (int) – (optional) Cvss score greater than associated with the resource. cvss_score_less_than (int) – (optional) Cvss score less than associated with the resource. cve_id (str) – (optional) CVE ID associated with the resource. risk_level (str) – (optional) Risk level of the problem. risk_level_greater_than (str) – (optional) To filter risk level greater than the one mentioned in query param risk_level_less_than (str) – (optional) To filter risk level less than the one mentioned in query param 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. Allowed values are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR” 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 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 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 `ResourceCollection`
Return type:	`Response`
Example:

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

list_responder_activities(problem_id, **kwargs)¶

Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.

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 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 OCID 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 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 unique identifier 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 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 responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder recipe. compartment_id (str) – (required) The OCID 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 lifecycle 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 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 (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId. 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 OCID 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 is returned. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) The field lifecycle 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 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 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 responder rules for the ResponderRecipe resource identified by responderId. The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources.

Parameters:	compartment_id (str) – (required) The OCID 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 lifecycle 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 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_saved_queries(compartment_id, **kwargs)¶

Returns a list of saved queries run in a tenancy.

Parameters:	compartment_id (str) – (required) The OCID 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 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 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 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 `SavedQueryCollection`
Return type:	`Response`
Example:

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

list_security_policies(compartment_id, **kwargs)¶

Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field lifecycle 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 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)¶

Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field lifecycle 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 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)¶

Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field lifecycle 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 resource). security_recipe_id (str) – (optional) The unique identifier of the security zone recipe. (SecurityRecipe resource). is_required_security_zones_in_subtree (bool) – (optional) Is 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 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 in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.

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 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)¶

Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.

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 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)¶

For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary 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 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 OCID 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 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 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 TacticSummary resources for a compartment, identified by compartmentId.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) The field lifecycle 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 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 the target target_detector_recipe_id (str) – (required) OCID of the target detector recipe. compartment_id (str) – (required) The OCID 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 lifecycle 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 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 target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId. The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.

Parameters:	target_id (str) – (required) OCID of the target compartment_id (str) – (required) The OCID 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 lifecycle 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 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 responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources.

Parameters:	target_id (str) – (required) OCID of the target target_responder_recipe_id (str) – (required) OCID of the target responder recipe. compartment_id (str) – (required) The OCID 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 lifecycle 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 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 summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.

Parameters:	target_id (str) – (required) OCID of the target compartment_id (str) – (required) The OCID 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 lifecycle 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 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 targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments.

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 targets in compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:	compartment_id (str) – (required) The OCID 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 lifecycle 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 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 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 OCID 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 lifecycle 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 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_wlp_agents(compartment_id, **kwargs)¶

Returns a list of WLP agents in a compartment.

Parameters:	compartment_id (str) – (required) The OCID 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. sort_order (str) – (optional) The sort order to use 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 `WlpAgentCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Returns a list of errors for a work request identified by workRequestId.

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 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)¶

Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.

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 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)¶

Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. status (str) – (optional) A filter to return only resources their lifecycleState matches the given operation status (OperationStatus resource). 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 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 a compartment from a security zone (SecurityZone resource), identified by securityZoneId. Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. 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 resource). 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)¶

Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.

Parameters:	compartment_id (str) – (required) The OCID 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)¶

Returns a page of SecurityScoreTrendAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected.

Parameters:	compartment_id (str) – (required) The OCID 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)¶

Returns a page of SecurityScoreAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected.

Parameters:	compartment_id (str) – (required) The OCID 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 OCID 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 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 OCID 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 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, identified by parameters specified, in a page of ResponderExecutionAggregation resources.

Setting accessLevel 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). “Not Authorized” is returned if user doesn’t have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.

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 OCID 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 responder 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 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 OCID 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 OCID 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)¶

Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.

Parameters:	compartment_id (str) – (required) The OCID 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 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 OCID 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 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)¶

Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.

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

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 unique identifier of the responder execution. compartment_id (str) – (required) The OCID 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)¶

Updates 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) Updates configuration details of Cloud Guard for a Tenancy. compartment_id (str) – (required) The OCID 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 resource) identified by dataMaskRuleId.

Parameters:	data_mask_rule_id (str) – (required) OCID of the data mask rule update_data_mask_rule_details (oci.cloud_guard.models.UpdateDataMaskRuleDetails) – (required) The data mask rule 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 (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.

Parameters:	data_source_id (str) – (required) Data source OCID. update_data_source_details (oci.cloud_guard.models.UpdateDataSourceDetails) – (required) Details for the DataSource resource 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 resource) identified by detectorRecipeId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe 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 resource) identified by detectorRuleId.

Parameters:	detector_recipe_id (str) – (required) Detector recipe OCID detector_rule_id (str) – (required) The unique identifier of a 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 resource, identified by managedList.

Parameters:	managed_list_id (str) – (required) The managed list OCID to be passed in the request. update_managed_list_details (oci.cloud_guard.models.UpdateManagedListDetails) – (required) Details for the ManagedList resource 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)¶

Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder recipe. 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)¶

Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.

Parameters:	responder_recipe_id (str) – (required) OCID of the responder recipe. responder_rule_id (str) – (required) Unique identifier of the responder rule. update_responder_recipe_responder_rule_details (oci.cloud_guard.models.UpdateResponderRecipeResponderRuleDetails) – (required) The details to be updated for responder 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 `ResponderRecipeResponderRule`
Return type:	`Response`
Example:

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

update_saved_query(saved_query_id, update_saved_query_details, **kwargs)¶

Updates a saved query identified by savedQueryId.

Parameters:	saved_query_id (str) – (required) Saved query OCID update_saved_query_details (oci.cloud_guard.models.UpdateSavedQueryDetails) – (required) Details for the SavedQuery resource 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 `SavedQuery`
Return type:	`Response`
Example:

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

update_security_recipe(security_recipe_id, update_security_recipe_details, **kwargs)¶

Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.

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 a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource.

Parameters:	security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone resource). 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 (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.

Parameters:	target_id (str) – (required) OCID of the 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)¶

Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.

Parameters:	target_id (str) – (required) OCID of the target target_detector_recipe_id (str) – (required) OCID of the target detector recipe. 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)¶

Updates the DetectorRule resource identified by targetDetectorRecipeId

Parameters:	target_id (str) – (required) OCID of the target target_detector_recipe_id (str) – (required) OCID of the target detector recipe. detector_rule_id (str) – (required) The unique identifier of the detector rule. update_target_detector_recipe_detector_rule_details (oci.cloud_guard.models.UpdateTargetDetectorRecipeDetectorRuleDetails) – (required) The details to be updated for the 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 `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)¶

Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource.

Parameters:	target_id (str) – (required) OCID of the target target_responder_recipe_id (str) – (required) OCID of the target responder recipe. 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)¶

Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.

Parameters:	target_id (str) – (required) OCID of the target target_responder_recipe_id (str) – (required) OCID of the target responder recipe. responder_rule_id (str) – (required) Unique identifier of the responder rule. update_target_responder_recipe_responder_rule_details (oci.cloud_guard.models.UpdateTargetResponderRecipeResponderRuleDetails) – (required) The details to be updated for the ResponderRule resource. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_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.

update_wlp_agent(wlp_agent_id, update_wlp_agent_details, **kwargs)¶

Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.

Parameters:	wlp_agent_id (str) – (required) WLP agent OCID. update_wlp_agent_details (oci.cloud_guard.models.UpdateWlpAgentDetails) – (required) Details for the WlpAgent resource 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 `WlpAgent`
Return type:	`Response`
Example:

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