CloudGuardClient

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

A description of the Cloud Guard APIs

Methods

__init__(config, **kwargs) Creates a new service client
change_detector_recipe_compartment(…) Moves the DetectorRecipe from current compartment to another.
change_managed_list_compartment(…) Moves the ManagedList from current compartment to another.
change_responder_recipe_compartment(…) Moves the ResponderRecipe from current compartment to another.
create_detector_recipe(…) Creates a DetectorRecipe
create_managed_list(…) Creates a new ManagedList.
create_responder_recipe(…) Create a ResponderRecipe.
create_target(create_target_details, **kwargs) Creates a new Target
create_target_detector_recipe(target_id, …) Attach a DetectorRecipe with the Target
create_target_responder_recipe(target_id, …) Attach a ResponderRecipe with the Target
delete_detector_recipe(detector_recipe_id, …) Deletes a DetectorRecipe identified by detectorRecipeId
delete_managed_list(managed_list_id, **kwargs) Deletes a managed list identified by managedListId
delete_responder_recipe(responder_recipe_id, …) Delete the ResponderRecipe resource by identifier
delete_target(target_id, **kwargs) Deletes a Target identified by targetId
delete_target_detector_recipe(target_id, …) Delete the TargetDetectorRecipe resource by identifier
delete_target_responder_recipe(target_id, …) Delete the TargetResponderRecipe resource by identifier
execute_responder_execution(…) Executes the responder execution.
get_condition_metadata_type(…) Returns ConditionType with its details.
get_configuration(compartment_id, **kwargs) GET Cloud Guard Configuration Details for a Tenancy.
get_detector(detector_id, **kwargs) Returns a Detector identified by detectorId.
get_detector_recipe(detector_recipe_id, **kwargs) Returns a DetectorRecipe identified by detectorRecipeId
get_detector_recipe_detector_rule(…) Get DetectorRule by identifier
get_detector_rule(detector_id, …) Returns a Detector Rule identified by detectorRuleId
get_managed_list(managed_list_id, **kwargs) Returns a managed list identified by managedListId
get_problem(problem_id, **kwargs) Returns a Problems response
get_responder_execution(…) Returns a Responder Execution identified by responderExecutionId
get_responder_recipe(responder_recipe_id, …) Get a ResponderRecipe by identifier
get_responder_recipe_responder_rule(…) Get ResponderRule by identifier
get_responder_rule(responder_rule_id, **kwargs) Get a ResponderRule by identifier
get_target(target_id, **kwargs) Returns a Target identified by targetId
get_target_detector_recipe(target_id, …) Get a TargetDetectorRecipe by identifier
get_target_detector_recipe_detector_rule(…) Get DetectorRule by identifier
get_target_responder_recipe(target_id, …) Get a TargetResponderRecipe by identifier
get_target_responder_recipe_responder_rule(…) Get ResponderRule by identifier
list_condition_metadata_types(…) Returns a list of condition types.
list_detector_recipe_detector_rules(…) Returns a list of DetectorRule associated with DetectorRecipe.
list_detector_recipes(compartment_id, **kwargs) Returns a list of all Detector Recipes in a compartment
list_detector_rules(detector_id, …) Returns a list of detector rules for the detectorId passed.
list_detectors(compartment_id, **kwargs) Returns detector catalog - list of detectors supported by Cloud Guard
list_impacted_resources(problem_id, **kwargs) Returns a list of Impacted Resources for a CloudGuard Problem
list_managed_list_types(compartment_id, **kwargs) Returns all ManagedList types supported by Cloud Guard
list_managed_lists(compartment_id, **kwargs) Returns a list of ListManagedLists.
list_problem_histories(compartment_id, …) Returns a list of Actions done on CloudGuard Problem
list_problems(compartment_id, **kwargs) Returns a list of all Problems identified by the Cloud Guard
list_recommendations(compartment_id, **kwargs) Returns a list of all Recommendations.
list_resource_types(compartment_id, **kwargs) Returns a list of resource types.
list_responder_activities(problem_id, **kwargs) Returns a list of Responder activities done on CloudGuard Problem
list_responder_executions(compartment_id, …) Returns a list of Responder Executions.
list_responder_recipe_responder_rules(…) Returns a list of ResponderRule associated with ResponderRecipe.
list_responder_recipes(compartment_id, **kwargs) Returns a list of all ResponderRecipes in a compartment The ListResponderRecipe operation returns only the targets in compartmentId passed.
list_responder_rules(compartment_id, **kwargs) Returns a list of ResponderRule.
list_target_detector_recipe_detector_rules(…) Returns a list of DetectorRule associated with DetectorRecipe within a Target.
list_target_detector_recipes(target_id, …) Returns a list of all detector recipes associated with the target identified by targetId
list_target_responder_recipe_responder_rules(…) Returns a list of ResponderRule associated with ResponderRecipe within a Target.
list_target_responder_recipes(target_id, …) Returns a list of all responder recipes associated with the target identified by targetId
list_targets(compartment_id, **kwargs) Returns a list of all Targets in a compartment The ListTargets operation returns only the targets in compartmentId passed.
request_risk_scores(compartment_id, **kwargs) Examines the number of problems related to the resource and the relative severity of those problems.
request_security_score_summarized_trend(…) Measures the number of resources examined across all regions and compares it with the number of problems detected, for a given time period.
request_security_scores(compartment_id, **kwargs) Measures the number of resources examined across all regions and compares it with the number of problems detected.
request_summarized_activity_problems(…) Returns the summary of Activity type problems identified by cloud guard, for a given set of dimensions.
request_summarized_problems(list_dimensions, …) Returns the number of problems identified by cloud guard, for a given set of dimensions.
request_summarized_responder_executions(…) Returns the number of Responder Executions, for a given set of dimensions.
request_summarized_risk_scores(…) DEPRECATED
request_summarized_security_scores(…) DEPRECATED
request_summarized_trend_problems(…) Returns the number of problems identified by cloud guard, for a given time period.
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, …) push the problem to responder
update_bulk_problem_status(…) Updates the statuses in bulk for a list of problems
update_configuration(…) Enable/Disable Cloud Guard.
update_detector_recipe(detector_recipe_id, …) Updates a detector recipe identified by detectorRecipeId
update_detector_recipe_detector_rule(…) Update the DetectorRule by identifier
update_managed_list(managed_list_id, …) Updates a managed list identified by managedListId
update_problem_status(problem_id, …) updates the problem details
update_responder_recipe(responder_recipe_id, …) Update the ResponderRecipe resource by identifier
update_responder_recipe_responder_rule(…) Update the ResponderRule by identifier
update_target(target_id, …) Updates a Target identified by targetId
update_target_detector_recipe(target_id, …) Update the TargetDetectorRecipe resource by identifier
update_target_detector_recipe_detector_rule(…) Update the DetectorRule by identifier
update_target_responder_recipe(target_id, …) Update the TargetResponderRecipe resource by identifier
update_target_responder_recipe_responder_rule(…) Update the ResponderRule by identifier
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

change_detector_recipe_compartment(detector_recipe_id, change_detector_recipe_compartment_details, **kwargs)

Moves the DetectorRecipe from current compartment to another.

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • change_detector_recipe_compartment_details (ChangeDetectorRecipeCompartmentDetails) – (required) The target compartment id.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_managed_list_compartment(managed_list_id, change_managed_list_compartment_details, **kwargs)

Moves the ManagedList from current compartment to another.

Parameters:
  • managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request.
  • change_managed_list_compartment_details (ChangeManagedListCompartmentDetails) – (required) The compartment id of the ManagedList
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_responder_recipe_compartment(responder_recipe_id, change_responder_recipe_compartment_details, **kwargs)

Moves the ResponderRecipe from current compartment to another.

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • change_responder_recipe_compartment_details (ChangeResponderRecipeCompartmentDetails) – (required) The target compartment id.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_detector_recipe(create_detector_recipe_details, **kwargs)

Creates a DetectorRecipe

Parameters:
  • create_detector_recipe_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipe

Return type:

Response

create_managed_list(create_managed_list_details, **kwargs)

Creates a new ManagedList.

Parameters:
  • create_managed_list_details (CreateManagedListDetails) – (required) Details for the new ManagedList.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ManagedList

Return type:

Response

create_responder_recipe(create_responder_recipe_details, **kwargs)

Create a ResponderRecipe.

Parameters:
  • create_responder_recipe_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipe

Return type:

Response

create_target(create_target_details, **kwargs)

Creates a new Target

Parameters:
  • create_target_details (CreateTargetDetails) – (required) Details for the new Target.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Target

Return type:

Response

create_target_detector_recipe(target_id, attach_target_detector_recipe_details, **kwargs)

Attach a DetectorRecipe with the Target

Parameters:
  • target_id (str) – (required) OCID of target
  • attach_target_detector_recipe_details (AttachTargetDetectorRecipeDetails) – (required) Details for associating DetectorRecipe to Target
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipe

Return type:

Response

create_target_responder_recipe(target_id, attach_target_responder_recipe_details, **kwargs)

Attach a ResponderRecipe with the Target

Parameters:
  • target_id (str) – (required) OCID of target
  • attach_target_responder_recipe_details (AttachTargetResponderRecipeDetails) – (required) Details for associating ResponderRecipe to Target
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipe

Return type:

Response

delete_detector_recipe(detector_recipe_id, **kwargs)

Deletes a DetectorRecipe identified by detectorRecipeId

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_managed_list(managed_list_id, **kwargs)

Deletes a managed list identified by managedListId

Parameters:
  • managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_responder_recipe(responder_recipe_id, **kwargs)

Delete the ResponderRecipe resource by identifier

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_target(target_id, **kwargs)

Deletes a Target identified by targetId

Parameters:
  • target_id (str) – (required) OCID of target
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_target_detector_recipe(target_id, target_detector_recipe_id, **kwargs)

Delete the TargetDetectorRecipe resource by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_target_responder_recipe(target_id, target_responder_recipe_id, **kwargs)

Delete the TargetResponderRecipe resource by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

execute_responder_execution(responder_execution_id, compartment_id, **kwargs)

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

Parameters:
  • responder_execution_id (str) – (required) The identifier of the responder execution.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • execute_responder_execution_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_condition_metadata_type(condition_metadata_type_id, **kwargs)

Returns ConditionType with its details.

Parameters:
  • condition_metadata_type_id (str) –

    (required) The type of the condition meta data.

    Allowed values are: “ActivityCondition”, “SecurityCondition”, “CloudGuardCondition”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • service_type (str) – (optional) ServiceType filter for the condition meta data.
  • resource_type (str) – (optional) Resource filter for the condition meta data.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConditionMetadataType

Return type:

Response

get_configuration(compartment_id, **kwargs)

GET Cloud Guard Configuration Details for a Tenancy.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Configuration

Return type:

Response

get_detector(detector_id, **kwargs)

Returns a Detector identified by detectorId.

Parameters:
  • detector_id (str) – (required) The Name of Detector.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Detector

Return type:

Response

get_detector_recipe(detector_recipe_id, **kwargs)

Returns a DetectorRecipe identified by detectorRecipeId

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipe

Return type:

Response

get_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, **kwargs)

Get DetectorRule by identifier

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • detector_rule_id (str) – (required) The key of Detector Rule.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipeDetectorRule

Return type:

Response

get_detector_rule(detector_id, detector_rule_id, **kwargs)

Returns a Detector Rule identified by detectorRuleId

Parameters:
  • detector_id (str) – (required) The Name of Detector.
  • detector_rule_id (str) – (required) The key of Detector Rule.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRule

Return type:

Response

get_managed_list(managed_list_id, **kwargs)

Returns a managed list identified by managedListId

Parameters:
  • managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ManagedList

Return type:

Response

get_problem(problem_id, **kwargs)

Returns a Problems response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Problem

Return type:

Response

get_responder_execution(responder_execution_id, **kwargs)

Returns a Responder Execution identified by responderExecutionId

Parameters:
  • responder_execution_id (str) – (required) The identifier of the responder execution.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderExecution

Return type:

Response

get_responder_recipe(responder_recipe_id, **kwargs)

Get a ResponderRecipe by identifier

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipe

Return type:

Response

get_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, **kwargs)

Get ResponderRule by identifier

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • responder_rule_id (str) – (required) The id of ResponderRule
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipeResponderRule

Return type:

Response

get_responder_rule(responder_rule_id, **kwargs)

Get a ResponderRule by identifier

Parameters:
  • responder_rule_id (str) – (required) The id of ResponderRule
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRule

Return type:

Response

get_target(target_id, **kwargs)

Returns a Target identified by targetId

Parameters:
  • target_id (str) – (required) OCID of target
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Target

Return type:

Response

get_target_detector_recipe(target_id, target_detector_recipe_id, **kwargs)

Get a TargetDetectorRecipe by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipe

Return type:

Response

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

Get DetectorRule by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • detector_rule_id (str) – (required) The id of DetectorRule
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipeDetectorRule

Return type:

Response

get_target_responder_recipe(target_id, target_responder_recipe_id, **kwargs)

Get a TargetResponderRecipe by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipe

Return type:

Response

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

Get ResponderRule by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • responder_rule_id (str) – (required) The id of ResponderRule
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipeResponderRule

Return type:

Response

list_condition_metadata_types(compartment_id, **kwargs)

Returns a list of condition types.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConditionMetadataTypeCollection

Return type:

Response

list_detector_recipe_detector_rules(detector_recipe_id, compartment_id, **kwargs)

Returns a list of DetectorRule associated with DetectorRecipe.

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “displayName”, “riskLevel”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipeDetectorRuleCollection

Return type:

Response

list_detector_recipes(compartment_id, **kwargs)

Returns a list of all Detector Recipes in a compartment

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

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • resource_metadata_only (bool) – (optional) Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard is returned.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipeCollection

Return type:

Response

list_detector_rules(detector_id, compartment_id, **kwargs)

Returns a list of detector rules for the detectorId passed.

Parameters:
  • detector_id (str) – (required) The Name of Detector.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRuleCollection

Return type:

Response

list_detectors(compartment_id, **kwargs)

Returns detector catalog - list of detectors supported by Cloud Guard

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorCollection

Return type:

Response

list_impacted_resources(problem_id, **kwargs)

Returns a list of Impacted Resources for a CloudGuard Problem

Parameters:
  • problem_id (str) – (required) OCId of the problem.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ImpactedResourceCollection

Return type:

Response

list_managed_list_types(compartment_id, **kwargs)

Returns all ManagedList types supported by Cloud Guard

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “displayName”, “riskLevel”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ManagedListTypeCollection

Return type:

Response

list_managed_lists(compartment_id, **kwargs)

Returns a list of ListManagedLists. The ListManagedLists operation returns only the managed lists in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • resource_metadata_only (bool) – (optional) Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard is returned.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • list_type (str) –

    (optional) The type of the ManagedList.

    Allowed values are: “CIDR_BLOCK”, “USERS”, “GROUPS”, “IPV4ADDRESS”, “IPV6ADDRESS”, “RESOURCE_OCID”, “REGION”, “COUNTRY”, “STATE”, “CITY”, “TAGS”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ManagedListCollection

Return type:

Response

list_problem_histories(compartment_id, problem_id, **kwargs)

Returns a list of Actions done on CloudGuard Problem

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • problem_id (str) – (required) OCId of the problem.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ProblemHistoryCollection

Return type:

Response

list_problems(compartment_id, **kwargs)

Returns a list of all Problems identified by the Cloud Guard

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

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • time_last_detected_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s 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 today’s 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 today’s 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 today’s current time.
  • lifecycle_detail (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

    Allowed values are: “OPEN”, “RESOLVED”, “DISMISSED”

  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

    Allowed values are: “ACTIVE”, “INACTIVE”

  • region (str) – (optional) OCI Monitoring region.
  • risk_level (str) – (optional) Risk level of the Problem.
  • resource_type (str) – (optional) Resource Type associated with the resource.
  • city (str) – (optional) City of the problem.
  • state (str) – (optional) State of the problem.
  • country (str) – (optional) Country of the problem.
  • label (str) – (optional) Label associated with the Problem.
  • detector_rule_id_list (list[str]) – (optional) Comma seperated list of detector rule ids to be passed in to match against Problems.
  • detector_type (str) –

    (optional) The field to list the Problems by Detector Type. Valid values are IAAS_ACTIVITY_DETECTOR and IAAS_CONFIGURATION_DETECTOR

    Allowed values are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”

  • target_id (str) – (optional) The ID of the target in which to list resources.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • resource_id (str) – (optional) The ID of the resource associated with the problem.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default.

    Allowed values are: “riskLevel”, “timeLastDetected”, “resourceName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ProblemCollection

Return type:

Response

list_recommendations(compartment_id, **kwargs)

Returns a list of all Recommendations.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for riskLevel and timeCreated is descending. If no value is specified riskLevel is default.

    Allowed values are: “riskLevel”, “timeCreated”

  • target_id (str) – (optional) The ID of the target in which to list resources.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • lifecycle_detail (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

    Allowed values are: “OPEN”, “RESOLVED”, “DISMISSED”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecommendationSummaryCollection

Return type:

Response

list_resource_types(compartment_id, **kwargs)

Returns a list of resource types.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “displayName”, “riskLevel”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResourceTypeCollection

Return type:

Response

list_responder_activities(problem_id, **kwargs)

Returns a list of Responder activities done on CloudGuard Problem

Parameters:
  • problem_id (str) – (required) OCId of the problem.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “responderRuleName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderActivityCollection

Return type:

Response

list_responder_executions(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • responder_rule_ids (list[str]) – (optional) Responder Rule Ids filter for the Responder Executions.
  • time_created_greater_than_or_equal_to (datetime) – (optional) Creation Start time for filtering
  • time_created_less_than_or_equal_to (datetime) – (optional) Creation End time for filtering
  • time_completed_greater_than_or_equal_to (datetime) – (optional) Completion End Time
  • time_completed_less_than_or_equal_to (datetime) – (optional) Completion Start Time
  • target_id (str) – (optional) The ID of the target in which to list resources.
  • resource_type (str) – (optional) Resource Type associated with the resource.
  • responder_type (str) –

    (optional) The field to list the Responder Executions by Responder Type. Valid values are REMEDIATION and NOTIFICATION

    Allowed values are: “REMEDIATION”, “NOTIFICATION”

  • responder_execution_status (str) –

    (optional) The status of the responder execution in which to list responders.

    Allowed values are: “STARTED”, “AWAITING_CONFIRMATION”, “AWAITING_INPUT”, “SUCCEEDED”, “FAILED”, “SKIPPED”, “ALL”

  • responder_execution_mode (str) –

    (optional) The mode of the responder execution in which to list responders.

    Allowed values are: “MANUAL”, “AUTOMATED”, “ALL”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “responderRuleName”, “resourceName”, “timeCompleted”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderExecutionCollection

Return type:

Response

list_responder_recipe_responder_rules(responder_recipe_id, compartment_id, **kwargs)

Returns a list of ResponderRule associated with ResponderRecipe.

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “displayName”, “riskLevel”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipeResponderRuleCollection

Return type:

Response

list_responder_recipes(compartment_id, **kwargs)

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

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • resource_metadata_only (bool) – (optional) Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard 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 life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipeCollection

Return type:

Response

list_responder_rules(compartment_id, **kwargs)

Returns a list of ResponderRule.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRuleCollection

Return type:

Response

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

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

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “displayName”, “riskLevel”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipeDetectorRuleCollection

Return type:

Response

list_target_detector_recipes(target_id, compartment_id, **kwargs)

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

Parameters:
  • target_id (str) – (required) OCID of target
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipeCollection

Return type:

Response

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

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

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “displayName”, “riskLevel”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipeResponderRuleCollection

Return type:

Response

list_target_responder_recipes(target_id, compartment_id, **kwargs)

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

Parameters:
  • target_id (str) – (required) OCID of target
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipeCollection

Return type:

Response

list_targets(compartment_id, **kwargs)

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

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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

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

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetCollection

Return type:

Response

request_risk_scores(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RiskScoreAggregationCollection

Return type:

Response

request_security_score_summarized_trend(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • time_score_computed_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s current time - 30 days.
  • time_score_computed_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to today’s current time.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SecurityScoreTrendAggregationCollection

Return type:

Response

request_security_scores(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SecurityScoreAggregationCollection

Return type:

Response

request_summarized_activity_problems(compartment_id, **kwargs)

Returns the summary of Activity type problems identified by cloud guard, for a given set of dimensions.

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

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • limit (int) – (optional) The maximum number of items to return.
  • include_unknown_locations (bool) – (optional) Default is false. When set to true, the summary of activity problems that has unknown values for city, state or country will be included.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ActivityProblemAggregationCollection

Return type:

Response

request_summarized_problems(list_dimensions, compartment_id, **kwargs)

Returns the number of problems identified by cloud guard, for a given set of dimensions.

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

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

Parameters:
  • list_dimensions (list[str]) –

    (required) The possible attributes based on which the problems can be distinguished.

    Allowed values are: “RESOURCE_TYPE”, “REGION”, “COMPARTMENT_ID”, “RISK_LEVEL”

  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ProblemAggregationCollection

Return type:

Response

request_summarized_responder_executions(responder_executions_dimensions, compartment_id, **kwargs)

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

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

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

Parameters:
  • responder_executions_dimensions (list[str]) –

    (required) The possible attributes based on which the responder executions can be distinguished

    Allowed values are: “RESPONDER_RULE_TYPE”, “RESPONDER_EXECUTION_STATUS”

  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • responder_type_filter (list[str]) –

    (optional) The possible filters for Responder Type Dimension to distinguish Responder Executions. If no values are passed, the metric for responder executions of all reponder types are returned

    Allowed values are: “REMEDIATION”, “NOTIFICATION”

  • responder_execution_status_filter (list[str]) –

    (optional) The possible filters for Responder Type Dimension to distinguish Responder Executions. If no values are passed, the metric for responder executions of all status are returned

    Allowed values are: “STARTED”, “AWAITING_CONFIRMATION”, “SUCCEEDED”, “FAILED”, “SKIPPED”

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

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderExecutionAggregationCollection

Return type:

Response

request_summarized_risk_scores(compartment_id, **kwargs)

DEPRECATED

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RiskScoreAggregationCollection

Return type:

Response

request_summarized_security_scores(compartment_id, **kwargs)

DEPRECATED

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SecurityScoreAggregationCollection

Return type:

Response

request_summarized_trend_problems(compartment_id, **kwargs)

Returns the number of problems identified by cloud guard, for a given time period.

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • time_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 today’s 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 today’s current time.
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ProblemTrendAggregationCollection

Return type:

Response

request_summarized_trend_responder_executions(compartment_id, **kwargs)

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

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

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • time_completed_greater_than_or_equal_to (datetime) – (optional) Completion End Time
  • time_completed_less_than_or_equal_to (datetime) – (optional) Completion Start Time
  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • access_level (str) –

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

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderExecutionTrendAggregationCollection

Return type:

Response

request_summarized_trend_security_scores(compartment_id, **kwargs)

DEPRECATED

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • time_score_computed_greater_than_or_equal_to (datetime) – (optional) Start time for a filter. If start time is not specified, start time will be set to today’s current time - 30 days.
  • time_score_computed_less_than_or_equal_to (datetime) – (optional) End time for a filter. If end time is not specified, end time will be set to today’s current time.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SecurityScoreTrendAggregationCollection

Return type:

Response

skip_bulk_responder_execution(skip_bulk_responder_execution_details, **kwargs)

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

Parameters:
  • skip_bulk_responder_execution_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

skip_responder_execution(responder_execution_id, compartment_id, **kwargs)

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

Parameters:
  • responder_execution_id (str) – (required) The identifier of the responder execution.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

trigger_responder(problem_id, trigger_responder_details, **kwargs)

push the problem to responder

Parameters:
  • problem_id (str) – (required) OCId of the problem.
  • trigger_responder_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

update_bulk_problem_status(update_bulk_problem_status_details, **kwargs)

Updates the statuses in bulk for a list of problems The operation is atomic in nature

Parameters:
  • update_bulk_problem_status_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

update_configuration(update_configuration_details, compartment_id, **kwargs)

Enable/Disable Cloud Guard. The reporting region cannot be updated once created.

Parameters:
  • update_configuration_details (UpdateConfigurationDetails) – (required) Update Configuration Details of Cloud Guard for a Tenancy.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Configuration

Return type:

Response

update_detector_recipe(detector_recipe_id, update_detector_recipe_details, **kwargs)

Updates a detector recipe identified by detectorRecipeId

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • update_detector_recipe_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipe

Return type:

Response

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

Update the DetectorRule by identifier

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • detector_rule_id (str) – (required) The key of Detector Rule.
  • update_detector_recipe_detector_rule_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DetectorRecipeDetectorRule

Return type:

Response

update_managed_list(managed_list_id, update_managed_list_details, **kwargs)

Updates a managed list identified by managedListId

Parameters:
  • managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request.
  • update_managed_list_details (UpdateManagedListDetails) – (required) Details for the ManagedList to be updated
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ManagedList

Return type:

Response

update_problem_status(problem_id, update_problem_status_details, **kwargs)

updates the problem details

Parameters:
  • problem_id (str) – (required) OCId of the problem.
  • update_problem_status_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Problem

Return type:

Response

update_responder_recipe(responder_recipe_id, update_responder_recipe_details, **kwargs)

Update the ResponderRecipe resource by identifier

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • update_responder_recipe_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipe

Return type:

Response

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

Update the ResponderRule by identifier

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • responder_rule_id (str) – (required) The id of ResponderRule
  • update_responder_recipe_responder_rule_details (UpdateResponderRecipeResponderRuleDetails) – (required) The details to be updated for ResponderRule.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ResponderRecipeResponderRule

Return type:

Response

update_target(target_id, update_target_details, **kwargs)

Updates a Target identified by targetId

Parameters:
  • target_id (str) – (required) OCID of target
  • update_target_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Target

Return type:

Response

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

Update the TargetDetectorRecipe resource by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • update_target_detector_recipe_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipe

Return type:

Response

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

Update the DetectorRule by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • detector_rule_id (str) – (required) The id of DetectorRule
  • update_target_detector_recipe_detector_rule_details (UpdateTargetDetectorRecipeDetectorRuleDetails) – (required) The details to be updated for DetectorRule.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetDetectorRecipeDetectorRule

Return type:

Response

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

Update the TargetResponderRecipe resource by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • update_target_responder_recipe_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipe

Return type:

Response

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

Update the ResponderRule by identifier

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • responder_rule_id (str) – (required) The id of ResponderRule
  • update_target_responder_recipe_responder_rule_details (UpdateTargetResponderRecipeResponderRuleDetails) – (required) The details to be updated for ResponderRule.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TargetResponderRecipeResponderRule

Return type:

Response