CloudGuardClientCompositeOperations

class oci.cloud_guard.CloudGuardClientCompositeOperations(client, **kwargs)

This class provides a wrapper around CloudGuardClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

__init__(client, **kwargs) Creates a new CloudGuardClientCompositeOperations object
add_compartment_and_wait_for_state(…[, …]) Calls add_compartment() and waits for the SecurityZone acted upon to enter the given state(s).
change_data_source_compartment_and_wait_for_state(…) Calls change_data_source_compartment() and waits for the WorkRequest to enter the given state(s).
create_adhoc_query_and_wait_for_state(…[, …]) Calls create_adhoc_query() and waits for the AdhocQuery acted upon to enter the given state(s).
create_data_mask_rule_and_wait_for_state(…) Calls create_data_mask_rule() and waits for the DataMaskRule acted upon to enter the given state(s).
create_data_source_and_wait_for_state(…[, …]) Calls create_data_source() and waits for the WorkRequest to enter the given state(s).
create_detector_recipe_and_wait_for_state(…) Calls create_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).
create_detector_recipe_detector_rule_and_wait_for_state(…) Calls create_detector_recipe_detector_rule() and waits for the DetectorRecipeDetectorRule acted upon to enter the given state(s).
create_managed_list_and_wait_for_state(…) Calls create_managed_list() and waits for the ManagedList acted upon to enter the given state(s).
create_responder_recipe_and_wait_for_state(…) Calls create_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).
create_saved_query_and_wait_for_state(…[, …]) Calls create_saved_query() and waits for the SavedQuery acted upon to enter the given state(s).
create_security_recipe_and_wait_for_state(…) Calls create_security_recipe() and waits for the SecurityRecipe acted upon to enter the given state(s).
create_security_zone_and_wait_for_state(…) Calls create_security_zone() and waits for the SecurityZone acted upon to enter the given state(s).
create_target_and_wait_for_state(…[, …]) Calls create_target() and waits for the Target acted upon to enter the given state(s).
create_target_detector_recipe_and_wait_for_state(…) Calls create_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).
delete_adhoc_query_and_wait_for_state(…[, …]) Calls delete_adhoc_query() and waits for the AdhocQuery acted upon to enter the given state(s).
delete_data_mask_rule_and_wait_for_state(…) Calls delete_data_mask_rule() and waits for the DataMaskRule acted upon to enter the given state(s).
delete_data_source_and_wait_for_state(…[, …]) Calls delete_data_source() and waits for the WorkRequest to enter the given state(s).
delete_detector_recipe_and_wait_for_state(…) Calls delete_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).
delete_managed_list_and_wait_for_state(…) Calls delete_managed_list() and waits for the ManagedList acted upon to enter the given state(s).
delete_responder_recipe_and_wait_for_state(…) Calls delete_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).
delete_saved_query_and_wait_for_state(…[, …]) Calls delete_saved_query() and waits for the SavedQuery acted upon to enter the given state(s).
delete_security_recipe_and_wait_for_state(…) Calls delete_security_recipe() and waits for the SecurityRecipe acted upon to enter the given state(s).
delete_security_zone_and_wait_for_state(…) Calls delete_security_zone() and waits for the SecurityZone acted upon to enter the given state(s).
delete_target_and_wait_for_state(target_id) Calls delete_target() and waits for the Target acted upon to enter the given state(s).
remove_compartment_and_wait_for_state(…[, …]) Calls remove_compartment() and waits for the SecurityZone acted upon to enter the given state(s).
update_data_mask_rule_and_wait_for_state(…) Calls update_data_mask_rule() and waits for the DataMaskRule acted upon to enter the given state(s).
update_data_source_and_wait_for_state(…[, …]) Calls update_data_source() and waits for the WorkRequest to enter the given state(s).
update_detector_recipe_and_wait_for_state(…) Calls update_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).
update_detector_recipe_detector_rule_and_wait_for_state(…) Calls update_detector_recipe_detector_rule() and waits for the DetectorRecipeDetectorRule acted upon to enter the given state(s).
update_managed_list_and_wait_for_state(…) Calls update_managed_list() and waits for the ManagedList acted upon to enter the given state(s).
update_problem_status_and_wait_for_state(…) Calls update_problem_status() and waits for the Problem acted upon to enter the given state(s).
update_responder_recipe_and_wait_for_state(…) Calls update_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).
update_responder_recipe_responder_rule_and_wait_for_state(…) Calls update_responder_recipe_responder_rule() and waits for the ResponderRecipeResponderRule acted upon to enter the given state(s).
update_saved_query_and_wait_for_state(…[, …]) Calls update_saved_query() and waits for the SavedQuery acted upon to enter the given state(s).
update_security_recipe_and_wait_for_state(…) Calls update_security_recipe() and waits for the SecurityRecipe acted upon to enter the given state(s).
update_security_zone_and_wait_for_state(…) Calls update_security_zone() and waits for the SecurityZone acted upon to enter the given state(s).
update_target_and_wait_for_state(target_id, …) Calls update_target() and waits for the Target acted upon to enter the given state(s).
update_target_detector_recipe_and_wait_for_state(…) Calls update_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).
update_target_detector_recipe_detector_rule_and_wait_for_state(…) Calls update_target_detector_recipe_detector_rule() and waits for the TargetDetectorRecipeDetectorRule acted upon to enter the given state(s).
update_target_responder_recipe_responder_rule_and_wait_for_state(…) Calls update_target_responder_recipe_responder_rule() and waits for the TargetResponderRecipeResponderRule acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new CloudGuardClientCompositeOperations object

Parameters:client (CloudGuardClient) – The service client which will be wrapped by this object
add_compartment_and_wait_for_state(security_zone_id, add_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls add_compartment() and waits for the SecurityZone acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to add_compartment()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
change_data_source_compartment_and_wait_for_state(data_source_id, change_data_source_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_data_source_compartment() and waits for the WorkRequest to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_data_source_compartment()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_adhoc_query_and_wait_for_state(create_adhoc_query_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_adhoc_query() and waits for the AdhocQuery acted upon to enter the given state(s).

Parameters:
  • create_adhoc_query_details (oci.cloud_guard.models.CreateAdhocQueryDetails) – (required) Details for the new AdhocQuery resource
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_adhoc_query()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_data_mask_rule_and_wait_for_state(create_data_mask_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_data_mask_rule() and waits for the DataMaskRule acted upon to enter the given state(s).

Parameters:
  • create_data_mask_rule_details (oci.cloud_guard.models.CreateDataMaskRuleDetails) – (required) Definition for the new data mask rule
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_data_mask_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_data_source_and_wait_for_state(create_data_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_data_source() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • create_data_source_details (oci.cloud_guard.models.CreateDataSourceDetails) – (required) Details for the new DataSource resource
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_data_source()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_detector_recipe_and_wait_for_state(create_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).

Parameters:
  • create_detector_recipe_details (oci.cloud_guard.models.CreateDetectorRecipeDetails) – (required) Details for the new DetectorRecipe
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_detector_recipe_detector_rule_and_wait_for_state(detector_recipe_id, create_detector_recipe_detector_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_detector_recipe_detector_rule() and waits for the DetectorRecipeDetectorRule acted upon to enter the given state(s).

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.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_detector_recipe_detector_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_managed_list_and_wait_for_state(create_managed_list_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_managed_list() and waits for the ManagedList acted upon to enter the given state(s).

Parameters:
  • create_managed_list_details (oci.cloud_guard.models.CreateManagedListDetails) – (required) Details for the new ManagedList resources
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_managed_list()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_responder_recipe_and_wait_for_state(create_responder_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).

Parameters:
  • create_responder_recipe_details (oci.cloud_guard.models.CreateResponderRecipeDetails) – (required) Details for ResponderRecipe
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_responder_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_saved_query_and_wait_for_state(create_saved_query_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_saved_query() and waits for the SavedQuery acted upon to enter the given state(s).

Parameters:
  • create_saved_query_details (oci.cloud_guard.models.CreateSavedQueryDetails) – (required) Details for the new SavedQuery resource
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_saved_query()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_security_recipe_and_wait_for_state(create_security_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_security_recipe() and waits for the SecurityRecipe acted upon to enter the given state(s).

Parameters:
  • create_security_recipe_details (oci.cloud_guard.models.CreateSecurityRecipeDetails) – (required) Details for the new SecurityRecipe resource
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_security_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_security_zone_and_wait_for_state(create_security_zone_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_security_zone() and waits for the SecurityZone acted upon to enter the given state(s).

Parameters:
  • create_security_zone_details (oci.cloud_guard.models.CreateSecurityZoneDetails) – (required) Details for the new SecurityZone resource
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_security_zone()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_target_and_wait_for_state(create_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_target() and waits for the Target acted upon to enter the given state(s).

Parameters:
  • create_target_details (oci.cloud_guard.models.CreateTargetDetails) – (required) Contains generic target information which is required for all target types
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_target()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_target_detector_recipe_and_wait_for_state(target_id, attach_target_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_target_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_adhoc_query_and_wait_for_state(adhoc_query_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_adhoc_query() and waits for the AdhocQuery acted upon to enter the given state(s).

Parameters:
  • adhoc_query_id (str) – (required) Adhoc query OCID.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_adhoc_query()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_data_mask_rule_and_wait_for_state(data_mask_rule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_data_mask_rule() and waits for the DataMaskRule acted upon to enter the given state(s).

Parameters:
  • data_mask_rule_id (str) – (required) OCID of the data mask rule
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_data_mask_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_data_source_and_wait_for_state(data_source_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_data_source() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • data_source_id (str) – (required) Data source OCID.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_data_source()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_detector_recipe_and_wait_for_state(detector_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).

Parameters:
  • detector_recipe_id (str) – (required) Detector recipe OCID
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_managed_list_and_wait_for_state(managed_list_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_managed_list() and waits for the ManagedList acted upon to enter the given state(s).

Parameters:
  • managed_list_id (str) – (required) The managed list OCID to be passed in the request.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_managed_list()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_responder_recipe_and_wait_for_state(responder_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).

Parameters:
  • responder_recipe_id (str) – (required) OCID of the responder recipe.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_responder_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_saved_query_and_wait_for_state(saved_query_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_saved_query() and waits for the SavedQuery acted upon to enter the given state(s).

Parameters:
  • saved_query_id (str) – (required) Saved query OCID
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_saved_query()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_security_recipe_and_wait_for_state(security_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_security_recipe() and waits for the SecurityRecipe acted upon to enter the given state(s).

Parameters:
  • security_recipe_id (str) – (required) The unique identifier of the security zone recipe. (SecurityRecipe)
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_security_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_security_zone_and_wait_for_state(security_zone_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_security_zone() and waits for the SecurityZone acted upon to enter the given state(s).

Parameters:
  • security_zone_id (str) – (required) The unique identifier of the security zone (SecurityZone resource).
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_security_zone()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_target_and_wait_for_state(target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_target() and waits for the Target acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of the target
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_target()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
remove_compartment_and_wait_for_state(security_zone_id, remove_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls remove_compartment() and waits for the SecurityZone acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to remove_compartment()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_data_mask_rule_and_wait_for_state(data_mask_rule_id, update_data_mask_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_data_mask_rule() and waits for the DataMaskRule acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_data_mask_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_data_source_and_wait_for_state(data_source_id, update_data_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_data_source() and waits for the WorkRequest to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_data_source()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_detector_recipe_and_wait_for_state(detector_recipe_id, update_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_detector_recipe_detector_rule_and_wait_for_state(detector_recipe_id, detector_rule_id, update_detector_recipe_detector_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_detector_recipe_detector_rule() and waits for the DetectorRecipeDetectorRule acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_detector_recipe_detector_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_managed_list_and_wait_for_state(managed_list_id, update_managed_list_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_managed_list() and waits for the ManagedList acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_managed_list()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_problem_status_and_wait_for_state(problem_id, update_problem_status_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_problem_status() and waits for the Problem acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_problem_status()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_responder_recipe_and_wait_for_state(responder_recipe_id, update_responder_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_responder_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_responder_recipe_responder_rule_and_wait_for_state(responder_recipe_id, responder_rule_id, update_responder_recipe_responder_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_responder_recipe_responder_rule() and waits for the ResponderRecipeResponderRule acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_responder_recipe_responder_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_saved_query_and_wait_for_state(saved_query_id, update_saved_query_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_saved_query() and waits for the SavedQuery acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_saved_query()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_security_recipe_and_wait_for_state(security_recipe_id, update_security_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_security_recipe() and waits for the SecurityRecipe acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_security_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_security_zone_and_wait_for_state(security_zone_id, update_security_zone_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_security_zone() and waits for the SecurityZone acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_security_zone()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_and_wait_for_state(target_id, update_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target() and waits for the Target acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of the target
  • update_target_details (oci.cloud_guard.models.UpdateTargetDetails) – (required) The information to be updated
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_detector_recipe_and_wait_for_state(target_id, target_detector_recipe_id, update_target_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_detector_recipe_detector_rule_and_wait_for_state(target_id, target_detector_recipe_id, detector_rule_id, update_target_detector_recipe_detector_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target_detector_recipe_detector_rule() and waits for the TargetDetectorRecipeDetectorRule acted upon to enter the given state(s).

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
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target_detector_recipe_detector_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_responder_recipe_responder_rule_and_wait_for_state(target_id, target_responder_recipe_id, responder_rule_id, update_target_responder_recipe_responder_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target_responder_recipe_responder_rule() and waits for the TargetResponderRecipeResponderRule acted upon to enter the given state(s).

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.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target_responder_recipe_responder_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait