ComputeClientCompositeOperations¶
-
class
oci.core.
ComputeClientCompositeOperations
(client, work_request_client=None, **kwargs)¶ This class provides a wrapper around
ComputeClient
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 functionalityMethods
__init__
(client[, work_request_client])Creates a new ComputeClientCompositeOperations object attach_boot_volume_and_wait_for_state
(…[, …])Calls attach_boot_volume()
and waits for theBootVolumeAttachment
acted upon to enter the given state(s).attach_vnic_and_wait_for_state
(…[, …])Calls attach_vnic()
and waits for theVnicAttachment
acted upon to enter the given state(s).attach_volume_and_wait_for_state
(…[, …])Calls attach_volume()
and waits for theVolumeAttachment
acted upon to enter the given state(s).capture_console_history_and_wait_for_state
(…)Calls capture_console_history()
and waits for theConsoleHistory
acted upon to enter the given state(s).change_compute_capacity_reservation_compartment_and_wait_for_work_request
(…)Calls change_compute_capacity_reservation_compartment()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).change_dedicated_vm_host_compartment_and_wait_for_work_request
(…)Calls change_dedicated_vm_host_compartment()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).change_instance_compartment_and_wait_for_work_request
(…)Calls change_instance_compartment()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).create_compute_capacity_reservation_and_wait_for_state
(…)Calls create_compute_capacity_reservation()
and waits for theComputeCapacityReservation
acted upon to enter the given state(s).create_compute_capacity_reservation_and_wait_for_work_request
(…)Calls create_compute_capacity_reservation()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).create_dedicated_vm_host_and_wait_for_state
(…)Calls create_dedicated_vm_host()
and waits for theDedicatedVmHost
acted upon to enter the given state(s).create_dedicated_vm_host_and_wait_for_work_request
(…)Calls create_dedicated_vm_host()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).create_image_and_wait_for_state
(…[, …])Calls create_image()
and waits for theImage
acted upon to enter the given state(s).create_image_and_wait_for_work_request
(…)Calls create_image()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).create_instance_console_connection_and_wait_for_state
(…)Calls create_instance_console_connection()
and waits for theInstanceConsoleConnection
acted upon to enter the given state(s).delete_compute_capacity_reservation_and_wait_for_work_request
(…)Calls delete_compute_capacity_reservation()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).delete_console_history_and_wait_for_state
(…)Calls delete_console_history()
and waits for theConsoleHistory
acted upon to enter the given state(s).delete_dedicated_vm_host_and_wait_for_work_request
(…)Calls delete_dedicated_vm_host()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).delete_image_and_wait_for_state
(image_id[, …])Calls delete_image()
and waits for theImage
acted upon to enter the given state(s).delete_instance_console_connection_and_wait_for_state
(…)Calls delete_instance_console_connection()
and waits for theInstanceConsoleConnection
acted upon to enter the given state(s).detach_boot_volume_and_wait_for_state
(…[, …])Calls detach_boot_volume()
and waits for theBootVolumeAttachment
acted upon to enter the given state(s).detach_vnic_and_wait_for_state
(…[, …])Calls detach_vnic()
and waits for theVnicAttachment
acted upon to enter the given state(s).detach_volume_and_wait_for_state
(…[, …])Calls detach_volume()
and waits for theVolumeAttachment
acted upon to enter the given state(s).export_image_and_wait_for_state
(image_id, …)Calls export_image()
and waits for theImage
acted upon to enter the given state(s).export_image_and_wait_for_work_request
(…)Calls export_image()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).instance_action_and_wait_for_state
(…[, …])Calls instance_action()
and waits for theInstance
acted upon to enter the given state(s).launch_instance_and_wait_for_state
(…[, …])Calls launch_instance()
and waits for theInstance
acted upon to enter the given state(s).launch_instance_and_wait_for_work_request
(…)Calls launch_instance()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).terminate_instance_and_wait_for_state
(…[, …])Calls terminate_instance()
and waits for theInstance
acted upon to enter the given state(s).update_compute_capacity_reservation_and_wait_for_work_request
(…)Calls update_compute_capacity_reservation()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).update_console_history_and_wait_for_state
(…)Calls update_console_history()
and waits for theConsoleHistory
acted upon to enter the given state(s).update_dedicated_vm_host_and_wait_for_state
(…)Calls update_dedicated_vm_host()
and waits for theDedicatedVmHost
acted upon to enter the given state(s).update_image_and_wait_for_state
(image_id, …)Calls update_image()
and waits for theImage
acted upon to enter the given state(s).update_instance_and_wait_for_state
(…[, …])Calls update_instance()
and waits for theInstance
acted upon to enter the given state(s).update_instance_and_wait_for_work_request
(…)Calls update_instance()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).update_instance_console_connection_and_wait_for_state
(…)Calls update_instance_console_connection()
and waits for theInstanceConsoleConnection
acted upon to enter the given state(s).update_volume_attachment_and_wait_for_state
(…)Calls update_volume_attachment()
and waits for theVolumeAttachment
acted upon to enter the given state(s).-
__init__
(client, work_request_client=None, **kwargs)¶ Creates a new ComputeClientCompositeOperations object
Parameters: - client (ComputeClient) – The service client which will be wrapped by this object
- work_request_client (oci.work_requests.WorkRequestClient) – (optional) The work request service client which will be used to wait for work request states. Default is None.
-
attach_boot_volume_and_wait_for_state
(attach_boot_volume_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
attach_boot_volume()
and waits for theBootVolumeAttachment
acted upon to enter the given state(s).Parameters: - attach_boot_volume_details (oci.core.models.AttachBootVolumeDetails) – (required) Attach boot volume request
- 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
attach_boot_volume()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
attach_vnic_and_wait_for_state
(attach_vnic_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
attach_vnic()
and waits for theVnicAttachment
acted upon to enter the given state(s).Parameters: - attach_vnic_details (oci.core.models.AttachVnicDetails) – (required) Attach VNIC details.
- 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
attach_vnic()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
attach_volume_and_wait_for_state
(attach_volume_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
attach_volume()
and waits for theVolumeAttachment
acted upon to enter the given state(s).Parameters: - attach_volume_details (oci.core.models.AttachVolumeDetails) – (required) Attach volume request
- 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
attach_volume()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
capture_console_history_and_wait_for_state
(capture_console_history_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
capture_console_history()
and waits for theConsoleHistory
acted upon to enter the given state(s).Parameters: - capture_console_history_details (oci.core.models.CaptureConsoleHistoryDetails) – (required) Console history details
- 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
capture_console_history()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_compute_capacity_reservation_compartment_and_wait_for_work_request
(capacity_reservation_id, change_compute_capacity_reservation_compartment_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_compute_capacity_reservation_compartment()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
- change_compute_capacity_reservation_compartment_details (oci.core.models.ChangeComputeCapacityReservationCompartmentDetails) – (required) The configuration details for the move operation.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_compute_capacity_reservation_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dedicated_vm_host_compartment_and_wait_for_work_request
(dedicated_vm_host_id, change_dedicated_vm_host_compartment_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_dedicated_vm_host_compartment()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
- change_dedicated_vm_host_compartment_details (oci.core.models.ChangeDedicatedVmHostCompartmentDetails) – (required) The request to move the dedicated virtual machine host to a different compartment.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_dedicated_vm_host_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_instance_compartment_and_wait_for_work_request
(instance_id, change_instance_compartment_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_instance_compartment()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - instance_id (str) –
(required) The OCID of the instance.
- change_instance_compartment_details (oci.core.models.ChangeInstanceCompartmentDetails) – (required) Request to change the compartment of a given instance.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_instance_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- instance_id (str) –
-
create_compute_capacity_reservation_and_wait_for_state
(create_compute_capacity_reservation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_compute_capacity_reservation()
and waits for theComputeCapacityReservation
acted upon to enter the given state(s).Parameters: - create_compute_capacity_reservation_details (oci.core.models.CreateComputeCapacityReservationDetails) –
(required) Details for creating a new compute capacity reservation.
Caution: Avoid using any confidential information when you use the API to supply string values.
- 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_compute_capacity_reservation()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_compute_capacity_reservation_details (oci.core.models.CreateComputeCapacityReservationDetails) –
-
create_compute_capacity_reservation_and_wait_for_work_request
(create_compute_capacity_reservation_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_compute_capacity_reservation()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - create_compute_capacity_reservation_details (oci.core.models.CreateComputeCapacityReservationDetails) –
(required) Details for creating a new compute capacity reservation.
Caution: Avoid using any confidential information when you use the API to supply string values.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_compute_capacity_reservation()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_compute_capacity_reservation_details (oci.core.models.CreateComputeCapacityReservationDetails) –
-
create_dedicated_vm_host_and_wait_for_state
(create_dedicated_vm_host_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_dedicated_vm_host()
and waits for theDedicatedVmHost
acted upon to enter the given state(s).Parameters: - create_dedicated_vm_host_details (oci.core.models.CreateDedicatedVmHostDetails) – (required) The details for creating a new dedicated virtual machine host.
- 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_dedicated_vm_host()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dedicated_vm_host_and_wait_for_work_request
(create_dedicated_vm_host_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_dedicated_vm_host()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - create_dedicated_vm_host_details (oci.core.models.CreateDedicatedVmHostDetails) – (required) The details for creating a new dedicated virtual machine host.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_dedicated_vm_host()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_image_and_wait_for_state
(create_image_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_image()
and waits for theImage
acted upon to enter the given state(s).Parameters: - create_image_details (oci.core.models.CreateImageDetails) – (required) Image creation details
- 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_image()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_image_and_wait_for_work_request
(create_image_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_image()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - create_image_details (oci.core.models.CreateImageDetails) – (required) Image creation details
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_image()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_instance_console_connection_and_wait_for_state
(create_instance_console_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_instance_console_connection()
and waits for theInstanceConsoleConnection
acted upon to enter the given state(s).Parameters: - create_instance_console_connection_details (oci.core.models.CreateInstanceConsoleConnectionDetails) – (required) Request object for creating an InstanceConsoleConnection
- 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_instance_console_connection()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_compute_capacity_reservation_and_wait_for_work_request
(capacity_reservation_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_compute_capacity_reservation()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_compute_capacity_reservation()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_console_history_and_wait_for_state
(instance_console_history_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_console_history()
and waits for theConsoleHistory
acted upon to enter the given state(s).Parameters: - instance_console_history_id (str) – (required) The OCID of the console history.
- 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_console_history()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dedicated_vm_host_and_wait_for_work_request
(dedicated_vm_host_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_dedicated_vm_host()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_dedicated_vm_host()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_image_and_wait_for_state
(image_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_image()
and waits for theImage
acted upon to enter the given state(s).Parameters: - image_id (str) –
(required) The OCID of the image.
- 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_image()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- image_id (str) –
-
delete_instance_console_connection_and_wait_for_state
(instance_console_connection_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_instance_console_connection()
and waits for theInstanceConsoleConnection
acted upon to enter the given state(s).Parameters: - instance_console_connection_id (str) – (required) The OCID of the instance console connection.
- 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_instance_console_connection()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
detach_boot_volume_and_wait_for_state
(boot_volume_attachment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
detach_boot_volume()
and waits for theBootVolumeAttachment
acted upon to enter the given state(s).Parameters: - boot_volume_attachment_id (str) – (required) The OCID of the boot volume attachment.
- 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
detach_boot_volume()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
detach_vnic_and_wait_for_state
(vnic_attachment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
detach_vnic()
and waits for theVnicAttachment
acted upon to enter the given state(s).Parameters: - vnic_attachment_id (str) – (required) The OCID of the VNIC attachment.
- 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
detach_vnic()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
detach_volume_and_wait_for_state
(volume_attachment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
detach_volume()
and waits for theVolumeAttachment
acted upon to enter the given state(s).Parameters: - volume_attachment_id (str) – (required) The OCID of the volume attachment.
- 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
detach_volume()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
export_image_and_wait_for_state
(image_id, export_image_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
export_image()
and waits for theImage
acted upon to enter the given state(s).Parameters: - image_id (str) –
(required) The OCID of the image.
- export_image_details (oci.core.models.ExportImageDetails) – (required) Details for the image export.
- 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
export_image()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- image_id (str) –
-
export_image_and_wait_for_work_request
(image_id, export_image_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
export_image()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - image_id (str) –
(required) The OCID of the image.
- export_image_details (oci.core.models.ExportImageDetails) – (required) Details for the image export.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
export_image()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- image_id (str) –
-
instance_action_and_wait_for_state
(instance_id, action, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
instance_action()
and waits for theInstance
acted upon to enter the given state(s).Parameters: - instance_id (str) –
(required) The OCID of the instance.
- action (str) –
(required) The action to perform on the instance.
Allowed values are: “STOP”, “START”, “SOFTRESET”, “RESET”, “SOFTSTOP”, “SENDDIAGNOSTICINTERRUPT”, “DIAGNOSTICREBOOT”, “REBOOTMIGRATE”
- 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
instance_action()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- instance_id (str) –
-
launch_instance_and_wait_for_state
(launch_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
launch_instance()
and waits for theInstance
acted upon to enter the given state(s).Parameters: - launch_instance_details (oci.core.models.LaunchInstanceDetails) – (required) Instance details
- 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
launch_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
launch_instance_and_wait_for_work_request
(launch_instance_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
launch_instance()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - launch_instance_details (oci.core.models.LaunchInstanceDetails) – (required) Instance details
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
launch_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
terminate_instance_and_wait_for_state
(instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
terminate_instance()
and waits for theInstance
acted upon to enter the given state(s).Parameters: - instance_id (str) –
(required) The OCID of the 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
terminate_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- instance_id (str) –
-
update_compute_capacity_reservation_and_wait_for_work_request
(capacity_reservation_id, update_compute_capacity_reservation_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_compute_capacity_reservation()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
- update_compute_capacity_reservation_details (oci.core.models.UpdateComputeCapacityReservationDetails) – (required) Update compute capacity reservation details.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_compute_capacity_reservation()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_console_history_and_wait_for_state
(instance_console_history_id, update_console_history_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_console_history()
and waits for theConsoleHistory
acted upon to enter the given state(s).Parameters: - instance_console_history_id (str) – (required) The OCID of the console history.
- update_console_history_details (oci.core.models.UpdateConsoleHistoryDetails) – (required) Update instance fields
- 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_console_history()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dedicated_vm_host_and_wait_for_state
(dedicated_vm_host_id, update_dedicated_vm_host_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_dedicated_vm_host()
and waits for theDedicatedVmHost
acted upon to enter the given state(s).Parameters: - dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
- update_dedicated_vm_host_details (oci.core.models.UpdateDedicatedVmHostDetails) – (required) Update dedicated VM host details
- 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_dedicated_vm_host()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_image_and_wait_for_state
(image_id, update_image_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_image()
and waits for theImage
acted upon to enter the given state(s).Parameters: - image_id (str) –
(required) The OCID of the image.
- update_image_details (oci.core.models.UpdateImageDetails) – (required) Updates the image display name field. Avoid entering confidential information.
- 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_image()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- image_id (str) –
-
update_instance_and_wait_for_state
(instance_id, update_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_instance()
and waits for theInstance
acted upon to enter the given state(s).Parameters: - instance_id (str) –
(required) The OCID of the instance.
- update_instance_details (oci.core.models.UpdateInstanceDetails) – (required) Update instance fields
- 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_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- instance_id (str) –
-
update_instance_and_wait_for_work_request
(instance_id, update_instance_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_instance()
and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - instance_id (str) –
(required) The OCID of the instance.
- update_instance_details (oci.core.models.UpdateInstanceDetails) – (required) Update instance fields
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
status
Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- instance_id (str) –
-
update_instance_console_connection_and_wait_for_state
(instance_console_connection_id, update_instance_console_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_instance_console_connection()
and waits for theInstanceConsoleConnection
acted upon to enter the given state(s).Parameters: - instance_console_connection_id (str) – (required) The OCID of the instance console connection.
- update_instance_console_connection_details (oci.core.models.UpdateInstanceConsoleConnectionDetails) – (required) Update instanceConsoleConnection tags
- 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_instance_console_connection()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_volume_attachment_and_wait_for_state
(volume_attachment_id, update_volume_attachment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_volume_attachment()
and waits for theVolumeAttachment
acted upon to enter the given state(s).Parameters: - volume_attachment_id (str) – (required) The OCID of the volume attachment.
- update_volume_attachment_details (oci.core.models.UpdateVolumeAttachmentDetails) – (required) Update information about the specified volume attachment.
- 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_volume_attachment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-