ApplicationDependencyManagementClient¶

class oci.adm.ApplicationDependencyManagementClient(config, **kwargs)¶

Use the Application Dependency Management API to create knowledge bases and vulnerability audits. For more information, see [ADM](/Content/application-dependency-management/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`activate_remediation_recipe`(…)	Activates the specified Remediation Recipe.
`cancel_remediation_run`(remediation_run_id, …)	Cancels the specified remediation run.
`cancel_work_request`(work_request_id, **kwargs)	Cancel work request with the given ID.
`change_knowledge_base_compartment`(…)	Moves a Knowledge Base from one compartment to another.
`change_remediation_recipe_compartment`(…)	Moves a Remediation Recipe from one compartment to another.
`change_remediation_run_compartment`(…)	Moves a remediation run from one compartment to another.
`change_vulnerability_audit_compartment`(…)	Moves a Vulnerability Audit from one compartment to another.
`create_knowledge_base`(…)	Creates a new Knowledge Base.
`create_remediation_recipe`(…)	Creates a new Remediation Recipe.
`create_remediation_run`(…)	Creates a new remediation run.
`create_vulnerability_audit`(…)	Creates a new Vulnerability Audit by providing a tree of Application Dependencies.
`deactivate_remediation_recipe`(…)	Deactivates the specified Remediation Recipe.
`delete_knowledge_base`(knowledge_base_id, …)	Deletes the specified Knowledge Base.
`delete_remediation_recipe`(…)	Deletes the specified Remediation Recipe.
`delete_remediation_run`(remediation_run_id, …)	Deletes the specified remediation run.
`delete_vulnerability_audit`(…)	Deletes the specified Vulnerability Audit.
`get_knowledge_base`(knowledge_base_id, **kwargs)	Returns the details of the specified Knowledge Base.
`get_remediation_recipe`(…)	Returns the details of the specified RemediationRecipe.
`get_remediation_run`(remediation_run_id, **kwargs)	Returns the details of the specified remediation run.
`get_stage`(remediation_run_id, stage_type, …)	Returns the details of the specified Remediation Run Stage.
`get_vulnerability_audit`(…)	Returns the details of the specified Vulnerability Audit.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given ID.
`list_application_dependency_recommendations`(…)	Returns a list of application dependency with their associated recommendations.
`list_application_dependency_vulnerabilities`(…)	Returns a list of Application Dependencies with their associated vulnerabilities.
`list_knowledge_bases`(**kwargs)	Returns a list of KnowledgeBases based on the specified query parameters.
`list_remediation_recipes`(**kwargs)	Returns a list of Remediation Recipes based on the specified query parameters.
`list_remediation_runs`(**kwargs)	Returns a list of remediation runs contained by a compartment.
`list_stages`(remediation_run_id, **kwargs)	Returns a list of Remediation Run Stages based on the specified query parameters and Remediation Run identifier.
`list_vulnerability_audits`(**kwargs)	Returns a list of Vulnerability Audits based on the specified query parameters.
`list_work_request_errors`(work_request_id, …)	Return a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Return a (paginated) list of logs for a given work request.
`list_work_requests`(**kwargs)	Lists the work requests in a compartment.
`update_knowledge_base`(knowledge_base_id, …)	Updates one or more attributes of the specified Knowledge Base.
`update_remediation_recipe`(…)	Updates one or more attributes of the specified Remediation Recipe.
`update_remediation_run`(remediation_run_id, …)	Updates by identifier one or more attributes of the specified remediation run.
`update_vulnerability_audit`(…)	Updates one or more attributes of the specified Vulnerability Audit.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

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

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

activate_remediation_recipe(remediation_recipe_id, **kwargs)¶

Activates the specified Remediation Recipe.

Parameters:	remediation_recipe_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

cancel_remediation_run(remediation_run_id, **kwargs)¶

Cancels the specified remediation run.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRun`
Return type:	`Response`
Example:

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

cancel_work_request(work_request_id, **kwargs)¶

Cancel work request with the given ID.

Parameters:	work_request_id (str) – (required) The Oracle Cloud Identifier (OCID) of the asynchronous request. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_knowledge_base_compartment(knowledge_base_id, change_knowledge_base_compartment_details, **kwargs)¶

Moves a Knowledge Base from one compartment to another.

Parameters:	knowledge_base_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter. change_knowledge_base_compartment_details (oci.adm.models.ChangeKnowledgeBaseCompartmentDetails) – (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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_remediation_recipe_compartment(remediation_recipe_id, change_remediation_recipe_compartment_details, **kwargs)¶

Moves a Remediation Recipe from one compartment to another.

Parameters:	remediation_recipe_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter. change_remediation_recipe_compartment_details (oci.adm.models.ChangeRemediationRecipeCompartmentDetails) – (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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_remediation_run_compartment(remediation_run_id, change_remediation_run_compartment_details, **kwargs)¶

Moves a remediation run from one compartment to another.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. change_remediation_run_compartment_details (oci.adm.models.ChangeRemediationRunCompartmentDetails) – (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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_vulnerability_audit_compartment(vulnerability_audit_id, change_vulnerability_audit_compartment_details, **kwargs)¶

Moves a Vulnerability Audit from one compartment to another.

Parameters:	vulnerability_audit_id (str) – (required) Unique Vulnerability Audit identifier path parameter. change_vulnerability_audit_compartment_details (oci.adm.models.ChangeVulnerabilityAuditCompartmentDetails) – (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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_knowledge_base(create_knowledge_base_details, **kwargs)¶

Creates a new Knowledge Base.

Parameters:	create_knowledge_base_details (oci.adm.models.CreateKnowledgeBaseDetails) – (required) The details to create a new Knowledge Base. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_remediation_recipe(create_remediation_recipe_details, **kwargs)¶

Creates a new Remediation Recipe.

Parameters:	create_remediation_recipe_details (oci.adm.models.CreateRemediationRecipeDetails) – (required) The details to create a new Remediation Recipe. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_remediation_run(create_remediation_run_details, **kwargs)¶

Creates a new remediation run.

Parameters:	create_remediation_run_details (oci.adm.models.CreateRemediationRunDetails) – (required) The details used to create a new remediation run. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRun`
Return type:	`Response`
Example:

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

create_vulnerability_audit(create_vulnerability_audit_details, **kwargs)¶

Creates a new Vulnerability Audit by providing a tree of Application Dependencies.

Parameters:	create_vulnerability_audit_details (oci.adm.models.CreateVulnerabilityAuditDetails) – (required) The details to create a new Vulnerability Audit. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityAudit`
Return type:	`Response`
Example:

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

deactivate_remediation_recipe(remediation_recipe_id, **kwargs)¶

Deactivates the specified Remediation Recipe.

Parameters:	remediation_recipe_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_knowledge_base(knowledge_base_id, **kwargs)¶

Deletes the specified Knowledge Base.

Parameters:	knowledge_base_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_remediation_recipe(remediation_recipe_id, **kwargs)¶

Deletes the specified Remediation Recipe.

Parameters:	remediation_recipe_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_remediation_run(remediation_run_id, **kwargs)¶

Deletes the specified remediation run.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_vulnerability_audit(vulnerability_audit_id, **kwargs)¶

Deletes the specified Vulnerability Audit.

Parameters:	vulnerability_audit_id (str) – (required) Unique Vulnerability Audit identifier path parameter. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

get_knowledge_base(knowledge_base_id, **kwargs)¶

Returns the details of the specified Knowledge Base.

Parameters:	knowledge_base_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `KnowledgeBase`
Return type:	`Response`
Example:

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

get_remediation_recipe(remediation_recipe_id, **kwargs)¶

Returns the details of the specified RemediationRecipe.

Parameters:	remediation_recipe_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRecipe`
Return type:	`Response`
Example:

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

get_remediation_run(remediation_run_id, **kwargs)¶

Returns the details of the specified remediation run.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRun`
Return type:	`Response`
Example:

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

get_stage(remediation_run_id, stage_type, **kwargs)¶

Returns the details of the specified Remediation Run Stage.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. stage_type (str) – (required) The type of Remediation Run Stage, as a URL path parameter. Allowed values are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRunStage`
Return type:	`Response`
Example:

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

get_vulnerability_audit(vulnerability_audit_id, **kwargs)¶

Returns the details of the specified Vulnerability Audit.

Parameters:	vulnerability_audit_id (str) – (required) Unique Vulnerability Audit identifier path parameter. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityAudit`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

Gets the status of the work request with the given ID.

Parameters:	work_request_id (str) – (required) The Oracle Cloud Identifier (OCID) of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

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

list_application_dependency_recommendations(remediation_run_id, **kwargs)¶

Returns a list of application dependency with their associated recommendations.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” gav (str) – (optional) A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given. purl (str) – (optional) A filter to return only resources that match the entire PURL given (https://github.com/package-url/purl-spec/). sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. If sort order is dfs, the nodes are returned by going through the application dependency tree in a depth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. If sort order is bfs, the nodes are returned by going through the application dependency tree in a breadth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. Default order for gav is ascending where ascending corresponds to alphanumerical order. Default order for purl is ascending where ascending corresponds to alphabetical order Default order for nodeId is ascending where ascending corresponds to alphanumerical order. Sorting by DFS or BFS cannot be used in conjunction with the following query parameters: “gav”, “cvssV2GreaterThanOrEqual”, “cvssV3GreaterThanOrEqual” and “vulnerabilityId”. Allowed values are: “gav”, “purl”, “nodeId”, “dfs”, “bfs” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ApplicationDependencyRecommendationCollection`
Return type:	`Response`
Example:

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

list_application_dependency_vulnerabilities(vulnerability_audit_id, **kwargs)¶

Returns a list of Application Dependencies with their associated vulnerabilities.

Parameters:	vulnerability_audit_id (str) – (required) Unique Vulnerability Audit identifier path parameter. vulnerability_id (str) – (optional) A filter to return only Vulnerability Audits that match the specified id. cvss_v3_greater_than_or_equal (float) – (optional) A filter that returns only Vulnerabilities that have a Common Vulnerability Scoring System Version 3 (CVSS V3) greater than or equal to the specified value. cvss_v2_greater_than_or_equal (float) – (optional) A filter that returns only Vulnerabilities that have a Common Vulnerability Scoring System Version 2 (CVSS V2) greater than or equal to the specified value. severity_greater_than_or_equal (str) – (optional) A filter that returns only Vulnerabilities that have a severity greater than or equal to the specified value. Allowed values are: “NONE”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. 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. If sort order is dfs, the nodes are returned by going through the application dependency tree in a depth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. If sort order is bfs, the nodes are returned by going through the application dependency tree in a breadth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. Default order for gav is ascending where ascending corresponds to alphanumerical order. Default order for purl is ascending where ascending corresponds to alphabetical order Default order for nodeId is ascending where ascending corresponds to alphanumerical order. Sorting by DFS or BFS cannot be used in conjunction with the following query parameters: “gav”, “cvssV2GreaterThanOrEqual”, “cvssV3GreaterThanOrEqual” and “vulnerabilityId”. Allowed values are: “gav”, “purl”, “nodeId”, “dfs”, “bfs” root_node_id (str) – (optional) A filter to override the top level root identifier with the new given value. The application dependency tree will only be traversed from the given node. Query parameters “cvssV2GreaterThanOrEqual”, “cvssV3GreaterThanOrEqual”, “gav” and “vulnerabilityId” cannot be used in conjunction with this parameter. depth (int) – (optional) A filter to limit depth of the application dependencies tree traversal. Additionally query parameters such as “cvssV2GreaterThanOrEqual”, “cvssV3GreaterThanOrEqual”, “gav” and “vulnerabilityId” can’t be used in conjunction with this latter. gav (str) – (optional) A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given. purl (str) – (optional) A filter to return only resources that match the entire PURL given (https://github.com/package-url/purl-spec/). opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ApplicationDependencyVulnerabilityCollection`
Return type:	`Response`
Example:

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

list_knowledge_bases(**kwargs)¶

Returns a list of KnowledgeBases based on the specified query parameters. At least id or compartmentId query parameter must be provided.

Parameters:	id (str) – (optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. sort_by (str) – (optional) The field used to sort Knowledge Bases. Only one sort order is allowed. Default order for _displayName_ is ascending alphabetical order. Default order for _lifecyleState_ is the following sequence: CREATING, ACTIVE, UPDATING, FAILED, DELETING, and DELETED.Default order for _timeCreated_ is descending. Default order for _timeUpdated_ is descending. Allowed values are: “DISPLAY_NAME”, “LIFECYCLE_STATE”, “TIME_CREATED”, “TIME_UPDATED” lifecycle_state (str) – (optional) A filter to return only Knowledge Bases that match the specified lifecycleState. Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “FAILED”, “DELETING”, “DELETED” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. compartment_id (str) – (optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `KnowledgeBaseCollection`
Return type:	`Response`
Example:

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

list_remediation_recipes(**kwargs)¶

Returns a list of Remediation Recipes based on the specified query parameters. The query parameters compartmentId or id must be provided.

Parameters:	id (str) – (optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. sort_by (str) – (optional) The field used to sort Remediation Recipes. Only one sort order is allowed. Default order for _displayName_ is ascending alphabetical order. Default order for _lifecyleState_ is the following sequence: CREATING, ACTIVE, UPDATING, INACTIVE, FAILED, DELETING, and DELETED. Default order for _timeCreated_ is descending. Default order for _timeUpdated_ is descending. Default order for _type_ is the following sequence: ADM. Allowed values are: “DISPLAY_NAME”, “LIFECYCLE_STATE”, “TIME_CREATED”, “TIME_UPDATED”, “TYPE” lifecycle_state (str) – (optional) A filter to return only Remediation Recipes that match the specified lifecycleState. Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “INACTIVE”, “FAILED”, “DELETING”, “DELETED”, “NEEDS_ATTENTION” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. compartment_id (str) – (optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRecipeCollection`
Return type:	`Response`
Example:

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

list_remediation_runs(**kwargs)¶

Returns a list of remediation runs contained by a compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:	id (str) – (optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. remediation_recipe_id (str) – (optional) A filter to return only resources that match the specified Remediation Recipe identifier. lifecycle_state (str) – (optional) A filter to return only Remediation Runs that match the specified lifecycleState. Allowed values are: “ACCEPTED”, “CANCELED”, “CANCELING”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”, “DELETING”, “DELETED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field used to sort Remediation Runs. Only one sort order is allowed. Default order for _timeCreated_ is descending. Default order for _timeFinished_ is descending. Default order for _timeStarted_ is descending. Default order for _displayName_ is ascending alphabetical order. Default order for _lifecycleState_ is the following sequence: CREATING, ACTIVE, UPDATING, DELETING, DELETED, and FAILED. Default order for currentStageType is the following sequence: DETECT, RECOMMEND, VERIFY, and APPLY. Allowed values are: “timeCreated”, “timeFinished”, “timeStarted”, “displayName”, “lifecycleState”, “currentStageType” compartment_id (str) – (optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRunCollection`
Return type:	`Response`
Example:

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

list_stages(remediation_run_id, **kwargs)¶

Returns a list of Remediation Run Stages based on the specified query parameters and Remediation Run identifier.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. type (str) – (optional) A filter to return only Stages that match the specified type. Allowed values are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY” status (str) – (optional) A filter to return only Stages that match the specified status. Allowed values are: “CREATED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELING”, “CANCELED” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. sort_by (str) – (optional) The field used to sort Stages. Only one sort order is allowed. Default order for status is the following sequence: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELING, and CANCELED. Default order for _timeCreated_ is descending. Default order for _timeFinished_ is descending. Default order for _timeStarted_ is descending. Default order for _type_ is the following sequence: DETECT, RECOMMEND, VERIFY, and APPLY. Allowed values are: “status”, “timeCreated”, “timeFinished”, “timeStarted”, “type” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRunStageCollection`
Return type:	`Response`
Example:

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

list_vulnerability_audits(**kwargs)¶

Returns a list of Vulnerability Audits based on the specified query parameters. At least one of id, compartmentId query parameter must be provided.

Parameters:	id (str) – (optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. compartment_id (str) – (optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. knowledge_base_id (str) – (optional) A filter to return only Vulnerability Audits that were created against the specified knowledge base. is_success (bool) – (optional) A filter to return only successful or failed Vulnerability Audits. lifecycle_state (str) – (optional) A filter to return only Vulnerability Audits that match the specified lifecycleState. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. sort_by (str) – (optional) The field used to sort Vulnerability Audits. Only one sort order is allowed. Default order for _maxObservedCvssV2Score_ is ascending. Default order for _maxObservedCvssV3Score_ is ascending. Default order for _maxObservedCvssV2ScoreWithIgnored_ is ascending. Default order for _maxObservedCvssV3ScoreWithIgnored_ is ascending. Default order for _timeCreated_ is descending. Default order for _vulnerableArtifactsCount_ is ascending. Default order for _vulnerableArtifactsCountWithIgnored_ is ascending. Default order for _maxObservedSeverity_ is ascending. Default order for _maxObservedSeverityWithIgnored_ is ascending. Default order for _displayName_ is ascending. Allowed values are: “maxObservedCvssV2Score”, “maxObservedCvssV3Score”, “maxObservedSeverity”, “timeCreated”, “vulnerableArtifactsCount”, “maxObservedCvssV2ScoreWithIgnored”, “maxObservedCvssV3ScoreWithIgnored”, “maxObservedSeverityWithIgnored”, “vulnerableArtifactsCountWithIgnored”, “displayName” display_name (str) – (optional) A filter to return only resources that match the entire display name given. time_created_greater_than_or_equal_to (datetime) – (optional) A filter to return only Vulnerability Audits with timeCreated greater or equal to the specified value. time_created_less_than_or_equal_to (datetime) – (optional) A filter to return only Vulnerability Audits with timeCreated less or equal to the specified value. max_observed_severity_greater_than_or_equal_to (str) – (optional) A filter that returns only Vulnerability Audits that have a maximum observed Severity greater than or equal to the specified value. Allowed values are: “NONE”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityAuditCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The Oracle Cloud Identifier (OCID) of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is descending. Allowed values are: “timeAccepted” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

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

list_work_request_logs(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The Oracle Cloud Identifier (OCID) of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is descending. Allowed values are: “timeAccepted” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

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

list_work_requests(**kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. work_request_id (str) – (optional) The identifier of the asynchronous work request. status (str) – (optional) A filter to return only resources that match the specified OperationStatus. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” resource_id (str) – (optional) The Oracle Cloud Identifier (OCID) of the resource affected by the work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is descending. Allowed values are: “timeAccepted” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestSummaryCollection`
Return type:	`Response`
Example:

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

update_knowledge_base(knowledge_base_id, update_knowledge_base_details, **kwargs)¶

Updates one or more attributes of the specified Knowledge Base.

Parameters:	knowledge_base_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter. update_knowledge_base_details (oci.adm.models.UpdateKnowledgeBaseDetails) – (required) The details to update a Knowledge Base. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_remediation_recipe(remediation_recipe_id, update_remediation_recipe_details, **kwargs)¶

Updates one or more attributes of the specified Remediation Recipe.

Parameters:	remediation_recipe_id (str) – (required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter. update_remediation_recipe_details (oci.adm.models.UpdateRemediationRecipeDetails) – (required) The details to update a Remediation Recipe. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_remediation_run(remediation_run_id, update_remediation_run_details, **kwargs)¶

Updates by identifier one or more attributes of the specified remediation run.

Parameters:	remediation_run_id (str) – (required) Unique Remediation Run identifier path parameter. update_remediation_run_details (oci.adm.models.UpdateRemediationRunDetails) – (required) The details used to update a remediation run. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RemediationRun`
Return type:	`Response`
Example:

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

update_vulnerability_audit(vulnerability_audit_id, update_vulnerability_audit_details, **kwargs)¶

Updates one or more attributes of the specified Vulnerability Audit.

Parameters:	vulnerability_audit_id (str) – (required) Unique Vulnerability Audit identifier path parameter. update_vulnerability_audit_details (oci.adm.models.UpdateVulnerabilityAuditDetails) – (required) The details to update a Vulnerability Audit. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityAudit`
Return type:	`Response`
Example:

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