OperatorControlAssignmentClient¶

class oci.operator_access_control.OperatorControlAssignmentClient(config, **kwargs)¶

Operator Access Control enables you to control the time duration and the actions an Oracle operator can perform on your Exadata Cloud@Customer infrastructure. Using logging service, you can view a near real-time audit report of all actions performed by an Oracle operator.

Use the table of contents and search tool to explore the OperatorAccessControl API.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_operator_control_assignment_compartment`(…)	Changes the compartment of the specified Operator Control assignment ID.
`create_operator_control_assignment`(…)	Creates an Operator Control Assignment resource.
`delete_operator_control_assignment`(…)	Deletes the specified Operator Control Assignment.
`get_assignment_validation_status`(…)	Returns the status of assignment validation associated with the assignmentId and the executionId.
`get_operator_control_assignment`(…)	Gets the details of an Operator Control Assignment of the specified ID.
`list_operator_control_assignments`(…)	Lists all Operator Control Assignments.
`update_operator_control_assignment`(…)	Modifies the existing Operator Control assignment of the specified Operator Control assignment ID.
`validate_operator_assignment`(…)	Validates the assignment for the specified Operator Control Assignment ID.

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

change_operator_control_assignment_compartment(operator_control_assignment_id, change_operator_control_assignment_compartment_details, **kwargs)¶

Changes the compartment of the specified Operator Control assignment ID.

Parameters:	operator_control_assignment_id (str) – (required) unique OperatorControl identifier change_operator_control_assignment_compartment_details (oci.operator_access_control.models.ChangeOperatorControlAssignmentCompartmentDetails) – (required) Changes the compartment for the given operator control assignment. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation 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_operator_control_assignment_compartment API.

create_operator_control_assignment(create_operator_control_assignment_details, **kwargs)¶

Creates an Operator Control Assignment resource. In effect, this brings the target resource under the governance of the Operator Control for specified time duration.

Parameters:	create_operator_control_assignment_details (oci.operator_access_control.models.CreateOperatorControlAssignmentDetails) – (required) Details of the Operator Control Assignment. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation 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 `OperatorControlAssignment`
Return type:	`Response`
Example:

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

delete_operator_control_assignment(operator_control_assignment_id, **kwargs)¶

Deletes the specified Operator Control Assignment. This has the effect of unassigning the specific Operator Control from the target resource.

Parameters:	operator_control_assignment_id (str) – (required) unique OperatorControl identifier description (str) – (optional) reason for detachment of OperatorAssignment. 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_operator_control_assignment API.

get_assignment_validation_status(operator_control_assignment_id, **kwargs)¶

Returns the status of assignment validation associated with the assignmentId and the executionId.

Parameters:	operator_control_assignment_id (str) – (required) unique OperatorControl identifier 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 `AssignmentValidationStatus`
Return type:	`Response`
Example:

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

get_operator_control_assignment(operator_control_assignment_id, **kwargs)¶

Gets the details of an Operator Control Assignment of the specified ID.

Parameters:	operator_control_assignment_id (str) – (required) unique OperatorControl identifier 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 `OperatorControlAssignment`
Return type:	`Response`
Example:

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

list_operator_control_assignments(compartment_id, **kwargs)¶

Lists all Operator Control Assignments.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. operator_control_name (str) – (optional) A filter to return OperatorControl that match the given operatorControlName. resource_name (str) – (optional) A filter to return only resources that match the given ResourceName. resource_type (str) – (optional) A filter to return only lists of resources that match the entire given service type. lifecycle_state (str) – (optional) A filter to return only resources whose lifecycleState matches the given OperatorControlAssignment lifecycleState. Allowed values are: “CREATED”, “APPLIED”, “APPLYFAILED”, “UPDATING”, “UPDATEFAILED”, “DELETING”, “DELETED”, “DELETIONFAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. 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 `OperatorControlAssignmentCollection`
Return type:	`Response`
Example:

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

update_operator_control_assignment(operator_control_assignment_id, update_operator_control_assignment_details, **kwargs)¶

Modifies the existing Operator Control assignment of the specified Operator Control assignment ID. Modifying the assignment does not change the Operator Control assignment ID.

Parameters:	operator_control_assignment_id (str) – (required) unique OperatorControl identifier update_operator_control_assignment_details (oci.operator_access_control.models.UpdateOperatorControlAssignmentDetails) – (required) Details for the new operator control assignment. 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 `OperatorControlAssignment`
Return type:	`Response`
Example:

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

validate_operator_assignment(operator_control_assignment_id, validate_operator_assignment_details, **kwargs)¶

Validates the assignment for the specified Operator Control Assignment ID.

Parameters:	operator_control_assignment_id (str) – (required) unique OperatorControl identifier validate_operator_assignment_details (oci.operator_access_control.models.ValidateOperatorAssignmentDetails) – (required) Contains details required for validating Operator Assignment Details. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation 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 validate_operator_assignment API.