AccessGovernanceCPClient

class oci.access_governance_cp.AccessGovernanceCPClient(config, **kwargs)

Use the Oracle Access Governance API to create, view, and manage GovernanceInstances.

Methods

__init__(config, **kwargs)	Creates a new service client
change_governance_instance_compartment(…)	Moves a GovernanceInstance resource from one compartment identifier to another.
create_governance_instance(…)	Creates a new GovernanceInstance.
delete_governance_instance(…)	Deletes an existing GovernanceInstance.
get_governance_instance(…)	Gets a GovernanceInstance by OCID.
get_governance_instance_configuration(…)	Gets the tenancy-wide configuration for GovernanceInstances
list_governance_instances(compartment_id, …)	Returns a list of Governance Instances.
update_governance_instance(…)	Updates the GovernanceInstance.
update_governance_instance_configuration(…)	Updates the tenancy-wide configuration for GovernanceInstances

__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_governance_instance_compartment(governance_instance_id, change_governance_instance_compartment_details, **kwargs)

Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

• governance_instance_id (str) – (required) The OCID of the GovernanceInstance
• change_governance_instance_compartment_details (oci.access_governance_cp.models.ChangeGovernanceInstanceCompartmentDetails) – (required) The details to change the compartment of a GovernanceInstance.
• 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_governance_instance_compartment API.

create_governance_instance(create_governance_instance_details, **kwargs)

Creates a new GovernanceInstance.

Parameters:

• create_governance_instance_details (oci.access_governance_cp.models.CreateGovernanceInstanceDetails) – (required) The details of a new GovernanceInstance.
• 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 GovernanceInstance

Return type:

Response

Example:

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

delete_governance_instance(governance_instance_id, **kwargs)

Deletes an existing GovernanceInstance.

Parameters:

• governance_instance_id (str) – (required) The OCID of the GovernanceInstance
• 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_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 None

Return type:

Response

Example:

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

get_governance_instance(governance_instance_id, **kwargs)

Gets a GovernanceInstance by OCID.

Parameters:

• governance_instance_id (str) – (required) The OCID of the GovernanceInstance
• 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 GovernanceInstance

Return type:

Response

Example:

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

get_governance_instance_configuration(compartment_id, **kwargs)

Gets the tenancy-wide configuration for GovernanceInstances

Parameters:

• compartment_id (str) – (required) The OCID of the compartment in which resources are listed.
• 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 GovernanceInstanceConfiguration

Return type:

Response

Example:

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

list_governance_instances(compartment_id, **kwargs)

Returns a list of Governance Instances.

Parameters:

• compartment_id (str) – (required) The OCID of the compartment in which resources are listed.
• lifecycle_state (str) – (optional) The lifecycle state to filter on.
• display_name (str) – (optional) A filter to return only resources that match the entire display name given.
• id (str) – (optional) The OCID of the GovernanceInstance
• 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. Default order for timeCreated is descending.

  Allowed values are: “timeCreated”, “displayName”, “timeUpdated”, “lifecycleState”

• 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 GovernanceInstanceCollection

Return type:

Response

Example:

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

update_governance_instance(update_governance_instance_details, governance_instance_id, **kwargs)

Updates the GovernanceInstance.

Parameters:

• update_governance_instance_details (oci.access_governance_cp.models.UpdateGovernanceInstanceDetails) – (required) The details of the GovernanceInstance to be updated.
• governance_instance_id (str) – (required) The OCID of the GovernanceInstance
• 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 GovernanceInstance

Return type:

Response

Example:

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

update_governance_instance_configuration(update_governance_instance_configuration_details, compartment_id, **kwargs)

Updates the tenancy-wide configuration for GovernanceInstances

Parameters:

• update_governance_instance_configuration_details (oci.access_governance_cp.models.UpdateGovernanceInstanceConfigurationDetails) – (required) The details of the tenancy-wide configuration to be updated.
• compartment_id (str) – (required) The OCID of the compartment in which resources are listed.
• 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 GovernanceInstanceConfiguration

Return type:

Response

Example:

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