ZprClient¶
-
class
oci.zpr.
ZprClient
(config, **kwargs)¶ Use the Zero Trust Packet Routing Control Plane API to manage ZPR configuration and policy. See the [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/home.htm) documentation for more information.
Methods
__init__
(config, **kwargs)Creates a new service client create_configuration
(…)Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy). create_zpr_policy
(create_zpr_policy_details, …)Creates a ZprPolicy. delete_zpr_policy
(zpr_policy_id, **kwargs)Deletes a ZprPolicy. get_configuration
(**kwargs)Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy). get_zpr_configuration_work_request
(…)Gets the details of a work request. get_zpr_policy
(zpr_policy_id, **kwargs)Gets information about a ZprPolicy. get_zpr_policy_work_request
(work_request_id, …)Gets the details of a work request. list_zpr_configuration_work_request_errors
(…)Lists the errors for a work request. list_zpr_configuration_work_request_logs
(…)Lists the logs for a work request. list_zpr_configuration_work_requests
(**kwargs)Lists the work requests in a compartment. list_zpr_policies
(**kwargs)Gets a list of ZprPolicies. list_zpr_policy_work_request_errors
(…)Lists the errors for a work request. list_zpr_policy_work_request_logs
(…)Lists the logs for a work request. list_zpr_policy_work_requests
(**kwargs)Lists the work requests in a compartment. update_zpr_policy
(zpr_policy_id, …)Updates a specific ZprPolicy. -
__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, adict
can be passed. You can validate_config the dict usingvalidate_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 convenienceDEFAULT_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.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
create_configuration
(create_configuration_details, **kwargs)¶ Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy). It creates an object of ZPR configuration as part of onboarding.
Parameters: - create_configuration_details (oci.zpr.models.CreateConfigurationDetails) – (required) Details for ZPR configuration in the tenancy.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- 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 running 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 removed from the system, then a retry of the original creation request might be rejected.
- opc_dry_run (bool) – (optional) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use create_configuration API.
-
create_zpr_policy
(create_zpr_policy_details, **kwargs)¶ Creates a ZprPolicy.
Parameters: - create_zpr_policy_details (oci.zpr.models.CreateZprPolicyDetails) – (required) Details for the new ZprPolicy.
- 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 running 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 removed from the system, then a retry of the original creation request might be rejected.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- opc_dry_run (bool) – (optional) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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: Return type: Example: Click here to see an example of how to use create_zpr_policy API.
-
delete_zpr_policy
(zpr_policy_id, **kwargs)¶ Deletes a ZprPolicy.
Parameters: - zpr_policy_id (str) –
(required) The OCID of the ZprPolicy.
- 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- opc_dry_run (bool) – (optional) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use delete_zpr_policy API.
- zpr_policy_id (str) –
-
get_configuration
(**kwargs)¶ Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy). Returns ZPR configuration for root compartment (the root compartment is the tenancy).
Parameters: - compartment_id (str) –
(optional) The OCID of the compartment in which to list resources.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 typeConfiguration
Return type: Example: Click here to see an example of how to use get_configuration API.
- compartment_id (str) –
-
get_zpr_configuration_work_request
(work_request_id, **kwargs)¶ Gets the details of a work request.
Parameters: - work_request_id (str) –
(required) The OCID of the asynchronous work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 typeWorkRequest
Return type: Example: Click here to see an example of how to use get_zpr_configuration_work_request API.
- work_request_id (str) –
-
get_zpr_policy
(zpr_policy_id, **kwargs)¶ Gets information about a ZprPolicy.
Parameters: - zpr_policy_id (str) –
(required) The OCID of the ZprPolicy.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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: Return type: Example: Click here to see an example of how to use get_zpr_policy API.
- zpr_policy_id (str) –
-
get_zpr_policy_work_request
(work_request_id, **kwargs)¶ Gets the details of a work request.
Parameters: - work_request_id (str) –
(required) The OCID of the asynchronous work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 typeWorkRequest
Return type: Example: Click here to see an example of how to use get_zpr_policy_work_request API.
- work_request_id (str) –
-
list_zpr_configuration_work_request_errors
(work_request_id, **kwargs)¶ Lists the errors for a work request.
Parameters: - work_request_id (str) –
(required) The OCID of the asynchronous work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
Allowed values are: “timestamp”
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (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 usesDEFAULT_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 typeWorkRequestErrorCollection
Return type: Example: Click here to see an example of how to use list_zpr_configuration_work_request_errors API.
- work_request_id (str) –
-
list_zpr_configuration_work_request_logs
(work_request_id, **kwargs)¶ Lists the logs for a work request.
Parameters: - work_request_id (str) –
(required) The OCID of the asynchronous work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
Allowed values are: “timestamp”
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (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 usesDEFAULT_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 typeWorkRequestLogEntryCollection
Return type: Example: Click here to see an example of how to use list_zpr_configuration_work_request_logs API.
- work_request_id (str) –
-
list_zpr_configuration_work_requests
(**kwargs)¶ Lists the work requests in a compartment.
Parameters: - compartment_id (str) –
(optional) The OCID of the compartment in which to list resources.
- work_request_id (str) –
(optional) The OCID of the asynchronous work request.
- status (str) –
(optional) A filter to return only the resources that match the given lifecycle state.
Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”
- resource_id (str) –
(optional) The OCID of the resource affected by the work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (DESC).
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
Allowed values are: “timeAccepted”
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 typeWorkRequestSummaryCollection
Return type: Example: Click here to see an example of how to use list_zpr_configuration_work_requests API.
- compartment_id (str) –
-
list_zpr_policies
(**kwargs)¶ Gets a list of ZprPolicies.
Parameters: - compartment_id (str) –
(optional) The OCID of the compartment in which to list resources.
- lifecycle_state (str) –
(optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
Allowed values are: “ACTIVE”, “CREATING”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”
- name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) –
(optional) The OCID of the ZprPolicy.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (DESC).
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for name is ascending.
Allowed values are: “timeCreated”, “name”
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 typeZprPolicyCollection
Return type: Example: Click here to see an example of how to use list_zpr_policies API.
- compartment_id (str) –
-
list_zpr_policy_work_request_errors
(work_request_id, **kwargs)¶ Lists the errors for a work request.
Parameters: - work_request_id (str) –
(required) The OCID of the asynchronous work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
Allowed values are: “timestamp”
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (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 usesDEFAULT_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 typeWorkRequestErrorCollection
Return type: Example: Click here to see an example of how to use list_zpr_policy_work_request_errors API.
- work_request_id (str) –
-
list_zpr_policy_work_request_logs
(work_request_id, **kwargs)¶ Lists the logs for a work request.
Parameters: - work_request_id (str) –
(required) The OCID of the asynchronous work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
Allowed values are: “timestamp”
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (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 usesDEFAULT_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 typeWorkRequestLogEntryCollection
Return type: Example: Click here to see an example of how to use list_zpr_policy_work_request_logs API.
- work_request_id (str) –
-
list_zpr_policy_work_requests
(**kwargs)¶ Lists the work requests in a compartment.
Parameters: - compartment_id (str) –
(optional) The OCID of the compartment in which to list resources.
- work_request_id (str) –
(optional) The OCID of the asynchronous work request.
- status (str) –
(optional) A filter to return only the resources that match the given lifecycle state.
Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”
- resource_id (str) –
(optional) The OCID of the resource affected by the work request.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- page (str) –
(optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- limit (int) –
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
- sort_order (str) –
(optional) The sort order to use, either ascending (ASC) or descending (DESC).
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
Allowed values are: “timeAccepted”
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 typeWorkRequestSummaryCollection
Return type: Example: Click here to see an example of how to use list_zpr_policy_work_requests API.
- compartment_id (str) –
-
update_zpr_policy
(zpr_policy_id, update_zpr_policy_details, **kwargs)¶ Updates a specific ZprPolicy. If updating on statements, the entire list of policy statements is required, which will replace the existing policy statements associated with the policy ID.
Parameters: - zpr_policy_id (str) –
(required) The OCID of the ZprPolicy.
- update_zpr_policy_details (oci.zpr.models.UpdateZprPolicyDetails) – (required) The information to be updated.
- 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 running 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 removed from the system, then a retry of the original creation request might be rejected.
- if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
- opc_dry_run (bool) – (optional) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use update_zpr_policy API.
- zpr_policy_id (str) –
-