OceInstanceClient

class oci.oce.OceInstanceClient(config, **kwargs)

Oracle Content and Experience is a cloud-based content hub to drive omni-channel content management and accelerate experience delivery

__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 is that the client never times out. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) --

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

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

  • retry_strategy (obj) --

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

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

change_oce_instance_compartment(oce_instance_id, change_oce_instance_compartment_details, **kwargs)

Moves a OceInstance into a different compartment. When provided, If-Match is checked against ETag values of the OceInstance. Moves a OceInstance into a different compartment

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

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

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

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

Returns:

A Response object with data of type None

Return type:

Response

create_oce_instance(create_oce_instance_details, **kwargs)

Creates a new OceInstance Creates a new OceInstance.

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

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

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

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

Returns:

A Response object with data of type None

Return type:

Response

delete_oce_instance(oce_instance_id, delete_oce_instance_details, **kwargs)

Delete a provisioned OceInstance Deletes a OceInstance resource by identifier

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

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

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

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

Returns:

A Response object with data of type None

Return type:

Response

get_oce_instance(oce_instance_id, **kwargs)

Get OceInstance Gets a OceInstance by identifier

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

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

Returns:

A Response object with data of type OceInstance

Return type:

Response

get_work_request(work_request_id, **kwargs)

GET Work Request Status Gets the status of the work request with the given ID.

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

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

Returns:

A Response object with data of type WorkRequest

Return type:

Response

list_oce_instances(compartment_id, **kwargs)

Gets a list of all OceInstances in a compartment Returns a list of OceInstances.

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

    (optional) A user-friendly name. Does not have to be unique, and it's changeable.

    Example: My new resource

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

  • lifecycle_state (str) --

    (optional) Filter results on lifecycleState.

    Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"

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

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

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

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

Returns:

A Response object with data of type list of OceInstanceSummary

Return type:

Response

list_work_request_errors(work_request_id, **kwargs)

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

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

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

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

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

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

list_work_request_logs(work_request_id, **kwargs)

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

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

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

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

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

Returns:

A Response object with data of type list of WorkRequestLogEntry

Return type:

Response

list_work_requests(compartment_id, **kwargs)

List Work Requests Lists the work requests in a compartment.

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

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

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

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

Returns:

A Response object with data of type list of WorkRequest

Return type:

Response

update_oce_instance(oce_instance_id, update_oce_instance_details, **kwargs)

Update the OceInstance identified by the id Updates the OceInstance

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

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

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

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

Returns:

A Response object with data of type None

Return type:

Response