IotClient¶

class oci.iot.IotClient(config, **kwargs)¶

Use the Internet of Things (IoT) API to manage IoT domain groups, domains, and digital twin resources including models, adapters, instances, and relationships. For more information, see [Internet of Things](https://docs.oracle.com/iaas/Content/internet-of-things/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_iot_domain_compartment`(iot_domain_id, …)	Moves an IoT domain to a different compartment within the same tenancy.
`change_iot_domain_data_retention_period`(…)	Updates Data Retention Period of the IoT Domain.
`change_iot_domain_group_compartment`(…)	Moves an IoT domain group to a different compartment within the same tenancy.
`configure_iot_domain_data_access`(…)	Updates an IoT domain Data Access.
`configure_iot_domain_group_data_access`(…)	Updates an IoT domain Group Data Access.
`create_digital_twin_adapter`(…)	Creates a new digital twin adapter.
`create_digital_twin_instance`(…)	Creates a new digital twin instance.
`create_digital_twin_model`(…)	Creates a new digital twin model.
`create_digital_twin_relationship`(…)	Creates a new digital twin relationship.
`create_iot_domain`(create_iot_domain_details, …)	Creates a new IoT domain.
`create_iot_domain_group`(…)	Creates a new IoT domain group.
`delete_digital_twin_adapter`(…)	Deletes the digital twin adapter identified by the specified OCID.
`delete_digital_twin_instance`(…)	Deletes the digital twin instance identified by the specified OCID.
`delete_digital_twin_model`(…)	Deletes the digital twin model identified by the specified OCID.
`delete_digital_twin_relationship`(…)	Deletes the digital twin relationship identified by the specified OCID.
`delete_iot_domain`(iot_domain_id, **kwargs)	Deletes the IoT domain identified by the specified OCID.
`delete_iot_domain_group`(iot_domain_group_id, …)	Deletes the IoT domain group identified by the specified OCID.
`get_digital_twin_adapter`(…)	Retrieves the digital twin adapter identified by the specified OCID.
`get_digital_twin_instance`(…)	Retrieves the digital twin instance identified by the specified OCID.
`get_digital_twin_instance_content`(…)	Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.
`get_digital_twin_model`(…)	Retrieves the digital twin model identified by the specified OCID.
`get_digital_twin_model_spec`(…)	Retrieves the spec of digital twin model identified by the specified OCID.
`get_digital_twin_relationship`(…)	Retrieves the digital twin relationship identified by the specified OCID.
`get_iot_domain`(iot_domain_id, **kwargs)	Retrieves the IoT domain identified by the specified OCID.
`get_iot_domain_group`(iot_domain_group_id, …)	Retrieves the IoT domain group identified by the specified OCID.
`get_work_request`(work_request_id, **kwargs)	Retrieves the status of the work request with the given ID.
`invoke_raw_command`(digital_twin_instance_id, …)	Invokes the raw command on the specified digital twin instance.
`list_digital_twin_adapters`(iot_domain_id, …)	Retrieves a list of digital twin adapters within the specified IoT domain.
`list_digital_twin_instances`(iot_domain_id, …)	Retrieves a list of digital twin instances within the specified IoT domain.
`list_digital_twin_models`(iot_domain_id, **kwargs)	Retrieves a list of digital twin models within the specified IoT domain.
`list_digital_twin_relationships`(…)	Retrieves a list of digital twin relationships within the specified IoT domain.
`list_iot_domain_groups`(compartment_id, **kwargs)	Retrieves a list of IoT domain groups within the specified compartment.
`list_iot_domains`(compartment_id, **kwargs)	Retrieves a list of IoT domains within the specified compartment.
`list_work_request_errors`(work_request_id, …)	Lists errors associated with the specified work request.
`list_work_request_logs`(work_request_id, **kwargs)	Lists the logs associated with the specified work request.
`list_work_requests`(compartment_id, **kwargs)	Lists work requests in the specified compartment.
`update_digital_twin_adapter`(…)	Updates the details of digital twin adapter identified by the specified OCID.
`update_digital_twin_instance`(…)	Updates the details of digital twin instance identified by the specified OCID.
`update_digital_twin_model`(…)	Updates the details of the digital twin model identified by the specified OCID.
`update_digital_twin_relationship`(…)	Updates the details of digital twin relationship identified by the specified OCID.
`update_iot_domain`(iot_domain_id, …)	Updates the details of IoT domain identified by the specified OCID.
`update_iot_domain_group`(iot_domain_group_id, …)	Updates the details of IoT domain group identified by the specified OCID.

__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_iot_domain_compartment(iot_domain_id, change_iot_domain_compartment_details, **kwargs)¶

Moves an IoT domain to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain. change_iot_domain_compartment_details (oci.iot.models.ChangeIotDomainCompartmentDetails) – (required) Details for changing the IoT domain compartment. 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, provide the request ID. 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_iot_domain_compartment API.

change_iot_domain_data_retention_period(iot_domain_id, change_iot_domain_data_retention_period_details, **kwargs)¶

Updates Data Retention Period of the IoT Domain.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain. change_iot_domain_data_retention_period_details (oci.iot.models.ChangeIotDomainDataRetentionPeriodDetails) – (required) Details for changing data retention period of IoT domain data. 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, provide the request ID. 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_iot_domain_data_retention_period API.

change_iot_domain_group_compartment(iot_domain_group_id, change_iot_domain_group_compartment_details, **kwargs)¶

Moves an IoT domain group to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:	iot_domain_group_id (str) – (required) The OCID of an IoT Domain Group. change_iot_domain_group_compartment_details (oci.iot.models.ChangeIotDomainGroupCompartmentDetails) – (required) Details for changing the IoT domain group compartment. 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, provide the request ID. 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_iot_domain_group_compartment API.

configure_iot_domain_data_access(iot_domain_id, configure_iot_domain_data_access_details, **kwargs)¶

Updates an IoT domain Data Access.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain. configure_iot_domain_data_access_details (oci.iot.models.ConfigureIotDomainDataAccessDetails) – (required) Details for configuring data access. 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, provide the request ID. 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 configure_iot_domain_data_access API.

configure_iot_domain_group_data_access(iot_domain_group_id, configure_iot_domain_group_data_access_details, **kwargs)¶

Updates an IoT domain Group Data Access.

Parameters:	iot_domain_group_id (str) – (required) The OCID of an IoT Domain Group. configure_iot_domain_group_data_access_details (oci.iot.models.ConfigureIotDomainGroupDataAccessDetails) – (required) Details for configuring data access. 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, provide the request ID. 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 configure_iot_domain_group_data_access API.

create_digital_twin_adapter(create_digital_twin_adapter_details, **kwargs)¶

Creates a new digital twin adapter.

Parameters:	create_digital_twin_adapter_details (oci.iot.models.CreateDigitalTwinAdapterDetails) – (required) Details for the new digital twin adapter. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinAdapter`
Return type:	`Response`
Example:

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

create_digital_twin_instance(create_digital_twin_instance_details, **kwargs)¶

Creates a new digital twin instance.

Parameters:	create_digital_twin_instance_details (oci.iot.models.CreateDigitalTwinInstanceDetails) – (required) Details for the new digital twin instance. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinInstance`
Return type:	`Response`
Example:

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

create_digital_twin_model(create_digital_twin_model_details, **kwargs)¶

Creates a new digital twin model.

Parameters:	create_digital_twin_model_details (oci.iot.models.CreateDigitalTwinModelDetails) – (required) Details for the new digital twin model. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinModel`
Return type:	`Response`
Example:

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

create_digital_twin_relationship(create_digital_twin_relationship_details, **kwargs)¶

Creates a new digital twin relationship.

Parameters:	create_digital_twin_relationship_details (oci.iot.models.CreateDigitalTwinRelationshipDetails) – (required) Details for the new digital twin relationship. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinRelationship`
Return type:	`Response`
Example:

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

create_iot_domain(create_iot_domain_details, **kwargs)¶

Creates a new IoT domain.

Parameters:	create_iot_domain_details (oci.iot.models.CreateIotDomainDetails) – (required) Details for the new IoT domain. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `IotDomain`
Return type:	`Response`
Example:

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

create_iot_domain_group(create_iot_domain_group_details, **kwargs)¶

Creates a new IoT domain group.

Parameters:	create_iot_domain_group_details (oci.iot.models.CreateIotDomainGroupDetails) – (required) Details for the new IoT domain group. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `IotDomainGroup`
Return type:	`Response`
Example:

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

delete_digital_twin_adapter(digital_twin_adapter_id, **kwargs)¶

Deletes the digital twin adapter identified by the specified OCID.

Parameters:	digital_twin_adapter_id (str) – (required) The OCID of the digital twin adapter. 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, provide the request ID. 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_digital_twin_adapter API.

delete_digital_twin_instance(digital_twin_instance_id, **kwargs)¶

Deletes the digital twin instance identified by the specified OCID.

Parameters:	digital_twin_instance_id (str) – (required) The OCID of digital twin instance. 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, provide the request ID. 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_digital_twin_instance API.

delete_digital_twin_model(digital_twin_model_id, **kwargs)¶

Deletes the digital twin model identified by the specified OCID.

Parameters:	digital_twin_model_id (str) – (required) The OCID of digital twin model. 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, provide the request ID. 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_digital_twin_model API.

delete_digital_twin_relationship(digital_twin_relationship_id, **kwargs)¶

Deletes the digital twin relationship identified by the specified OCID.

Parameters:	digital_twin_relationship_id (str) – (required) The OCID of digital twin relationship. 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, provide the request ID. 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_digital_twin_relationship API.

delete_iot_domain(iot_domain_id, **kwargs)¶

Deletes the IoT domain identified by the specified OCID.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain. 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, provide the request ID. 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_iot_domain API.

delete_iot_domain_group(iot_domain_group_id, **kwargs)¶

Deletes the IoT domain group identified by the specified OCID.

Parameters:	iot_domain_group_id (str) – (required) The OCID of an IoT Domain Group. 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, provide the request ID. 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_iot_domain_group API.

get_digital_twin_adapter(digital_twin_adapter_id, **kwargs)¶

Retrieves the digital twin adapter identified by the specified OCID.

Parameters:	digital_twin_adapter_id (str) – (required) The OCID of the digital twin adapter. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinAdapter`
Return type:	`Response`
Example:

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

get_digital_twin_instance(digital_twin_instance_id, **kwargs)¶

Retrieves the digital twin instance identified by the specified OCID.

Parameters:	digital_twin_instance_id (str) – (required) The OCID of digital twin instance. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinInstance`
Return type:	`Response`
Example:

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

get_digital_twin_instance_content(digital_twin_instance_id, **kwargs)¶

Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.

Parameters:	digital_twin_instance_id (str) – (required) The OCID of digital twin instance. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. should_include_metadata (bool) – (optional) If set to true , digital twin instance metadata is included in the response. 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 dict(str, object)
Return type:	`Response`
Example:

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

get_digital_twin_model(digital_twin_model_id, **kwargs)¶

Retrieves the digital twin model identified by the specified OCID.

Parameters:	digital_twin_model_id (str) – (required) The OCID of digital twin model. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinModel`
Return type:	`Response`
Example:

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

get_digital_twin_model_spec(digital_twin_model_id, **kwargs)¶

Retrieves the spec of digital twin model identified by the specified OCID.

Parameters:	digital_twin_model_id (str) – (required) The OCID of digital twin model. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 dict(str, object)
Return type:	`Response`
Example:

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

get_digital_twin_relationship(digital_twin_relationship_id, **kwargs)¶

Retrieves the digital twin relationship identified by the specified OCID.

Parameters:	digital_twin_relationship_id (str) – (required) The OCID of digital twin relationship. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinRelationship`
Return type:	`Response`
Example:

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

get_iot_domain(iot_domain_id, **kwargs)¶

Retrieves the IoT domain identified by the specified OCID.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `IotDomain`
Return type:	`Response`
Example:

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

get_iot_domain_group(iot_domain_group_id, **kwargs)¶

Retrieves the IoT domain group identified by the specified OCID.

Parameters:	iot_domain_group_id (str) – (required) The OCID of an IoT Domain Group. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `IotDomainGroup`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

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

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, provide the request ID. 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.

invoke_raw_command(digital_twin_instance_id, invoke_raw_command_details, **kwargs)¶

Invokes the raw command on the specified digital twin instance.

Parameters:	digital_twin_instance_id (str) – (required) The OCID of digital twin instance. invoke_raw_command_details (oci.iot.models.InvokeRawCommandDetails) – (required) Details for the raw command invocation. 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 invoke_raw_command API.

list_digital_twin_adapters(iot_domain_id, **kwargs)¶

Retrieves a list of digital twin adapters within the specified IoT domain.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain in which to list digital twin resources. id (str) – (optional) Filter resources by OCID. Must be a valid OCID of the resource type. digital_twin_model_spec_uri (str) – (optional) Filter resources that match the specified URI (DTMI) of the digital twin model. digital_twin_model_id (str) – (optional) Filter resources that match the specified OCID of the digital twin model. display_name (str) – (optional) Filter resources whose display name matches the specified value. lifecycle_state (str) – (optional) Filter resources whose lifecycleState matches the specified value. Allowed values are: “ACTIVE”, “DELETED” 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) Page representing the requested page of items. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinAdapterCollection`
Return type:	`Response`
Example:

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

list_digital_twin_instances(iot_domain_id, **kwargs)¶

Retrieves a list of digital twin instances within the specified IoT domain.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain in which to list digital twin resources. display_name (str) – (optional) Filter resources whose display name matches the specified value. 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) Page representing the requested page of items. lifecycle_state (str) – (optional) Filter resources whose lifecycleState matches the specified value. Allowed values are: “ACTIVE”, “DELETED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. digital_twin_model_id (str) – (optional) Filter resources that match the specified OCID of the digital twin model. digital_twin_model_spec_uri (str) – (optional) Filter resources that match the specified URI (DTMI) of the digital twin model. id (str) – (optional) Filter resources by OCID. Must be a valid OCID of the resource 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 `DigitalTwinInstanceCollection`
Return type:	`Response`
Example:

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

list_digital_twin_models(iot_domain_id, **kwargs)¶

Retrieves a list of digital twin models within the specified IoT domain.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain in which to list digital twin resources. id (str) – (optional) Filter resources by OCID. Must be a valid OCID of the resource type. display_name (str) – (optional) Filter resources whose display name matches the specified value. spec_uri_starts_with (str) – (optional) Filters resources by spec URI prefix. For example, to search all versions of the dtmi:example:device;1 model, pass the prefix without the version: dtmi:example:device. 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) Page representing the requested page of items. lifecycle_state (str) – (optional) Filter resources whose lifecycleState matches the specified value. Allowed values are: “ACTIVE”, “DELETED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinModelCollection`
Return type:	`Response`
Example:

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

list_digital_twin_relationships(iot_domain_id, **kwargs)¶

Retrieves a list of digital twin relationships within the specified IoT domain.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain in which to list digital twin resources. display_name (str) – (optional) Filter resources whose display name matches the specified value. content_path (str) – (optional) Filters resources that match the content path of the digital twin relationship. source_digital_twin_instance_id (str) – (optional) Filter resources that match the specified OCID of source digital twin instance. target_digital_twin_instance_id (str) – (optional) Filter resources that match the specified OCID of target digital twin instance. lifecycle_state (str) – (optional) Filter resources whose lifecycleState matches the specified value. Allowed values are: “ACTIVE”, “DELETED” 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) Page representing the requested page of items. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. id (str) – (optional) Filter resources by OCID. Must be a valid OCID of the resource 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 `DigitalTwinRelationshipCollection`
Return type:	`Response`
Example:

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

list_iot_domain_groups(compartment_id, **kwargs)¶

Retrieves a list of IoT domain groups within the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. id (str) – (optional) Filter resources by OCID. Must be a valid OCID of the resource type. display_name (str) – (optional) Filter resources whose display name matches the specified value. lifecycle_state (str) – (optional) Filter resources whose lifecycleState matches the specified value. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” 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 on how pagination works, see List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `IotDomainGroupCollection`
Return type:	`Response`
Example:

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

list_iot_domains(compartment_id, **kwargs)¶

Retrieves a list of IoT domains within the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. id (str) – (optional) Filter resources by OCID. Must be a valid OCID of the resource type. iot_domain_group_id (str) – (optional) Filter resources that match the specified OCID of the IoT domain group. display_name (str) – (optional) Filter resources whose display name matches the specified value. lifecycle_state (str) – (optional) Filter resources whose lifecycleState matches the specified value. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” 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 on how pagination works, see List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `IotDomainCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Lists errors associated with the specified 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, provide the request ID. page (str) – (optional) For list pagination: The value of the opc-next-page response header from the previous “List” call. For important details on 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 can be specified. The default order for timeCreated is descending. Allowed values are: “timeCreated” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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)¶

Lists the logs associated with the specified 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, provide the request ID. page (str) – (optional) For list pagination: The value of the opc-next-page response header from the previous “List” call. For important details on 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 can be specified. The default order for timeCreated is descending. Allowed values are: “timeCreated” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). 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(compartment_id, **kwargs)¶

Lists work requests in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment in which to list resources. 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” 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, provide the request ID. page (str) – (optional) For list pagination: The value of the opc-next-page response header from the previous “List” call. For important details on 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) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be specified. 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_digital_twin_adapter(digital_twin_adapter_id, update_digital_twin_adapter_details, **kwargs)¶

Updates the details of digital twin adapter identified by the specified OCID.

Parameters:	digital_twin_adapter_id (str) – (required) The OCID of the digital twin adapter. update_digital_twin_adapter_details (oci.iot.models.UpdateDigitalTwinAdapterDetails) – (required) The digital twin adapter details 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinAdapter`
Return type:	`Response`
Example:

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

update_digital_twin_instance(digital_twin_instance_id, update_digital_twin_instance_details, **kwargs)¶

Updates the details of digital twin instance identified by the specified OCID.

Parameters:	digital_twin_instance_id (str) – (required) The OCID of digital twin instance. update_digital_twin_instance_details (oci.iot.models.UpdateDigitalTwinInstanceDetails) – (required) The digital twin instance details 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinInstance`
Return type:	`Response`
Example:

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

update_digital_twin_model(digital_twin_model_id, update_digital_twin_model_details, **kwargs)¶

Updates the details of the digital twin model identified by the specified OCID.

Parameters:	digital_twin_model_id (str) – (required) The OCID of digital twin model. update_digital_twin_model_details (oci.iot.models.UpdateDigitalTwinModelDetails) – (required) The digital twin model details 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinModel`
Return type:	`Response`
Example:

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

update_digital_twin_relationship(digital_twin_relationship_id, update_digital_twin_relationship_details, **kwargs)¶

Updates the details of digital twin relationship identified by the specified OCID.

Parameters:	digital_twin_relationship_id (str) – (required) The OCID of digital twin relationship. update_digital_twin_relationship_details (oci.iot.models.UpdateDigitalTwinRelationshipDetails) – (required) The digital twin relationship details 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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 `DigitalTwinRelationship`
Return type:	`Response`
Example:

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

update_iot_domain(iot_domain_id, update_iot_domain_details, **kwargs)¶

Updates the details of IoT domain identified by the specified OCID.

Parameters:	iot_domain_id (str) – (required) The OCID of the IoT domain. update_iot_domain_details (oci.iot.models.UpdateIotDomainDetails) – (required) The IoT domain details 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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_iot_domain API.

update_iot_domain_group(iot_domain_group_id, update_iot_domain_group_details, **kwargs)¶

Updates the details of IoT domain group identified by the specified OCID.

Parameters:	iot_domain_group_id (str) – (required) The OCID of an IoT Domain Group. update_iot_domain_group_details (oci.iot.models.UpdateIotDomainGroupDetails) – (required) The IoT domain group details 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. 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_iot_domain_group API.