oci 2.125.2__py3-none-any.whl → 2.126.0__py3-none-any.whl

oci/os_management_hub/managed_instance_group_client_composite_operations.py

@@ -31,10 +31,14 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.AttachManagedInstancesToManagedInstanceGroupDetails attach_managed_instances_to_managed_instance_group_details: (required)
-            Details for managed instances to attach to the managed instance group.
+            The managed instances `OCIDs`__ to attach to the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -67,13 +71,59 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def attach_software_sources_to_managed_instance_group_and_wait_for_state(self, managed_instance_group_id, attach_software_sources_to_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.attach_software_sources_to_managed_instance_group` and waits for the :py:class:`~oci.os_management_hub.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str managed_instance_group_id: (required)
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+        :param oci.os_management_hub.models.AttachSoftwareSourcesToManagedInstanceGroupDetails attach_software_sources_to_managed_instance_group_details: (required)
+            The software source `OCIDs`__ to attach to the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.attach_software_sources_to_managed_instance_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`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
+        """
+        operation_result = self.client.attach_software_sources_to_managed_instance_group(managed_instance_group_id, attach_software_sources_to_managed_instance_group_details, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def create_managed_instance_group_and_wait_for_state(self, create_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.create_managed_instance_group` and waits for the :py:class:`~oci.os_management_hub.models.ManagedInstanceGroup` acted upon
         to enter the given state(s).
 
         :param oci.os_management_hub.models.CreateManagedInstanceGroupDetails create_managed_instance_group_details: (required)
-            Details for the new managed instance group.
+            Provides the information used to create the managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.ManagedInstanceGroup.lifecycle_state`
@@ -115,7 +165,9 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.ManagedInstanceGroup.lifecycle_state`
@@ -174,10 +226,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.DisableModuleStreamOnManagedInstanceGroupDetails disable_module_stream_on_managed_instance_group_details: (required)
-            Details for modules to disable on the managed instance group.
+            The details used to disable modules on the managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -216,10 +270,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.EnableModuleStreamOnManagedInstanceGroupDetails enable_module_stream_on_managed_instance_group_details: (required)
-            Details for modules to enable on the managed instance group.
+            The details used to enable the module stream on the managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -258,10 +314,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.InstallModuleStreamProfileOnManagedInstanceGroupDetails install_module_stream_profile_on_managed_instance_group_details: (required)
-            Details for profiles to install on the managed instance group.
+            The details used to install module stream profiles on a managed instance gorup.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -300,10 +358,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.InstallPackagesOnManagedInstanceGroupDetails install_packages_on_managed_instance_group_details: (required)
-            Details for packages to install on the specified managed instance group.
+            The names of packages to install on the specified managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -336,13 +396,59 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def install_windows_updates_on_managed_instance_group_and_wait_for_state(self, managed_instance_group_id, install_windows_updates_on_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.install_windows_updates_on_managed_instance_group` and waits for the :py:class:`~oci.os_management_hub.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str managed_instance_group_id: (required)
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+        :param oci.os_management_hub.models.InstallWindowsUpdatesOnManagedInstanceGroupDetails install_windows_updates_on_managed_instance_group_details: (required)
+            Provides the details used to install Windows updates on a managed instance group.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.install_windows_updates_on_managed_instance_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`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
+        """
+        operation_result = self.client.install_windows_updates_on_managed_instance_group(managed_instance_group_id, install_windows_updates_on_managed_instance_group_details, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def list_managed_instance_group_modules_and_wait_for_state(self, managed_instance_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.list_managed_instance_group_modules` and waits for the :py:class:`~oci.os_management_hub.models.WorkRequest`
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -381,10 +487,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.ManageModuleStreamsOnManagedInstanceGroupDetails manage_module_streams_on_managed_instance_group_details: (required)
-            A description of an operation to perform against the modules, streams, and profiles of a managed instance group
+            The set of changes to make to the modules, streams, and profiles on a managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -423,10 +531,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.RemoveModuleStreamProfileFromManagedInstanceGroupDetails remove_module_stream_profile_from_managed_instance_group_details: (required)
-            Details for profiles to remove from the managed instance group.
+            The details used to remove profiles from the managed instance group. Providing the module stream name (without specifying a profile name) removes all profiles that have been installed for the module stream.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -465,10 +575,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.RemovePackagesFromManagedInstanceGroupDetails remove_packages_from_managed_instance_group_details: (required)
-            Details for packages to remove from the managed instance group.
+            The names of packages to remove from the specified managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
@@ -501,13 +613,59 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def switch_module_stream_on_managed_instance_group_and_wait_for_state(self, managed_instance_group_id, switch_module_stream_on_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.switch_module_stream_on_managed_instance_group` and waits for the :py:class:`~oci.os_management_hub.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str managed_instance_group_id: (required)
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+        :param oci.os_management_hub.models.SwitchModuleStreamOnManagedInstanceGroupDetails switch_module_stream_on_managed_instance_group_details: (required)
+            Provides the details used to switch module streams on a managed instance group.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.switch_module_stream_on_managed_instance_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`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
+        """
+        operation_result = self.client.switch_module_stream_on_managed_instance_group(managed_instance_group_id, switch_module_stream_on_managed_instance_group_details, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def update_all_packages_on_managed_instance_group_and_wait_for_state(self, managed_instance_group_id, update_all_packages_on_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.os_management_hub.ManagedInstanceGroupClient.update_all_packages_on_managed_instance_group` and waits for the :py:class:`~oci.os_management_hub.models.WorkRequest`
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.UpdateAllPackagesOnManagedInstanceGroupDetails update_all_packages_on_managed_instance_group_details: (required)
             Details for update operation on the managed instance group.
@@ -549,10 +707,12 @@ class ManagedInstanceGroupClientCompositeOperations(object):
         to enter the given state(s).
 
         :param str managed_instance_group_id: (required)
-            The managed instance group OCID.
+            The `OCID`__ of the managed instance group.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
         :param oci.os_management_hub.models.UpdateManagedInstanceGroupDetails update_managed_instance_group_details: (required)
-            The information to be updated.
+            Provides the details used to update the managed instance group.
 
         :param list[str] wait_for_states:
             An array of states to wait on. These should be valid values for :py:attr:`~oci.os_management_hub.models.ManagedInstanceGroup.lifecycle_state`