IotClientCompositeOperations

class oci.iot.IotClientCompositeOperations(client, **kwargs)

This class provides a wrapper around IotClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

__init__(client, **kwargs)	Creates a new IotClientCompositeOperations object
change_iot_domain_compartment_and_wait_for_state(…)	Calls change_iot_domain_compartment() and waits for the WorkRequest to enter the given state(s).
change_iot_domain_data_retention_period_and_wait_for_state(…)	Calls change_iot_domain_data_retention_period() and waits for the WorkRequest to enter the given state(s).
change_iot_domain_group_compartment_and_wait_for_state(…)	Calls change_iot_domain_group_compartment() and waits for the WorkRequest to enter the given state(s).
configure_iot_domain_data_access_and_wait_for_state(…)	Calls configure_iot_domain_data_access() and waits for the WorkRequest to enter the given state(s).
configure_iot_domain_group_data_access_and_wait_for_state(…)	Calls configure_iot_domain_group_data_access() and waits for the WorkRequest to enter the given state(s).
create_digital_twin_adapter_and_wait_for_state(…)	Calls create_digital_twin_adapter() and waits for the DigitalTwinAdapter acted upon to enter the given state(s).
create_digital_twin_instance_and_wait_for_state(…)	Calls create_digital_twin_instance() and waits for the DigitalTwinInstance acted upon to enter the given state(s).
create_digital_twin_model_and_wait_for_state(…)	Calls create_digital_twin_model() and waits for the DigitalTwinModel acted upon to enter the given state(s).
create_digital_twin_relationship_and_wait_for_state(…)	Calls create_digital_twin_relationship() and waits for the DigitalTwinRelationship acted upon to enter the given state(s).
create_iot_domain_and_wait_for_state(…[, …])	Calls create_iot_domain() and waits for the WorkRequest to enter the given state(s).
create_iot_domain_group_and_wait_for_state(…)	Calls create_iot_domain_group() and waits for the WorkRequest to enter the given state(s).
delete_digital_twin_adapter_and_wait_for_state(…)	Calls delete_digital_twin_adapter() and waits for the DigitalTwinAdapter acted upon to enter the given state(s).
delete_digital_twin_instance_and_wait_for_state(…)	Calls delete_digital_twin_instance() and waits for the DigitalTwinInstance acted upon to enter the given state(s).
delete_digital_twin_model_and_wait_for_state(…)	Calls delete_digital_twin_model() and waits for the DigitalTwinModel acted upon to enter the given state(s).
delete_digital_twin_relationship_and_wait_for_state(…)	Calls delete_digital_twin_relationship() and waits for the DigitalTwinRelationship acted upon to enter the given state(s).
delete_iot_domain_and_wait_for_state(…[, …])	Calls delete_iot_domain() and waits for the WorkRequest to enter the given state(s).
delete_iot_domain_group_and_wait_for_state(…)	Calls delete_iot_domain_group() and waits for the WorkRequest to enter the given state(s).
update_digital_twin_adapter_and_wait_for_state(…)	Calls update_digital_twin_adapter() and waits for the DigitalTwinAdapter acted upon to enter the given state(s).
update_digital_twin_instance_and_wait_for_state(…)	Calls update_digital_twin_instance() and waits for the DigitalTwinInstance acted upon to enter the given state(s).
update_digital_twin_model_and_wait_for_state(…)	Calls update_digital_twin_model() and waits for the DigitalTwinModel acted upon to enter the given state(s).
update_digital_twin_relationship_and_wait_for_state(…)	Calls update_digital_twin_relationship() and waits for the DigitalTwinRelationship acted upon to enter the given state(s).
update_iot_domain_and_wait_for_state(…[, …])	Calls update_iot_domain() and waits for the WorkRequest to enter the given state(s).
update_iot_domain_group_and_wait_for_state(…)	Calls update_iot_domain_group() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new IotClientCompositeOperations object

Parameters:client (IotClient) – The service client which will be wrapped by this object

change_iot_domain_compartment_and_wait_for_state(iot_domain_id, change_iot_domain_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_iot_domain_compartment() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_iot_domain_compartment()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_iot_domain_data_retention_period_and_wait_for_state(iot_domain_id, change_iot_domain_data_retention_period_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_iot_domain_data_retention_period() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_iot_domain_data_retention_period()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_iot_domain_group_compartment_and_wait_for_state(iot_domain_group_id, change_iot_domain_group_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_iot_domain_group_compartment() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_iot_domain_group_compartment()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

configure_iot_domain_data_access_and_wait_for_state(iot_domain_id, configure_iot_domain_data_access_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls configure_iot_domain_data_access() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to configure_iot_domain_data_access()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

configure_iot_domain_group_data_access_and_wait_for_state(iot_domain_group_id, configure_iot_domain_group_data_access_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls configure_iot_domain_group_data_access() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to configure_iot_domain_group_data_access()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_digital_twin_adapter_and_wait_for_state(create_digital_twin_adapter_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_digital_twin_adapter() and waits for the DigitalTwinAdapter acted upon to enter the given state(s).

Parameters:

• create_digital_twin_adapter_details (oci.iot.models.CreateDigitalTwinAdapterDetails) – (required) Details for the new digital twin adapter.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_digital_twin_adapter()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_digital_twin_instance_and_wait_for_state(create_digital_twin_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_digital_twin_instance() and waits for the DigitalTwinInstance acted upon to enter the given state(s).

Parameters:

• create_digital_twin_instance_details (oci.iot.models.CreateDigitalTwinInstanceDetails) – (required) Details for the new digital twin instance.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_digital_twin_instance()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_digital_twin_model_and_wait_for_state(create_digital_twin_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_digital_twin_model() and waits for the DigitalTwinModel acted upon to enter the given state(s).

Parameters:

• create_digital_twin_model_details (oci.iot.models.CreateDigitalTwinModelDetails) – (required) Details for the new digital twin model.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_digital_twin_model()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_digital_twin_relationship_and_wait_for_state(create_digital_twin_relationship_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_digital_twin_relationship() and waits for the DigitalTwinRelationship acted upon to enter the given state(s).

Parameters:

• create_digital_twin_relationship_details (oci.iot.models.CreateDigitalTwinRelationshipDetails) – (required) Details for the new digital twin relationship.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_digital_twin_relationship()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_iot_domain_and_wait_for_state(create_iot_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_iot_domain() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_iot_domain_details (oci.iot.models.CreateIotDomainDetails) – (required) Details for the new IoT domain.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_iot_domain()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_iot_domain_group_and_wait_for_state(create_iot_domain_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_iot_domain_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_iot_domain_group_details (oci.iot.models.CreateIotDomainGroupDetails) – (required) Details for the new IoT domain group.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_iot_domain_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_digital_twin_adapter_and_wait_for_state(digital_twin_adapter_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_digital_twin_adapter() and waits for the DigitalTwinAdapter acted upon to enter the given state(s).

Parameters:

• digital_twin_adapter_id (str) –

  (required) The OCID of the digital twin adapter.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_digital_twin_adapter()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_digital_twin_instance_and_wait_for_state(digital_twin_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_digital_twin_instance() and waits for the DigitalTwinInstance acted upon to enter the given state(s).

Parameters:

• digital_twin_instance_id (str) –

  (required) The OCID of digital twin instance.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_digital_twin_instance()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_digital_twin_model_and_wait_for_state(digital_twin_model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_digital_twin_model() and waits for the DigitalTwinModel acted upon to enter the given state(s).

Parameters:

• digital_twin_model_id (str) –

  (required) The OCID of digital twin model.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_digital_twin_model()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_digital_twin_relationship_and_wait_for_state(digital_twin_relationship_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_digital_twin_relationship() and waits for the DigitalTwinRelationship acted upon to enter the given state(s).

Parameters:

• digital_twin_relationship_id (str) –

  (required) The OCID of digital twin relationship.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_digital_twin_relationship()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_iot_domain_and_wait_for_state(iot_domain_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_iot_domain() and waits for the WorkRequest to enter the given state(s).

Parameters:

• iot_domain_id (str) –

  (required) The OCID of the IoT domain.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_iot_domain()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_iot_domain_group_and_wait_for_state(iot_domain_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_iot_domain_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• iot_domain_group_id (str) –

  (required) The OCID of an IoT Domain Group.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_iot_domain_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_digital_twin_adapter_and_wait_for_state(digital_twin_adapter_id, update_digital_twin_adapter_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_digital_twin_adapter() and waits for the DigitalTwinAdapter acted upon to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_digital_twin_adapter()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_digital_twin_instance_and_wait_for_state(digital_twin_instance_id, update_digital_twin_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_digital_twin_instance() and waits for the DigitalTwinInstance acted upon to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_digital_twin_instance()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_digital_twin_model_and_wait_for_state(digital_twin_model_id, update_digital_twin_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_digital_twin_model() and waits for the DigitalTwinModel acted upon to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_digital_twin_model()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_digital_twin_relationship_and_wait_for_state(digital_twin_relationship_id, update_digital_twin_relationship_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_digital_twin_relationship() and waits for the DigitalTwinRelationship acted upon to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_digital_twin_relationship()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_iot_domain_and_wait_for_state(iot_domain_id, update_iot_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_iot_domain() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_iot_domain()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_iot_domain_group_and_wait_for_state(iot_domain_group_id, update_iot_domain_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_iot_domain_group() and waits for the WorkRequest to enter the given state(s).

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.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_iot_domain_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait